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 recursos a serem habilitados no modelo. A habilitação de recursos pode incorrer em custos adicionais, portanto, consulte a documentação do serviço para entender a natureza dos recursos e os custos adicionais associados ao uso deles. Para obter mais informações sobre os recursos disponíveis no Reconhecimento de Formulários, 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 que indica idioma e região. Exemplos: "en-US" (inglês dos EUA) "fr" (francês - sem região)
pages	Uma lista de intervalos de páginas (indexados por 1) no documento de entrada a serem analisados, separados por vírgulas Exemplos: "1", "3-5", "1,3-5"

Propriedades herdadas

abortSignal	O sinal que pode ser usado para anular solicitações.
onProgress	Um manipulador de progresso inicial opcional que será chamado quando o estado do sondador for atualizado. Esse manipulador 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 solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para essa operação.
resumeFrom	Um estado de sondagem serializado. Se fornecida, a operação de sondagem será retomada do estado especificado em vez de iniciada como se fosse uma nova operação.
serializerOptions	Opções para substituir o comportamento de serialização/des serialização.
tracingOptions	Opções usadas quando o rastreamento está habilitado.
updateIntervalInMs	O tempo de espera (em milissegundos) entre solicitações subsequentes relacionadas à mesma operação.

Detalhes da propriedade

features

Uma lista de recursos a serem habilitados no modelo. A habilitação de recursos pode incorrer em custos adicionais, portanto, consulte a documentação do serviço para entender a natureza dos recursos e os custos adicionais associados ao uso deles.

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

features?: FormRecognizerFeature[]

Valor da 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 que indica idioma e região.

Exemplos:

• "en-US" (inglês dos EUA)
• "fr" (francês - sem região)

locale?: string

Valor da propriedade

string

pages

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

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

pages?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

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

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado dePollerOptions.abortSignal

onProgress

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

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

Valor da 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 solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado dePollerOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado dePollerOptions.requestOptions

resumeFrom

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

resumeFrom?: string

Valor da propriedade

string

Herdado dePollerOptions.resumeFrom

serializerOptions

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

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

Herdado dePollerOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado dePollerOptions.tracingOptions

updateIntervalInMs

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

updateIntervalInMs?: number

Valor da propriedade

number

Herdado dePollerOptions.updateIntervalInMs