AnalyzeDocumentOptions interface

  • Referens
Paket:
@azure/ai-form-recognizer

Alternativ för dokumentanalysåtgärden.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Egenskaper

features

En lista över funktioner som ska aktiveras i modellen. Aktivering av funktioner kan medföra ytterligare kostnader, så se till att läsa tjänstdokumentationen för att förstå egenskapernas natur och eventuella extra kostnader som är associerade med att använda dem.

Mer information om de funktioner som är tillgängliga i Formigenkänning finns i tjänstdokumentationen:https://aka.ms/azsdk/formrecognizer/features
locale

Språktips för textigenkänning och dokumentanalys.

Värdet får endast ange språkkoden med två bokstäver eller en BCP-47-språktagg som anger både språk och region.

Exempel:

  • "en-US" (amerikansk engelska)
  • "fr" (franska - ingen region)
pages

En lista över sidintervall (1 indexerade) i indatadokumentet som ska analyseras, avgränsade med kommatecken

Exempel: "1", "3-5", "1,3-5"

Ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.
onProgress

En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats.
onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
resumeFrom

Ett serialiserat pollertillstånd. Om den tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd.
serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
tracingOptions

Alternativ som används när spårning är aktiverat.
updateIntervalInMs

Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd.

Egenskapsinformation

features

En lista över funktioner som ska aktiveras i modellen. Aktivering av funktioner kan medföra ytterligare kostnader, så se till att läsa tjänstdokumentationen för att förstå egenskapernas natur och eventuella extra kostnader som är associerade med att använda dem.

Mer information om de funktioner som är tillgängliga i Formigenkänning finns i tjänstdokumentationen:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Egenskapsvärde

FormRecognizerFeature[]

locale

Språktips för textigenkänning och dokumentanalys.

Värdet får endast ange språkkoden med två bokstäver eller en BCP-47-språktagg som anger både språk och region.

Exempel:

  • "en-US" (amerikansk engelska)
  • "fr" (franska - ingen region)
locale?: string

Egenskapsvärde

string

pages

En lista över sidintervall (1 indexerade) i indatadokumentet som ska analyseras, avgränsade med kommatecken

Exempel: "1", "3-5", "1,3-5"

pages?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

Ärvd frånPollerOptions.abortSignal

onProgress

En valfri inledande förloppshanterare som anropas när pollertillståndet uppdateras. Den här hanteraren anropas en gång omedelbart efter att pollertillståndet har initierats.

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

Egenskapsvärde

(state: DocumentAnalysisPollOperationState<Result>) => void

Ärvd frånPollerOptions.onProgress

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

Ärvd frånPollerOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

Ärvd frånPollerOptions.requestOptions

resumeFrom

Ett serialiserat pollertillstånd. Om den tillhandahålls återupptas avsökningsåtgärden från det angivna tillståndet i stället för att startas som om det vore en ny åtgärd.

resumeFrom?: string

Egenskapsvärde

string

Ärvd frånPollerOptions.resumeFrom

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

Ärvd frånPollerOptions.serializerOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd frånPollerOptions.tracingOptions

updateIntervalInMs

Väntetiden (i millisekunder) mellan efterföljande begäranden som relaterar till samma åtgärd.

updateIntervalInMs?: number

Egenskapsvärde

number

Ärvt frånPollerOptions.updateIntervalInMs