CreateDocumentModelOptions interface

Pakiet:

@azure/ai-form-recognizer

Opcje operacji tworzenia modelu.

Extends

OperationOptions,CommonModelCreationOptions,PollerOptions<DocumentModelOperationState>

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
description	Tekstowy opis modelu (może to być dowolny tekst).
onProgress	Opcjonalna procedura obsługi postępu początkowego, która będzie wywoływana podczas aktualizacji stanu poller. 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ąpienia zachowania serializacji/de serializacji.
tags	Dodatkowe pary klucz-wartość określone przez użytkownika do skojarzenia z modelem jako metadane trwałe.
tracingOptions	Opcje używane podczas śledzenia są włączone.
updateIntervalInMs	Czas oczekiwania (w milisekundach) między kolejnymi żądaniami dotyczącymi tej samej operacji.

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

description

Tekstowy opis modelu (może to być dowolny tekst).

description?: string

Wartość właściwości

string

Dziedziczone zcommonModelCreationOptions.description

onProgress

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

onProgress?: (state: DocumentModelOperationState) => void

Wartość właściwości

(state: DocumentModelOperationState) => 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ąpienia zachowania serializacji/de serializacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

Dziedziczone zpollerOptions.serializerOptions

tags

Dodatkowe pary klucz-wartość określone przez użytkownika do skojarzenia z modelem jako metadane trwałe.

tags?: Record<string, string>

Wartość właściwości

Record<string, string>

Dziedziczone zcommonModelCreationOptions.tags

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 dotyczącymi tej samej operacji.

updateIntervalInMs?: number

Wartość właściwości

number

Dziedziczone zpollerOptions.updateIntervalInMs