POST
/
v4
/
interactions
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const interaction = await client.interactions.create({
    application_variant_id: 'application_variant_id',
    input: { query: 'query' },
    output: { response: 'response' },
    start_timestamp: '2019-12-27T18:11:19.117Z',
  });

  console.log(interaction.id);
}

main();
{
  "application_variant_id": "<string>",
  "thread_id": "<string>",
  "input": {
    "query": "<string>"
  },
  "output": {
    "response": "<string>",
    "context": [
      {
        "text": "<string>",
        "score": 123
      }
    ]
  },
  "start_timestamp": "2023-11-07T05:31:56Z",
  "duration_ms": 0,
  "operation_status": "SUCCESS",
  "operation_metadata": {},
  "trace_spans": [
    {
      "node_id": "<string>",
      "operation_type": "COMPLETION",
      "operation_status": "SUCCESS",
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "operation_input": {},
      "operation_output": {},
      "operation_metadata": {},
      "duration_ms": 0,
      "id": "<string>",
      "application_interaction_id": "<string>"
    }
  ],
  "guardrail_results": [
    {
      "id": "<string>",
      "guardrail_id": "<string>",
      "application_spec_id": "<string>",
      "application_variant_id": "<string>",
      "application_interaction_id": "<string>",
      "policy_id": "<string>",
      "severity": "low",
      "triggered": true,
      "score": 123,
      "description": "<string>",
      "result_metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "guardrail": {
        "id": "<string>",
        "account_id": "<string>",
        "description": "<string>",
        "check_type": "input",
        "guardrail_metadata": {},
        "is_archived": true,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "policy": {
        "id": "<string>",
        "description": "<string>",
        "category": "<string>",
        "unsafe_threshold": 123,
        "guardrail_policy_metadata": {},
        "guardrail_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "id": "<string>"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string

Body

application/json

Represents an interaction performed with an application, including input, output, and associated metadata.

Response

200
application/json
Successful Response

Model representing an interaction entity.