BeginComposeDocumentModelOptions interface

Optionen für den Modellerstellungsvorgang.

Extends

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

description

Eine Textbeschreibung des Modells (kann ein beliebiger Text sein).

onProgress

Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird sofort nach der Initialisierung des Abrufzustands aufgerufen.

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

resumeFrom

Ein serialisierter Abrufzustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt gestartet zu werden, als ob es sich um einen neuen Vorgang handelt.

serializerOptions

Optionen zum Überschreiben des Serialisierungs-/Deserialisierungsverhaltens.

tags

Zusätzliche, vom Benutzer angegebene Schlüssel-Wert-Paare, die dem Modell als persistente Metadaten zugeordnet werden sollen.

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

updateIntervalInMs

Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

Geerbt vonCreateDocumentModelOptions.abortSignal

description

Eine Textbeschreibung des Modells (kann ein beliebiger Text sein).

description?: string

Eigenschaftswert

string

Geerbt vonCreateDocumentModelOptions.description

onProgress

Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird sofort nach der Initialisierung des Abrufzustands aufgerufen.

onProgress?: (state: DocumentModelOperationState) => void

Eigenschaftswert

(state: DocumentModelOperationState) => void

Geerbt vonCreateDocumentModelOptions.onProgress

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

Geerbt vonCreateDocumentModelOptions.onResponse

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

Geerbt vonCreateDocumentModelOptions.requestOptions

resumeFrom

Ein serialisierter Abrufzustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt gestartet zu werden, als ob es sich um einen neuen Vorgang handelt.

resumeFrom?: string

Eigenschaftswert

string

Geerbt vonCreateDocumentModelOptions.resumeFrom

serializerOptions

Optionen zum Überschreiben des Serialisierungs-/Deserialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

Geerbt vonCreateDocumentModelOptions.serializerOptions

tags

Zusätzliche, vom Benutzer angegebene Schlüssel-Wert-Paare, die dem Modell als persistente Metadaten zugeordnet werden sollen.

tags?: Record<string, string>

Eigenschaftswert

Record<string, string>

Geerbt vonCreateDocumentModelOptions.tags

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

Geerbt vonCreateDocumentModelOptions.tracingOptions

updateIntervalInMs

Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.

updateIntervalInMs?: number

Eigenschaftswert

number

Geerbt vonCreateDocumentModelOptions.updateIntervalInMs