BeginAnalyzeActionsOptions interface

Package:

@azure/ai-text-analytics

Options for the begin analyze actions operation.

Extends

OperationOptions

Properties

displayName	The operation's display name.
includeStatistics	If set to true, response will contain input and document level statistics.
resumeFrom	A serialized poller which can be used to resume an existing paused Long-Running-Operation.
updateIntervalInMs	Delay to wait until next poll, in milliseconds.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
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.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

displayName

The operation's display name.

displayName?: string

Property Value

string

includeStatistics

If set to true, response will contain input and document level statistics.

includeStatistics?: boolean

Property Value

boolean

resumeFrom

A serialized poller which can be used to resume an existing paused Long-Running-Operation.

resumeFrom?: string

Property Value

string

updateIntervalInMs

Delay to wait until next poll, in milliseconds.

updateIntervalInMs?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

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 OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions