CreateDocumentModelOptions interface

Pakket:

@azure/ai-form-recognizer

Opties voor het maken van het model.

Uitbreiding

OperationOptions,CommonModelCreationOptions,PollerOptions<DocumentModelOperationState>

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 eenmaal aangeroepen nadat de pollerstatus is geïnitialiseerd.
onResponse	Een functie die telkens wordt aangeroepen wanneer 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 pollingbewerking hervat vanuit de opgegeven status in plaats van te worden gestart alsof het een nieuwe bewerking was.
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

AbortSignalLike

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 eenmaal aangeroepen 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 een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen vanPollerOptions.onResponse-

requestOptions

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

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen vanPollerOptions.requestOptions-

resumeFrom

Een geserialiseerde pollerstatus. Indien opgegeven, wordt de pollingbewerking hervat vanuit de opgegeven status in plaats van te worden gestart alsof het een nieuwe bewerking was.

resumeFrom?: string

Waarde van eigenschap

string

overgenomen vanPollerOptions.resumeFrom

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

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

OperationTracingOptions

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