Delen via


CreateDocumentModelOptions interface

Opties voor het maken van het model.

Extends

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

description

Een tekstuele beschrijving van het model (kan elke tekst zijn).

onProgress

Een optionele initiële voortgangshandler die wordt aangeroepen wanneer de pollerstatus wordt bijgewerkt. Deze handler wordt één keer aangeroepen direct nadat de pollerstatus is geïnitialiseerd.

onResponse

Een functie die telkens wordt aangeroepen wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

resumeFrom

Een geserialiseerde pollerstatus. Indien opgegeven, wordt de polling-bewerking hervat vanuit de opgegeven status in plaats van gestart alsof het een nieuwe bewerking is.

serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.

tags

Aanvullende, door de gebruiker opgegeven sleutel-waardeparen die als permanente metagegevens aan het model moeten worden gekoppeld.

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

updateIntervalInMs

De hoeveelheid tijd die moet worden gewacht (in milliseconden) tussen volgende aanvragen met betrekking tot dezelfde bewerking.

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

Overgenomen vanPollerOptions.abortSignal

description

Een tekstuele beschrijving van het model (kan elke tekst zijn).

description?: string

Waarde van eigenschap

string

Overgenomen vanCommonModelCreationOptions.description

onProgress

Een optionele initiële voortgangshandler die wordt aangeroepen wanneer de pollerstatus wordt bijgewerkt. Deze handler wordt één keer aangeroepen direct nadat de pollerstatus is geïnitialiseerd.

onProgress?: (state: DocumentModelOperationState) => void

Waarde van eigenschap

(state: DocumentModelOperationState) => void

Overgenomen vanPollerOptions.onProgress

onResponse

Een functie die telkens wordt aangeroepen wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

Overgenomen vanPollerOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

Overgenomen vanPollerOptions.requestOptions

resumeFrom

Een geserialiseerde pollerstatus. Indien opgegeven, wordt de polling-bewerking hervat vanuit de opgegeven status in plaats van gestart alsof het een nieuwe bewerking is.

resumeFrom?: string

Waarde van eigenschap

string

Overgenomen vanPollerOptions.resumeFrom

serializerOptions

Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

Overgenomen vanPollerOptions.serializerOptions

tags

Aanvullende, door de gebruiker opgegeven sleutel-waardeparen die als permanente metagegevens aan het model moeten worden gekoppeld.

tags?: Record<string, string>

Waarde van eigenschap

Record<string, string>

Overgenomen vanCommonModelCreationOptions.tags

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

Overgenomen vanPollerOptions.tracingOptions

updateIntervalInMs

De hoeveelheid tijd die moet worden gewacht (in milliseconden) tussen volgende aanvragen met betrekking tot dezelfde bewerking.

updateIntervalInMs?: number

Waarde van eigenschap

number

Overgenomen vanPollerOptions.updateIntervalInMs