Compartilhar via

DocumentAnalysisClientOptions interface

Pacote:
@azure/ai-form-recognizer

Opções configuráveis para DocumentAnalysisClient.

Extends
CommonClientOptions

Propriedades

audience

O público-alvo (escopo) a ser usado para autenticação com o Azure Active Directory.

Definir esta opção é necessário apenas

  • se você estiver usando o Entra Id (e)
  • Se você estiver usando uma nuvem diferente da AzurePublicCloud nuvem ("https://cognitiveservices.azure.com")

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

A unidade de valores de deslocamento/comprimento de cadeia de caracteres retornada pelo serviço.

No JavaScript, as cadeias de caracteres são indexadas por unidades de código UTF-16. Não NÃO definir esse valor, a menos que você 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

Definir 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 do TLS
userAgentOptions

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

Detalhes da propriedade

audience

O público-alvo (escopo) a ser usado para autenticação com o Azure Active Directory.

Definir esta opção é necessário apenas

  • se você estiver usando o Entra Id (e)
  • Se você estiver usando uma nuvem diferente da AzurePublicCloud nuvem ("https://cognitiveservices.azure.com")

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

audience?: string

Valor da propriedade

string

stringIndexType

A unidade de valores de deslocamento/comprimento de cadeia de caracteres retornada pelo serviço.

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

Padrão: "utf16CodeUnit"

stringIndexType?: StringIndexType

Valor da propriedade

StringIndexType

Detalhes das propriedades herdadas

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

Valor da 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 da propriedade

Agent

herdado de CommonClientOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado de CommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valor da propriedade

HttpClient

herdado de CommonClientOptions.httpClient

proxyOptions

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

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

herdado de CommonClientOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

Valor da propriedade

RedirectPolicyOptions

herdado de CommonClientOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

Valor da 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 da propriedade

TelemetryOptions

herdado de CommonClientOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

herdado de CommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

UserAgentPolicyOptions

herdado de CommonClientOptions.userAgentOptions