DocumentAnalysisClientOptions interface

Paquete:

@azure/ai-form-recognizer

Opciones configurables para DocumentAnalysisClient.

Extends

CommonClientOptions

Propiedades

audience

La audiencia (ámbito) que se va a usar para la autenticación con Azure Active Directory. Solo es necesario configurar esta opción si está utilizando Entra Id (y) Si está utilizando una nube que no sea la AzurePublicCloud ("https://cognitiveservices.azure.com") El ámbito de autenticación se establecerá desde esta audiencia. Consulte KnownFormRecognizerAudience para conocer los valores de audiencia conocidos.

stringIndexType

Unidad de valores de desplazamiento y longitud de cadena que devuelve el servicio. En JavaScript, las cadenas se indexan mediante unidades de código UTF-16. No no establezca este valor a menos que esté seguro de que necesita unidades de punto de código Unicode en su lugar. Valor predeterminado: "utf16CodeUnit"

Propiedades heredadas

additionalPolicies	Directivas adicionales que se van a incluir en la canalización HTTP.
agent	Opciones para configurar la instancia del agente para las solicitudes salientes
allowInsecureConnection	Establézcalo en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
httpClient	HttpClient que se usará para enviar solicitudes HTTP.
proxyOptions	Opciones para configurar un proxy para las solicitudes salientes.
redirectOptions	Opciones para controlar las respuestas de redirección.
retryOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
telemetryOptions	Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.
tlsOptions	Opciones para configurar la autenticación TLS
userAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

audience

La audiencia (ámbito) que se va a usar para la autenticación con Azure Active Directory.

Solo es necesario configurar esta opción

• si está utilizando Entra Id (y)
• Si está utilizando una nube que no sea la AzurePublicCloud ("https://cognitiveservices.azure.com")

El ámbito de autenticación se establecerá desde esta audiencia. Consulte KnownFormRecognizerAudience para conocer los valores de audiencia conocidos.

audience?: string

Valor de propiedad

string

stringIndexType

Unidad de valores de desplazamiento y longitud de cadena que devuelve el servicio.

En JavaScript, las cadenas se indexan mediante unidades de código UTF-16. No no establezca este valor a menos que esté seguro de que necesita unidades de punto de código Unicode en su lugar.

Valor predeterminado: "utf16CodeUnit"

stringIndexType?: StringIndexType

Valor de propiedad

StringIndexType

Detalles de las propiedades heredadas

additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

heredado de CommonClientOptions.additionalPolicies

agent

Opciones para configurar la instancia del agente para las solicitudes salientes

agent?: Agent

Valor de propiedad

Agent

heredado de CommonClientOptions.agent

allowInsecureConnection

Establézcalo en true si la solicitud se envía a través de HTTP en lugar de HTTPS.

allowInsecureConnection?: boolean

Valor de propiedad

boolean

heredado de CommonClientOptions.allowInsecureConnection

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

heredado de CommonClientOptions.httpClient

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

heredado de CommonClientOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redirección.

redirectOptions?: RedirectPolicyOptions

Valor de propiedad

RedirectPolicyOptions

Heredado de CommonClientOptions.redirectOptions

retryOptions

Opciones que controlan cómo reintentar las solicitudes con errores.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

heredado de CommonClientOptions.retryOptions

telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

Heredado de CommonClientOptions.telemetryOptions

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

heredado de CommonClientOptions.tlsOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Heredado de CommonClientOptions.userAgentOptions