Get Thread Messages

JavaScript

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const chatThreadHistory = await client.chatThreads.messages.retrieve('thread_id');

console.log(chatThreadHistory.application_spec_id);

{
  "thread": {
    "id": "<string>",
    "title": "<string>",
    "application_variant_id": "<string>",
    "account_id": "<string>",
    "created_by_user_id": "<string>",
    "created_by_identity_type": "user",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "thread_metadata": {},
    "archived_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "entry": {
        "id": "<string>",
        "input": {},
        "output": {},
        "aggregated": true,
        "application_spec_id": "<string>",
        "application_variant_id": "<string>",
        "start_timestamp": "2023-11-07T05:31:56Z",
        "duration_ms": 123,
        "operation_status": "SUCCESS",
        "created_at": "2023-11-07T05:31:56Z",
        "operation_metadata": {},
        "chat_thread_id": "<string>",
        "interaction_source": "EXTERNAL_AI"
      },
      "spans": [
        {
          "id": "<string>",
          "node_id": "<string>",
          "operation_type": "TEXT_INPUT",
          "operation_status": "SUCCESS",
          "start_timestamp": "2023-11-07T05:31:56Z",
          "duration_ms": 123,
          "application_interaction_id": "<string>",
          "application_variant_id": "<string>",
          "operation_input": {},
          "operation_output": {},
          "operation_expected": {},
          "operation_metadata": {},
          "end_timestamp": "2023-11-07T05:31:56Z",
          "trace_id": "<string>",
          "parent_id": "<string>",
          "group_id": "<string>",
          "account_id": "<string>",
          "created_by_user_id": "<string>",
          "created_by_identity_type": "user"
        }
      ],
      "feedback": {
        "id": "<string>",
        "chat_thread_id": "<string>",
        "application_interaction_id": "<string>",
        "sentiment": "positive",
        "description": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "application_spec_id": "<string>"
}

GET

threads

{thread_id}

messages

JavaScript

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const chatThreadHistory = await client.chatThreads.messages.retrieve('thread_id');

console.log(chatThreadHistory.application_spec_id);

{
  "thread": {
    "id": "<string>",
    "title": "<string>",
    "application_variant_id": "<string>",
    "account_id": "<string>",
    "created_by_user_id": "<string>",
    "created_by_identity_type": "user",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "thread_metadata": {},
    "archived_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "entry": {
        "id": "<string>",
        "input": {},
        "output": {},
        "aggregated": true,
        "application_spec_id": "<string>",
        "application_variant_id": "<string>",
        "start_timestamp": "2023-11-07T05:31:56Z",
        "duration_ms": 123,
        "operation_status": "SUCCESS",
        "created_at": "2023-11-07T05:31:56Z",
        "operation_metadata": {},
        "chat_thread_id": "<string>",
        "interaction_source": "EXTERNAL_AI"
      },
      "spans": [
        {
          "id": "<string>",
          "node_id": "<string>",
          "operation_type": "TEXT_INPUT",
          "operation_status": "SUCCESS",
          "start_timestamp": "2023-11-07T05:31:56Z",
          "duration_ms": 123,
          "application_interaction_id": "<string>",
          "application_variant_id": "<string>",
          "operation_input": {},
          "operation_output": {},
          "operation_expected": {},
          "operation_metadata": {},
          "end_timestamp": "2023-11-07T05:31:56Z",
          "trace_id": "<string>",
          "parent_id": "<string>",
          "group_id": "<string>",
          "account_id": "<string>",
          "created_by_user_id": "<string>",
          "created_by_identity_type": "user"
        }
      ],
      "feedback": {
        "id": "<string>",
        "chat_thread_id": "<string>",
        "application_interaction_id": "<string>",
        "sentiment": "positive",
        "description": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "application_spec_id": "<string>"
}

Authorizations

x-api-key

string

header

required

Headers

x-selected-account-id

string

Path Parameters

thread_id

string

required

Query Parameters

fetch_by_account

boolean

default:false

Fetch the thread by account instead of user

fetch_spans

boolean

default:false

Fetch spans for each message

Response

Successful Response

thread

ChatThreadResponse · object

required

Show child attributes

thread.id

string

required

thread.title

string

required

thread.application_variant_id

string

required

thread.account_id

string

required

The ID of the account that owns the given entity.

thread.created_by_user_id

string

required

The user who originally created the entity.

thread.created_by_identity_type

enum<string>

required

The type of identity that created the entity.

Available options:

user,

service_account

thread.created_at

string<date-time>

required

The date and time when the entity was created in ISO format.

thread.updated_at

string<date-time>

required

The date and time when the entity was last updated in ISO format.

thread.thread_metadata

Thread Metadata · object

thread.archived_at

string<date-time>

The date and time when the entity was archived in ISO format.

messages

ApplicationInteractionWithFeedback · object[]

required

Show child attributes

messages.entry

ApplicationInteractionResponse · object

required

Show child attributes

messages.entry.id

string

required

messages.entry.input

Input · object

required

messages.entry.output

Output · object

required

messages.entry.aggregated

boolean

required

Boolean of whether this interaction has been uploaded to s3 bucket yet, default is false

messages.entry.application_spec_id

string

required

messages.entry.application_variant_id

string

required

messages.entry.start_timestamp

string<date-time>

required

messages.entry.duration_ms

integer

required

How much time the step took in milliseconds(ms)

messages.entry.operation_status

enum<string>

required

The outcome of the operation

Available options:

SUCCESS,

ERROR,

CANCELED

messages.entry.created_at

string<date-time>

required

The date and time when the entity was created in ISO format.

messages.entry.operation_metadata

Operation Metadata · object

The JSON representation of the metadata insights emitted through the execution. This can differ based on different types of operations

messages.entry.chat_thread_id

string

messages.entry.interaction_source

enum<string>

Available options:

EXTERNAL_AI,

EVALUATION,

SGP_CHAT,

AGENTS_SERVICE

messages.spans

ApplicationTraceSpanResponse · object[]

Show child attributes

messages.spans.id

string

required

Identifies the application step

messages.spans.node_id

string

required

The id of the node in the application_variant config that emitted this insight

messages.spans.operation_type

enum<string>

required

Type of the operation, e.g. RERANKING

Available options:

TEXT_INPUT,

TEXT_OUTPUT,

COMPLETION_INPUT,

COMPLETION,

KB_RETRIEVAL,

KB_INPUT,

RERANKING,

EXTERNAL_ENDPOINT,

PROMPT_ENGINEERING,

DOCUMENT_INPUT,

MAP_REDUCE,

DOCUMENT_SEARCH,

DOCUMENT_PROMPT,

CUSTOM,

CODE_EXECUTION,

DATA_MANIPULATION,

EVALUATION,

FILE_RETRIEVAL,

KB_ADD_CHUNK,

KB_MANAGEMENT,

GUARDRAIL,

TRACER,

AGENT_TRACER,

AGENT_WORKFLOW,

STANDALONE

messages.spans.operation_status

enum<string>

required

The outcome of the operation

Available options:

SUCCESS,

ERROR,

CANCELED

messages.spans.start_timestamp

string<date-time>

required

The start time of the step

messages.spans.duration_ms

integer

required

How much time the step took in milliseconds(ms)

messages.spans.application_interaction_id

string

The interaction ID this span belongs to

messages.spans.application_variant_id

string

The id of the application variant this span belongs to

messages.spans.operation_input

Operation Input · object

The JSON representation of the input that this step received

messages.spans.operation_output

Operation Output · object

The JSON representation of the output that this step emitted

messages.spans.operation_expected

Operation Expected · object

The JSON representation of the expected output for this step

messages.spans.operation_metadata

Operation Metadata · object

The JSON representation of the metadata insights emitted through the execution. This can differ based on different types of operations

messages.spans.end_timestamp

string<date-time>

The end time of the step, nullable, since it can be set to done at a later point in time.

messages.spans.trace_id

string

The root-level ID where this span belongs to

messages.spans.parent_id

string

Who is the parent span of this current span, null if span is root parent.

messages.spans.group_id

string

The ID of the group this span belongs to

messages.spans.account_id

string

The ID of the account that owns the given entity.

messages.spans.created_by_user_id

string

The user who originally created the entity.

messages.spans.created_by_identity_type

enum<string>

The type of identity that created the entity.

Available options:

user,

service_account

messages.feedback

ChatThreadFeedbackResponse · object

Show child attributes

messages.feedback.id

string

required

messages.feedback.chat_thread_id

string

required

messages.feedback.application_interaction_id

string

required

messages.feedback.sentiment

enum<string>

required

Available options:

positive,

negative

messages.feedback.description

string

required

messages.feedback.created_at

string<date-time>

required

The date and time when the entity was created in ISO format.

application_spec_id

string

required

The ID of the application spec that the thread belongs to.

Publish Application Variant Delete Chat Thread

⌘I

Knowledge Bases

Chunks

Agents

Completions

Chat Completions

Models

Users

Accounts

Organizations

Question Sets

Evaluations

Evaluation Configs

Evaluation Datasets

Studio Projects

Application Specs

Questions

Knowledge Base Data Sources

Model Templates V3 (Beta)

Model server

API Reference

Fine Tuning Jobs V3 (Beta)

Training Datasets V3 (Beta)

package deployments

Beta

Applications

ChatThreads

Interactions

MonitoringDashboard

Chat Themes

account groups

Get Thread Messages

Authorizations

Headers

Path Parameters

Query Parameters

Response