VoiceAgentCancelResponseOptions interface

Package:

@azure/ai-projects

Options for cancelling a response.

Extends

VoiceAgentEventOptions

Properties

responseId

Specific response to cancel. The active default-conversation response is used when omitted.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
eventId	Client-generated event identifier.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Property Details

responseId

Specific response to cancel. The active default-conversation response is used when omitted.

responseId?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From VoiceAgentEventOptions.abortSignal

eventId

Client-generated event identifier.

eventId?: string

Property Value

string

Inherited From VoiceAgentEventOptions.eventId

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From VoiceAgentEventOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From VoiceAgentEventOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From VoiceAgentEventOptions.tracingOptions