AnalyzeDocumentOptions interface

Pacote:

@azure/ai-form-recognizer

Opções para a operação de análise de documentos.

Extends

OperationOptions,PollerOptions<DocumentAnalysisPollOperationState<Result>>

Propriedades

features	Uma lista de funcionalidades a ativar no modelo. A ativação das funcionalidades pode incorrer em custos adicionais, por isso, certifique-se de que consulta a documentação do serviço para compreender a natureza das funcionalidades e quaisquer custos adicionais associados à sua utilização. Para obter mais informações sobre as funcionalidades disponíveis no Reconhecedor de Formulários, consulte a documentação do serviço:https://aka.ms/azsdk/formrecognizer/features
locale	Sugestão de localização para reconhecimento de texto e análise de documentos. O valor pode especificar apenas o código de idioma de duas letras ou uma etiqueta de idioma BCP-47 que indica o idioma e a região. Exemplos: "en-US" (Inglês dos E.U.A.) "fr" (francês - sem região)
pages	Uma lista de intervalos de páginas (indexados a 1) no documento de entrada a analisar, separados por vírgulas Exemplos: "1", "3-5", "1,3-5"

Propriedades Herdadas

abortSignal	O sinal que pode ser utilizado para abortar pedidos.
onProgress	Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após o estado do poller ser inicializado.
onResponse	Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.
requestOptions	Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.
resumeFrom	Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada a partir do estado especificado em vez de iniciada como se se tratasse de uma nova operação.
serializerOptions	Opções para substituir o comportamento de serialização/des serialização.
tracingOptions	Opções utilizadas quando o rastreio está ativado.
updateIntervalInMs	A quantidade de tempo a aguardar (em milissegundos) entre pedidos subsequentes relacionados com a mesma operação.

Detalhes de Propriedade

features

Uma lista de funcionalidades a ativar no modelo. A ativação das funcionalidades pode incorrer em custos adicionais, por isso, certifique-se de que consulta a documentação do serviço para compreender a natureza das funcionalidades e quaisquer custos adicionais associados à sua utilização.

Para obter mais informações sobre as funcionalidades disponíveis no Reconhecedor de Formulários, consulte a documentação do serviço:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Valor de Propriedade

FormRecognizerFeature[]

locale

Sugestão de localização para reconhecimento de texto e análise de documentos.

O valor pode especificar apenas o código de idioma de duas letras ou uma etiqueta de idioma BCP-47 que indica o idioma e a região.

Exemplos:

• "en-US" (Inglês dos E.U.A.)
• "fr" (francês - sem região)

locale?: string

Valor de Propriedade

string

pages

Uma lista de intervalos de páginas (indexados a 1) no documento de entrada a analisar, separados por vírgulas

Exemplos: "1", "3-5", "1,3-5"

pages?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado dePollerOptions.abortSignal

onProgress

Um processador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este processador será chamado uma vez imediatamente após o estado do poller ser inicializado.

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

Valor de Propriedade

(state: DocumentAnalysisPollOperationState<Result>) => void

Herdado dePollerOptions.onProgress

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

Herdado dePollerOptions.onResponse

requestOptions

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

Herdado dePollerOptions.requestOptions

resumeFrom

Um estado de poller serializado. Se for fornecido, a operação de consulta será retomada a partir do estado especificado em vez de iniciada como se se tratasse de uma nova operação.

resumeFrom?: string

Valor de Propriedade

string

Herdado dePollerOptions.resumeFrom

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

Herdado dePollerOptions.serializerOptions

tracingOptions

Opções utilizadas quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

Herdado dePollerOptions.tracingOptions

updateIntervalInMs

A quantidade de tempo a aguardar (em milissegundos) entre pedidos subsequentes relacionados com a mesma operação.

updateIntervalInMs?: number

Valor de Propriedade

number

Herdado dePollerOptions.updateIntervalInMs