PollerOptions interface

Pakket:

@azure/ai-form-recognizer

Opties voor langlopende bewerkingen (pollers) in de Form Recognizer-clients.

Uitbreiding

OperationOptions

Eigenschappen

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.
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.
updateIntervalInMs	De hoeveelheid tijd die moet worden gewacht (in milliseconden) tussen volgende aanvragen met betrekking tot dezelfde bewerking.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
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.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

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: TState) => void

Waarde van eigenschap

(state: TState) => void

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

updateIntervalInMs

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

updateIntervalInMs?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

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

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

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 van OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions