Get a turn

GET 
/v2/chats/:chat_id/turns/:turn_id

Get a specific turn from a chat, which is a message and response pair from the conversation.

Request

Path Parameters

chat_id stringrequired

Possible values: Value must match regular expression cht_.+$

The ID of the chat.

turn_id stringrequired

Possible values: Value must match regular expression trn_.+$

The ID of the turn.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

The turn.

application/json

Schema

Schema

id string

Possible values: Value must match regular expression trn_.+$

The ID of the turn.

chat_id string

Possible values: Value must match regular expression cht_.+$

The ID of the chat the turn resides in.

query string

The query made to produce this turn.

answer string

The response to the query.

enabled boolean

Indicates whether the turn is enabled and shown in future turns of the chat.

created_at date-time

Specifies when the turn was created.

Example (from schema)

{
  "id": "string",
  "chat_id": "string",
  "query": "How do you turn this widget?",
  "answer": "The widget turns counter clockwise.",
  "enabled": true,
  "created_at": "2024-10-29T01:49:06.237Z"
}

403

Permissions do not allow getting the turn.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

Corpus, chat, or turn not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...