RealtimeServerEventResponseOutputItemDone interface

Package:

@azure/ai-projects

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Extends

RealtimeServerEvent

Properties

event_id	The unique ID of the server event.
item	The output item after streaming ends, including when its response is interrupted or incomplete.
output_index	The index of the output item in the Response.
response_id	The ID of the Response to which the item belongs.
type	The event type, must be response.output_item.done.

Property Details

event_id

The unique ID of the server event.

event_id: string

Property Value

string

item

The output item after streaming ends, including when its response is interrupted or incomplete.

item: RealtimeConversationItemUnion

Property Value

RealtimeConversationItemUnion

output_index

The index of the output item in the Response.

output_index: number

Property Value

number

response_id

The ID of the Response to which the item belongs.

response_id: string

Property Value

string

type

The event type, must be response.output_item.done.

type: "response.output_item.done"

Property Value

"response.output_item.done"