RealtimeServerEventResponseDone interface

Package:

@azure/ai-projects

Returned when a Response is done streaming. Always emitted, no matter the final state. The Response object included in the response.done event will include all output Items in the Response but will omit the raw audio data. Clients should check the status field of the Response to determine if it was successful (completed) or if there was another outcome: cancelled, failed, or incomplete. A response will contain all output items that were generated during the response, excluding any audio content.

Extends

RealtimeServerEvent

Properties

event_id	The unique ID of the server event.
response	The response's final status and generated output items, excluding raw audio data.
type	The event type, must be response.done.

Property Details

event_id

The unique ID of the server event.

event_id: string

Property Value

string

response

The response's final status and generated output items, excluding raw audio data.

response: VoiceAgentRealtimeResponse

Property Value

VoiceAgentRealtimeResponse

type

The event type, must be response.done.

type: "response.done"

Property Value

"response.done"