AnalyzeDocumentOptions interface

  • Referência
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 recursos a serem habilitados no modelo. A ativação de recursos pode incorrer em custos adicionais, portanto, certifique-se de consultar a documentação do serviço para entender a natureza dos recursos e quaisquer custos adicionais associados ao seu uso.

Para obter mais informações sobre os recursos disponíveis no Form Recognizer, consulte a documentação do serviço: https://aka.ms/azsdk/formrecognizer/features
locale

Dica de localidade para reconhecimento de texto e análise de documentos.

O valor pode especificar apenas o código de idioma de duas letras ou uma marca de idioma BCP-47 indicando idioma e região.

Exemplos:

  • "en-US" (Inglês do Brasil)
  • "fr" (francês - sem região)
pages

Uma lista de intervalos de páginas (1-indexado) dentro do documento de entrada a analisar, separados por vírgulas

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

Propriedades Herdadas

abortSignal

O sinal que pode ser usado para abortar solicitações.
onProgress

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

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

Opções usadas ao criar e enviar solicitações HTTP para esta operação.
resumeFrom

Um estado de poller serializado. Se fornecida, a operação de votação será retomada do estado em questão, em vez de iniciada como se fosse uma nova operação.
serializerOptions

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

Opções usadas quando o rastreamento está habilitado.
updateIntervalInMs

A quantidade de tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.

Detalhes de Propriedade

features

Uma lista de recursos a serem habilitados no modelo. A ativação de recursos pode incorrer em custos adicionais, portanto, certifique-se de consultar a documentação do serviço para entender a natureza dos recursos e quaisquer custos adicionais associados ao seu uso.

Para obter mais informações sobre os recursos disponíveis no Form Recognizer, consulte a documentação do serviço: https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

Valor de Propriedade

FormRecognizerFeature[]

locale

Dica de localidade para reconhecimento de texto e análise de documentos.

O valor pode especificar apenas o código de idioma de duas letras ou uma marca de idioma BCP-47 indicando idioma e região.

Exemplos:

  • "en-US" (Inglês do Brasil)
  • "fr" (francês - sem região)
locale?: string

Valor de Propriedade

string

pages

Uma lista de intervalos de páginas (1-indexado) dentro do 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 usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado dePollerOptions.abortSignal

onProgress

Um manipulador de progresso inicial opcional que será chamado quando o estado do poller for atualizado. Este manipulador 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 doPollerOptions.onProgress

onResponse

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

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado do PollerOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado dePollerOptions.requestOptions

resumeFrom

Um estado de poller serializado. Se fornecida, a operação de votação será retomada do estado em questão, em vez de iniciada como se fosse uma nova operação.

resumeFrom?: string

Valor de Propriedade

string

herdado dePollerOptions.resumeFrom

serializerOptions

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

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

herdado dePollerOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado doPollerOptions.tracingOptions

updateIntervalInMs

A quantidade de tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.

updateIntervalInMs?: number

Valor de Propriedade

number

herdado doPollerOptions.updateIntervalInMs