RealtimeClientEventResponseCancel interface

Package:

@azure/ai-projects

Send this event to cancel an in-progress response. The server will respond with a response.done event with a status of response.status=cancelled. If there is no response to cancel, the server will respond with an error. It's safe to call response.cancel even if no response is in progress, an error will be returned the session will remain unaffected.

Extends

RealtimeClientEvent

Properties

event_id	Optional client-generated ID used to identify this event.
response_id	A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.
type	The event type, must be response.cancel.

Property Details

event_id

Optional client-generated ID used to identify this event.

event_id?: string

Property Value

string

response_id

A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.

response_id?: string

Property Value

string

type

The event type, must be response.cancel.

type: "response.cancel"

Property Value

"response.cancel"