AnalyzeDocumentOptions interface

Pakket:

@azure/ai-form-recognizer

Opties voor de documentanalysebewerking.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Eigenschappen

features	Een lijst met functies die in het model moeten worden ingeschakeld. Het inschakelen van functies kan extra kosten met zich meebrengen, dus raadpleeg de servicedocumentatie om inzicht te hebben in de aard van de functies en eventuele extra kosten voor het gebruik ervan. Zie de servicedocumentatie voor meer informatie over de functies die beschikbaar zijn in Form Recognizer:https://aka.ms/azsdk/formrecognizer/features
locale	Landinstellingshint voor tekstherkenning en documentanalyse. De waarde mag alleen de tweeletterige taalcode of een BCP-47-taalcode opgeven die zowel de taal als de regio aangeeft. Voorbeelden: "en-US" (Amerikaans Engels) "fr" (Frans - geen regio)
pages	Een lijst met paginabereiken (1 geïndexeerd) in het invoerdocument dat moet worden geanalyseerd, gescheiden door komma's Voorbeelden: "1", "3-5", "1,3-5"

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onProgress	Een optionele handler voor initiële voortgang 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 moet worden aangeroepen telkens 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 pollingbewerking hervat vanuit de opgegeven status in plaats van gestart alsof het een nieuwe bewerking is.
serializerOptions	Opties voor het overschrijven van serialisatie-/deserialisatiegedrag.
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.

Eigenschapdetails

features

Een lijst met functies die in het model moeten worden ingeschakeld. Het inschakelen van functies kan extra kosten met zich meebrengen, dus raadpleeg de servicedocumentatie om inzicht te hebben in de aard van de functies en eventuele extra kosten voor het gebruik ervan.

Zie de servicedocumentatie voor meer informatie over de functies die beschikbaar zijn in Form Recognizer:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Waarde van eigenschap

FormRecognizerFeature[]

locale

Landinstellingshint voor tekstherkenning en documentanalyse.

De waarde mag alleen de tweeletterige taalcode of een BCP-47-taalcode opgeven die zowel de taal als de regio aangeeft.

Voorbeelden:

• "en-US" (Amerikaans Engels)
• "fr" (Frans - geen regio)

locale?: string

Waarde van eigenschap

string

pages

Een lijst met paginabereiken (1 geïndexeerd) in het invoerdocument dat moet worden geanalyseerd, gescheiden door komma's

Voorbeelden: "1", "3-5", "1,3-5"

pages?: string

Waarde van eigenschap

string

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

onProgress

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

onProgress?: (state: DocumentAnalysisPollOperationState<Result>) => void

Waarde van eigenschap

(state: DocumentAnalysisPollOperationState<Result>) => void

Overgenomen vanPollerOptions.onProgress

onResponse

Een functie die moet worden aangeroepen telkens 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

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 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

SerializerOptions

Overgenomen vanPollerOptions.serializerOptions

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