ClientEventResponseCancel interface

Package:

@azure/ai-voicelive

Send this event to cancel an in-progress response. The server will respond with a response.cancelled event or an error if there is no response to cancel.

Extends

ClientEvent

Properties

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

Inherited Properties

eventId

Property Details

responseId

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

responseId?: string

Property Value

string

type

The event type, must be response.cancel.

type: "response.cancel"

Property Value

"response.cancel"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ClientEvent.eventId