AnalyzeDocumentOptions interface

Paket:

@azure/ai-form-recognizer

Optionen für den Dokumentanalysevorgang.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Eigenschaften

features	Eine Liste der Features, die im Modell aktiviert werden sollen. Das Aktivieren von Features kann zusätzliche Kosten verursachen. Lesen Sie daher unbedingt die Dienstdokumentation, um die Art der Features und die damit verbundenen zusätzlichen Kosten zu verstehen. Weitere Informationen zu den in der Formularerkennung verfügbaren Features finden Sie in der Dienstdokumentation: https://aka.ms/azsdk/formrecognizer/features
locale	Gebietsschemahinweise für die Texterkennung und Dokumentanalyse. Der Wert kann nur den Zwei-Buchstaben-Sprachcode oder ein BCP-47-Sprachtag angeben, der sowohl Sprache als auch Region angibt. Beispiele: "en-US" (US-Englisch) "fr" (Französisch - keine Region)
pages	Eine Liste der Seitenbereiche (1-indiziert) innerhalb des zu analysierenden Eingabedokuments, getrennt durch Kommas Beispiele: "1", "3-5", "1,3-5"

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onProgress	Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
resumeFrom	Ein serialisierter Umfragezustand. Wenn angegeben, wird der Abrufvorgang aus dem angegebenen Zustand fortgesetzt, anstatt zu starten, als ob es sich um einen neuen Vorgang handelt.
serializerOptions	Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
updateIntervalInMs	Die Wartezeit (in Millisekunden) zwischen nachfolgenden Anforderungen im Zusammenhang mit demselben Vorgang.

Details zur Eigenschaft

features

Eine Liste der Features, die im Modell aktiviert werden sollen. Das Aktivieren von Features kann zusätzliche Kosten verursachen. Lesen Sie daher unbedingt die Dienstdokumentation, um die Art der Features und die damit verbundenen zusätzlichen Kosten zu verstehen.

Weitere Informationen zu den in der Formularerkennung verfügbaren Features finden Sie in der Dienstdokumentation: https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Eigenschaftswert

FormRecognizerFeature[]

locale

Gebietsschemahinweise für die Texterkennung und Dokumentanalyse.

Der Wert kann nur den Zwei-Buchstaben-Sprachcode oder ein BCP-47-Sprachtag angeben, der sowohl Sprache als auch Region angibt.

Beispiele:

• "en-US" (US-Englisch)
• "fr" (Französisch - keine Region)

locale?: string

Eigenschaftswert

string

pages

Eine Liste der Seitenbereiche (1-indiziert) innerhalb des zu analysierenden Eingabedokuments, getrennt durch Kommas

Beispiele: "1", "3-5", "1,3-5"

pages?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

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

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

geerbt vonPollerOptions.abortSignal

onProgress

Ein optionaler anfänglicher Statushandler, der aufgerufen wird, wenn der Abrufstatus aktualisiert wird. Dieser Handler wird einmal aufgerufen, nachdem der Abfragezustand initialisiert wurde.

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

Eigenschaftswert

(state: DocumentAnalysisPollOperationState<Result>) => void

geerbt vonPollerOptions.onProgress

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

geerbt vonPollerOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

geerbt vonPollerOptions.requestOptions

resumeFrom

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

resumeFrom?: string

Eigenschaftswert

string

geerbt vonPollerOptions.resumeFrom

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

geerbt vonPollerOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

geerbt vonPollerOptions.tracingOptions

updateIntervalInMs

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

updateIntervalInMs?: number

Eigenschaftswert

number

geerbt vonPollerOptions.updateIntervalInMs