DocumentAnalysisClientOptions Class

  • Reference

Definition

Namespace:
Azure.AI.FormRecognizer.DocumentAnalysis
Assembly:
Azure.AI.FormRecognizer.dll
Package:
Azure.AI.FormRecognizer v4.1.0
Source:
DocumentAnalysisClientOptions.cs

The set of options that can be specified when creating a DocumentAnalysisClient or a DocumentModelAdministrationClient to configure its behavior.

public class DocumentAnalysisClientOptions : Azure.Core.ClientOptions
type DocumentAnalysisClientOptions = class
    inherit ClientOptions
Public Class DocumentAnalysisClientOptions
Inherits ClientOptions
Inheritance
Object
ClientOptions
DocumentAnalysisClientOptions

Constructors

DocumentAnalysisClientOptions(DocumentAnalysisClientOptions+ServiceVersion)

Initializes a new instance of the DocumentAnalysisClientOptions class which allows to configure the behavior of the DocumentAnalysisClient or DocumentModelAdministrationClient.

Properties

Audience

Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
Retry

Gets the client retry options.

(Inherited from ClientOptions)
RetryPolicy

Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

(Inherited from ClientOptions)
Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)
Version

The service version.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)

Applies to