AnalyzeDocumentOptions interface

Pakiet:

@azure/ai-form-recognizer

Opcje operacji analizy dokumentu.

Rozszerzenie

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Właściwości

features	Lista funkcji, które mają być włączone w modelu. Włączenie funkcji może wiązać się z dodatkowymi kosztami, dlatego zapoznaj się z dokumentacją usługi, aby zrozumieć charakter funkcji i wszelkie dodatkowe koszty związane z ich używaniem. Aby uzyskać więcej informacji na temat funkcji dostępnych w rozpoznawaniu formularzy, zobacz dokumentację usługi: https://aka.ms/azsdk/formrecognizer/features
locale	Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów. Wartość może określać tylko dwuliterowy kod języka lub tag języka BCP-47 wskazujący zarówno język, jak i region. Przykłady: "en-US" (angielski USA) "fr" (francuski — brak regionu)
pages	Lista zakresów stron (indeksowanych 1) w dokumencie wejściowym do analizy rozdzielona przecinkami Przykłady: "1", "3-5", "1,3-5"

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
onProgress	Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller.
onResponse	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
resumeFrom	Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja.
serializerOptions	Opcje zastępowania zachowania serializacji/deseralizacji.
tracingOptions	Opcje używane podczas śledzenia są włączone.
updateIntervalInMs	Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji.

Szczegóły właściwości

features

Lista funkcji, które mają być włączone w modelu. Włączenie funkcji może wiązać się z dodatkowymi kosztami, dlatego zapoznaj się z dokumentacją usługi, aby zrozumieć charakter funkcji i wszelkie dodatkowe koszty związane z ich używaniem.

Aby uzyskać więcej informacji na temat funkcji dostępnych w rozpoznawaniu formularzy, zobacz dokumentację usługi: https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Wartość właściwości

FormRecognizerFeature[]

locale

Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów.

Wartość może określać tylko dwuliterowy kod języka lub tag języka BCP-47 wskazujący zarówno język, jak i region.

Przykłady:

• "en-US" (angielski USA)
• "fr" (francuski — brak regionu)

locale?: string

Wartość właściwości

string

pages

Lista zakresów stron (indeksowanych 1) w dokumencie wejściowym do analizy rozdzielona przecinkami

Przykłady: "1", "3-5", "1,3-5"

pages?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

dziedziczone zPollerOptions.abortSignal

onProgress

Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana, gdy stan poller zostanie zaktualizowany. Ta procedura obsługi zostanie wywołana natychmiast po zainicjowaniu stanu poller.

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

Wartość właściwości

(state: DocumentAnalysisPollOperationState<Result>) => void

dziedziczone zPollerOptions.onProgress

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

dziedziczone zPollerOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

dziedziczone zPollerOptions.requestOptions

resumeFrom

Serializowany stan poller. Jeśli zostanie podana, operacja sondowania zostanie wznowiona z danego stanu, a nie uruchomiona tak, jakby była to nowa operacja.

resumeFrom?: string

Wartość właściwości

string

dziedziczone zPollerOptions.resumeFrom

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

dziedziczone zPollerOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zPollerOptions.tracingOptions

updateIntervalInMs

Czas oczekiwania (w milisekundach) między kolejnymi żądaniami odnoszącymi się do tej samej operacji.

updateIntervalInMs?: number

Wartość właściwości

number

dziedziczone zPollerOptions.updateIntervalInMs