DocumentAnalysisClientOptions interface

Pacote:

@azure/ai-form-recognizer

Opções configuráveis para DocumentAnalysisClient.

Extends

CommonClientOptions

Propriedades

audience	A audiência (escopo) a ser usada para autenticação com o Azure Ative Directory. Definir esta opção só é necessário se estiver a utilizar o Entra Id (e) se estiver a utilizar uma nuvem diferente da AzurePublicCloud ("https://cognitiveservices.azure.com") O escopo de autenticação será definido a partir desse público. Consulte KnownFormRecognizerAudience para valores de audiência conhecidos.
stringIndexType	A unidade de valores de deslocamento/comprimento da cadeia de caracteres que o serviço retorna. Em JavaScript, as cadeias de caracteres são indexadas por unidades de código UTF-16. NÃO definir esse valor, a menos que tenha certeza de que precisa de unidades de ponto de código Unicode. Padrão: "utf16CodeUnit"

Propriedades Herdadas

additionalPolicies	Políticas adicionais a serem incluídas no pipeline HTTP.
agent	Opções para configurar a instância do Agente para solicitações de saída
allowInsecureConnection	Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
httpClient	O HttpClient que será usado para enviar solicitações HTTP.
proxyOptions	Opções para configurar um proxy para solicitações de saída.
redirectOptions	Opções de como as respostas de redirecionamento são tratadas.
retryOptions	Opções que controlam como repetir solicitações com falha.
telemetryOptions	Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions	Opções para configurar a autenticação TLS
userAgentOptions	Opções para adicionar detalhes do agente do usuário às solicitações de saída.

Detalhes de Propriedade

audience

A audiência (escopo) a ser usada para autenticação com o Azure Ative Directory.

Definir esta opção só é necessário

• se estiver a utilizar o Entra Id (e)
• se estiver a utilizar uma nuvem diferente da AzurePublicCloud ("https://cognitiveservices.azure.com")

O escopo de autenticação será definido a partir desse público. Consulte KnownFormRecognizerAudience para valores de audiência conhecidos.

audience?: string

Valor de Propriedade

string

stringIndexType

A unidade de valores de deslocamento/comprimento da cadeia de caracteres que o serviço retorna.

Em JavaScript, as cadeias de caracteres são indexadas por unidades de código UTF-16. NÃO definir esse valor, a menos que tenha certeza de que precisa de unidades de ponto de código Unicode.

Padrão: "utf16CodeUnit"

stringIndexType?: StringIndexType

Valor de Propriedade

StringIndexType

Detalhes da Propriedade Herdada

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

herdado de CommonClientOptions.additionalPolicies

agent

Opções para configurar a instância do Agente para solicitações de saída

agent?: Agent

Valor de Propriedade

Agent

herdado de CommonClientOptions.agent

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

herdado de CommonClientOptions.allowInsecureConnection

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

herdado de CommonClientOptions.httpClient

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

herdado de CommonClientOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

herdado de CommonClientOptions.redirectOptions

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

herdado de CommonClientOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

herdado de CommonClientOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

herdado de CommonClientOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

herdado de CommonClientOptions.userAgentOptions