Runs, REST: Run.Listen
Listen to events from a specific run.
If the run was created with stream = false, Listen will only respond with the final status of the run
and will not stream partial messages or intermediate events.
HTTP request
GET https://rest-assistant.api.cloud.yandex.net/assistants/v1/runs/listen
Query parameters
Request message for listing to a run events.
|
Field |
Description |
|
runId |
string Required field. ID of the run to listen to. |
|
eventsStartIdx |
string (int64) Starting index for events. If provided, listening will start from this event. |
Response
HTTP Code: 200 - OK
{
"eventType": "string",
"streamCursor": {
"currentEventIdx": "string",
"numUserEventsReceived": "string"
},
// Includes only one of the fields `error`, `partialMessage`, `completedMessage`
"error": {
"code": "string",
"message": "string"
},
"partialMessage": {
"content": [
{
// Includes only one of the fields `text`
"text": {
"content": "string"
}
// end of the list of possible fields
}
]
},
"completedMessage": {
"id": "string",
"threadId": "string",
"createdBy": "string",
"createdAt": "string",
"author": {
"id": "string",
"role": "string"
},
"labels": "object",
"content": {
"content": [
{
// Includes only one of the fields `text`
"text": {
"content": "string"
}
// end of the list of possible fields
}
]
},
"status": "string"
}
// end of the list of possible fields
}
Represents an event in the stream of a run.
|
Field |
Description |
|
eventType |
enum (EventType) The type of event.
|
|
streamCursor |
The current position in the stream. |
|
error |
Error information if the run has failed. Includes only one of the fields Event data, which can be one of several types. |
|
partialMessage |
Partially generated message. Includes only one of the fields Event data, which can be one of several types. |
|
completedMessage |
Final message generated by an assistant if a run has completed successfully. Includes only one of the fields Event data, which can be one of several types. |
StreamCursor
Represents the cursor position in a stream of events.
|
Field |
Description |
|
currentEventIdx |
string (int64) Index of the current event in the stream. |
|
numUserEventsReceived |
string (int64) The number of user events received so far. |
Error
|
Field |
Description |
|
code |
string (int64) |
|
message |
string |
MessageContent
Represents the content of a message, which can consist of multiple parts.
|
Field |
Description |
|
content[] |
A list of content parts that make up the message. |
ContentPart
ContentPart represents an individual part of the message content, which can be of various types.
|
Field |
Description |
|
text |
Text content of the message part. Includes only one of the fields Specifies the type of content that the part contains. |
Text
Text represents a textual content part of a message.
|
Field |
Description |
|
content |
string Text content of the message. |
Message
|
Field |
Description |
|
id |
string Unique identifier of the message. |
|
threadId |
string ID of the thread that this message belongs to. |
|
createdBy |
string Identifier of the subject who created this message. |
|
createdAt |
string (date-time) Timestamp representing when the message was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
author |
Author of the message, containing details about the message's creator. |
|
labels |
object (map<string, string>) Set of key-value pairs that can be used to organize and categorize the message. |
|
content |
Content of the message. |
|
status |
enum (MessageStatus) Status of the message.
|
Author
Author of the message, containing details about the message's creator.
|
Field |
Description |
|
id |
string Unique identifier of the author. This could be either the user's ID or the assistant's ID, depending on the role. |
|
role |
string Role of the author, indicating whether the message was created by a "user" or an "assistant". |