Scale API | Interactions › Create Application Interaction

Interactions

interactions

Methods

Create Application Interaction -> { id, application_variant_id, input, 8 more... }

post/v4/interactions/

Create Application Interaction

Security

API Key Header

Example: x-api-key: My API Key

Response fields

id: string

Unique identifier for the interaction.

application_variant_id: string

Identifier for the application variant that performed this interaction.

input: { query }

The input data for the interaction.

output: { response, context }

The output data from the interaction.

start_timestamp: string

Timestamp marking the start of the interaction.

duration_ms: number

Optional

Duration of the interaction in milliseconds.

guardrail_results: Array<{ id, application_interaction_id, application_spec_id, 11 more... }>

Optional

Results of the guardrails executed on the input

operation_metadata: unknown

Optional

Optional metadata related to the operation, including custom or predefined keys.

operation_status: "SUCCESS" | "ERROR"

Optional

The outcome status of the interaction.

thread_id: string

Optional

Optional UUID identifying the conversation thread associated with the interaction.The interaction will be associated with the thread if the id represents an existing thread.If the thread with the specified id is not found, a new thread will be created.

trace_spans: Array<{ id, application_interaction_id, node_id, 7 more... }>

Optional

List of trace span entities associated with the interaction.

Request example

curl https://api.egp.scale.com/v4/interactions/ \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
      "application_variant_id": "application_variant_id",
      "input": {
        "query": "query"
      },
      "output": {
        "response": "response"
      },
      "start_timestamp": "2019-12-27T18:11:19.117Z"
    }'

200Example

{
  "id": "id",
  "application_variant_id": "application_variant_id",
  "input": {
    "query": "query"
  },
  "output": {
    "response": "response",
    "context": [
      {
        "text": "text",
        "score": 0
      }
    ]
  },
  "start_timestamp": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "guardrail_results": [
    {
      "id": "id",
      "application_interaction_id": "application_interaction_id",
      "application_spec_id": "application_spec_id",
      "application_variant_id": "application_variant_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "guardrail": {
        "id": "id",
        "account_id": "account_id",
        "check_type": "input",
        "created_at": "2019-12-27T18:11:19.117Z",
        "description": "description",
        "guardrail_metadata": {},
        "is_archived": true
      },
      "guardrail_id": "guardrail_id",
      "policy": {
        "id": "id",
        "category": "category",
        "created_at": "2019-12-27T18:11:19.117Z",
        "guardrail_id": "guardrail_id",
        "unsafe_threshold": 0,
        "description": "description",
        "guardrail_policy_metadata": {}
      },
      "policy_id": "policy_id",
      "score": 0,
      "severity": "low",
      "triggered": true,
      "description": "description",
      "result_metadata": {}
    }
  ],
  "operation_metadata": {},
  "operation_status": "SUCCESS",
  "thread_id": "thread_id",
  "trace_spans": [
    {
      "id": "id",
      "application_interaction_id": "application_interaction_id",
      "node_id": "node_id",
      "operation_type": "COMPLETION",
      "start_timestamp": "2019-12-27T18:11:19.117Z",
      "duration_ms": 0,
      "operation_input": {},
      "operation_metadata": {},
      "operation_output": {},
      "operation_status": "SUCCESS"
    }
  ]
}