REST: response.content_part.done
HTTP request
POST https://ai.api.cloud.yandex.net/v1/realtime/server-events/response.content_part.done
Body parameters
Request schema: application/json
{
"type": "string",
"event_id": "string",
"response_id": "string",
"output_index": "integer",
"item_id": "string",
"content_index": "integer",
"part": "unknown"
}
Returned when a content part is done streaming. Also emitted when a response is interrupted, incomplete, or cancelled.
|
Field |
Description |
|
type |
enum Required field. The event type, must be
|
|
event_id |
string Required field. The unique ID of the server event. |
|
response_id |
string Required field. The ID of the response. |
|
output_index |
integer Required field. The index of the output item in the response. |
|
item_id |
string Required field. The ID of the item to which the content part belongs. |
|
content_index |
integer Required field. The index of the content part in the item's content array. |
|
part |
One of RealtimeInputTextPart | RealtimeOutputTextPart | RealtimeInputAudioPart | RealtimeOutputAudioPart |
RealtimeInputTextPart
|
Field |
Description |
|
type |
enum Required field.
|
|
text |
string Required field. Input text. |
RealtimeOutputTextPart
|
Field |
Description |
|
type |
enum Required field.
|
|
text |
string | null Final text (present in done events). |
RealtimeInputAudioPart
|
Field |
Description |
|
type |
enum Required field.
|
|
audio |
string | null Base64-encoded audio (only present when included). |
|
transcript |
string | null Input audio transcript, if available. |
RealtimeOutputAudioPart
|
Field |
Description |
|
type |
enum Required field.
|
|
audio |
string | null Base64-encoded audio (omitted in response.done). |
|
transcript |
string | null Output audio transcript, if enabled. |
Response
HTTP Code: 200
OK