RealtimeServerEventResponseOutputItemAdded interface

Package:

@azure/ai-projects

Returned when a new Item is created during Response generation.

Extends

RealtimeServerEvent

Properties

event_id	The unique ID of the server event.
item	The output item added to the response as generation begins for that item.
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.added.

Property Details

event_id

The unique ID of the server event.

event_id: string

Property Value

string

item

The output item added to the response as generation begins for that item.

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.added.

type: "response.output_item.added"

Property Value

"response.output_item.added"