RealtimeResponseStatusDetails interface

Package:

@azure/ai-projects

model interface RealtimeResponseStatusDetails

Properties

error	Details of the error that caused the response to fail.
reason	The reason the response was cancelled or left incomplete, such as a detected turn, client cancellation, token limit, or content filter.
type	The response outcome to which these status details apply.

Property Details

error

Details of the error that caused the response to fail.

error?: RealtimeResponseStatusDetailsError

Property Value

RealtimeResponseStatusDetailsError

reason

The reason the response was cancelled or left incomplete, such as a detected turn, client cancellation, token limit, or content filter.

reason?: "turn_detected" | "client_cancelled" | "max_output_tokens" | "content_filter"

Property Value

"turn_detected" | "client_cancelled" | "max_output_tokens" | "content_filter"

type

The response outcome to which these status details apply.

type?: "failed" | "cancelled" | "completed" | "incomplete"

Property Value

"failed" | "cancelled" | "completed" | "incomplete"