BeginBuildDocumentModelOptions interface
Warning
This API is now deprecated.
Options for the model build operation.
- Extends
Inherited Properties
abort |
The signal which can be used to abort requests. |
description | A textual description of the model (can be any text). |
on |
An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized. |
on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
request |
Options used when creating and sending HTTP requests for this operation. |
resume |
A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation. |
serializer |
Options to override serialization/de-serialization behavior. |
tags | Additional, user-specified key-value pairs to associate with the model as persistent metadata. |
tracing |
Options used when tracing is enabled. |
update |
The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation. |
Inherited Property Details
abortSignal
Warning
This API is now deprecated.
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From CreateDocumentModelOptions.abortSignal
description
Warning
This API is now deprecated.
A textual description of the model (can be any text).
description?: string
Property Value
string
Inherited From CreateDocumentModelOptions.description
onProgress
Warning
This API is now deprecated.
An optional initial progress handler that will be called when the poller state updates. This handler will be called once immediately after the poller state is initialized.
onProgress?: (state: DocumentModelOperationState) => void
Property Value
(state: DocumentModelOperationState) => void
Inherited From CreateDocumentModelOptions.onProgress
onResponse
Warning
This API is now deprecated.
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 CreateDocumentModelOptions.onResponse
requestOptions
Warning
This API is now deprecated.
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From CreateDocumentModelOptions.requestOptions
resumeFrom
Warning
This API is now deprecated.
A serialized poller state. If provided, the polling operation will be resumed from the given state instead of started as if it were a new operation.
resumeFrom?: string
Property Value
string
Inherited From CreateDocumentModelOptions.resumeFrom
serializerOptions
Warning
This API is now deprecated.
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From CreateDocumentModelOptions.serializerOptions
tags
Warning
This API is now deprecated.
Additional, user-specified key-value pairs to associate with the model as persistent metadata.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited From CreateDocumentModelOptions.tags
tracingOptions
Warning
This API is now deprecated.
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From CreateDocumentModelOptions.tracingOptions
updateIntervalInMs
Warning
This API is now deprecated.
The amount of time to wait (in milliseconds) between subsequent requests relating to the same operation.
updateIntervalInMs?: number
Property Value
number
Inherited From CreateDocumentModelOptions.updateIntervalInMs