Share via

DocumentModelAdministrationClientOptions interface

Package:
@azure/ai-form-recognizer

Configurable options for DocumentModelAdministrationClient.

Extends
CommonClientOptions

Properties

audience

The audience (scope) to use for authentication with Azure Active Directory.

Setting this option is only necessary

  • if you are using Entra Id (and)
  • if you are using a cloud other than the AzurePublicCloud ("https://cognitiveservices.azure.com")

The authentication scope will be set from this audience. See KnownFormRecognizerAudience for known audience values.

Inherited Properties

additionalPolicies

Additional policies to include in the HTTP pipeline.
agent

Options for configuring Agent instance for outgoing requests
allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS
httpClient

The HttpClient that will be used to send HTTP requests.
proxyOptions

Options to configure a proxy for outgoing requests.
redirectOptions

Options for how redirect responses are handled.
retryOptions

Options that control how to retry failed requests.
telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions

Options for configuring TLS authentication
userAgentOptions

Options for adding user agent details to outgoing requests.

Property Details

audience

The audience (scope) to use for authentication with Azure Active Directory.

Setting this option is only necessary

  • if you are using Entra Id (and)
  • if you are using a cloud other than the AzurePublicCloud ("https://cognitiveservices.azure.com")

The authentication scope will be set from this audience. See KnownFormRecognizerAudience for known audience values.

audience?: string

Property Value

string

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From CommonClientOptions.additionalPolicies

agent

Options for configuring Agent instance for outgoing requests

agent?: Agent

Property Value

Agent

Inherited From CommonClientOptions.agent

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From CommonClientOptions.allowInsecureConnection

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From CommonClientOptions.httpClient

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From CommonClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From CommonClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From CommonClientOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From CommonClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From CommonClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From CommonClientOptions.userAgentOptions