AnalyzeDocumentOptions interface

Paquete:

@azure/ai-form-recognizer

Opciones para la operación de análisis de documentos.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Propiedades

features	Lista de características que se habilitarán en el modelo. La habilitación de características puede incurrir en costos adicionales, por lo que asegúrese de consultar la documentación del servicio para comprender la naturaleza de las características y los costos agregados asociados con su uso. Para obtener más información sobre las características disponibles en Form Recognizer, consulte la documentación del servicio:https://aka.ms/azsdk/formrecognizer/features
locale	Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos. El valor solo puede especificar el código de idioma de dos letras o una etiqueta de idioma BCP-47 que indique tanto el idioma como la región. Ejemplos: "en-US" (inglés de EE. UU.) "fr" (francés - ninguna región)
pages	Lista de intervalos de páginas (indizado 1) dentro del documento de entrada que se va a analizar, separados por comas Ejemplos: "1", "3-5", "1,3-5"

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
onProgress	Controlador de progreso inicial opcional al que se llamará cuando se actualice el estado del sondeo. Se llamará a este controlador una vez inmediatamente después de inicializar el estado del sondeo.
onResponse	Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions	Opciones usadas al crear y enviar solicitudes HTTP para esta operación.
resumeFrom	Estado de sondeo serializado. Si se proporciona, la operación de sondeo se reanudará desde el estado especificado en lugar de iniciarse como si fuera una nueva operación.
serializerOptions	Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions	Opciones que se usan al habilitar el seguimiento.
updateIntervalInMs	Cantidad de tiempo de espera (en milisegundos) entre las solicitudes posteriores relacionadas con la misma operación.

Detalles de las propiedades

features

Lista de características que se habilitarán en el modelo. La habilitación de características puede incurrir en costos adicionales, por lo que asegúrese de consultar la documentación del servicio para comprender la naturaleza de las características y los costos agregados asociados con su uso.

Para obtener más información sobre las características disponibles en Form Recognizer, consulte la documentación del servicio:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Valor de propiedad

FormRecognizerFeature[]

locale

Sugerencia de configuración regional para el reconocimiento de texto y el análisis de documentos.

El valor solo puede especificar el código de idioma de dos letras o una etiqueta de idioma BCP-47 que indique tanto el idioma como la región.

Ejemplos:

• "en-US" (inglés de EE. UU.)
• "fr" (francés - ninguna región)

locale?: string

Valor de propiedad

string

pages

Lista de intervalos de páginas (indizado 1) dentro del documento de entrada que se va a analizar, separados por comas

Ejemplos: "1", "3-5", "1,3-5"

pages?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado dePollerOptions.abortSignal

onProgress

Controlador de progreso inicial opcional al que se llamará cuando se actualice el estado del sondeo. Se llamará a este controlador una vez inmediatamente después de inicializar el estado del sondeo.

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

Valor de propiedad

(state: DocumentAnalysisPollOperationState<Result>) => void

Heredado dePollerOptions.onProgress

onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

Heredado dePollerOptions.onResponse

requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado dePollerOptions.requestOptions

resumeFrom

Estado de sondeo serializado. Si se proporciona, la operación de sondeo se reanudará desde el estado especificado en lugar de iniciarse como si fuera una nueva operación.

resumeFrom?: string

Valor de propiedad

string

Heredado dePollerOptions.resumeFrom

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado dePollerOptions.serializerOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado dePollerOptions.tracingOptions

updateIntervalInMs

Cantidad de tiempo de espera (en milisegundos) entre las solicitudes posteriores relacionadas con la misma operación.

updateIntervalInMs?: number

Valor de propiedad

number

Heredado dePollerOptions.updateIntervalInMs