VoiceAgentSendItemOptions interface

Options shared by operations that add a conversation item and, by default, request a response.

Extends

Properties

createResponse

Whether to request a response after adding the item. Defaults to true.

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

createResponse

Whether to request a response after adding the item. Defaults to true.

createResponse?: boolean

Property Value

boolean

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

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

Inherited From VoiceAgentEventOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

Inherited From VoiceAgentEventOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From VoiceAgentEventOptions.tracingOptions