Update a turn
PATCH/v2/chats/:chat_id/turns/:turn_id
Update a turn; used to disable or enable a chat.
Request
Path Parameters
Possible values: Value must match regular expression cht_.+$
The ID of the chat.
Possible values: Value must match regular expression trn_.+$
The ID of the turn.
- application/json
Body
Indicates whether to disable a turn. It will disable this turn and all subsequent turns. Enabling a turn is not implemented.
Responses
- 200
- 403
- 404
Successfully modified the turn.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: Value must match regular expression trn_.+$
The ID of the turn.
Possible values: Value must match regular expression cht_.+$
The ID of the chat the turn resides in.
The query made to produce this turn.
The response to the query.
Indicates whether the turn is enabled and shown in futures turns of the chat.
Specifies when the turn was created.
{
"id": "string",
"chat_id": "string",
"query": "How do a turn this widget?",
"answer": "The widget turns counter clockwise.",
"enabled": true,
"created_at": "2024-09-05T02:15:29.487Z"
}
Permissions do not allow updating the turn.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong .
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
Corpus, chat, or turn not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID cannot found.
ID of the request that can be used to help Vectara support debug what went wrong.
{
"id": "string",
"messages": [
"string"
],
"request_id": "string"
}