Dela via


BeginComposeDocumentModelOptions interface

Alternativ för modellens sammansättningsåtgärd.

Extends

Ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

description

En textbeskrivning av modellen (kan vara valfri text).

onProgress

En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats.

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

resumeFrom

Ett serialiserat pollertillstånd. Om den tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd.

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

tags

Ytterligare användardefinierade nyckel/värde-par som ska associeras med modellen som beständiga metadata.

tracingOptions

Alternativ som används när spårning är aktiverat.

updateIntervalInMs

Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd.

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

Ärvd frånCreateDocumentModelOptions.abortSignal

description

En textbeskrivning av modellen (kan vara valfri text).

description?: string

Egenskapsvärde

string

Ärvd frånCreateDocumentModelOptions.description

onProgress

En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats.

onProgress?: (state: DocumentModelOperationState) => void

Egenskapsvärde

(state: DocumentModelOperationState) => void

Ärvd frånCreateDocumentModelOptions.onProgress

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

Ärvd frånCreateDocumentModelOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

Ärvd frånCreateDocumentModelOptions.requestOptions

resumeFrom

Ett serialiserat pollertillstånd. Om den tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd.

resumeFrom?: string

Egenskapsvärde

string

Ärvd frånCreateDocumentModelOptions.resumeFrom

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

Ärvd frånCreateDocumentModelOptions.serializerOptions

tags

Ytterligare användardefinierade nyckel/värde-par som ska associeras med modellen som beständiga metadata.

tags?: Record<string, string>

Egenskapsvärde

Record<string, string>

Ärvd frånCreateDocumentModelOptions.tags

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

Ärvd frånCreateDocumentModelOptions.tracingOptions

updateIntervalInMs

Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd.

updateIntervalInMs?: number

Egenskapsvärde

number

Ärvd frånCreateDocumentModelOptions.updateIntervalInMs