ServerEventResponseOutputItemDone interface

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

Extends

Properties

item
outputIndex

The index of the output item in the Response.

responseId

The ID of the Response to which the item belongs.

type

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

Inherited Properties

eventId

Property Details

item

item?: ResponseItemUnion

Property Value

outputIndex

The index of the output item in the Response.

outputIndex: number

Property Value

number

responseId

The ID of the Response to which the item belongs.

responseId: 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"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ServerEvent.eventId