TextAnalyticsClientOptions Class

Definition

Options that allow to configure the management of the request sent to the service. For example, set a default value for Country hint or Language that will apply to all the client calls. Add logging, add headers to request, etc.

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

Constructors

TextAnalyticsClientOptions(TextAnalyticsClientOptions+ServiceVersion)

Initializes a new instance of the TextAnalyticsClientOptions class.

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.

DefaultCountryHint

Default country hint value to use in all client calls. If no value is specified, "us" is set as default. To remove this behavior, set to None.

DefaultLanguage

Default language value to use in all client calls. If no value is specified, "en" is set as default.

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)

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