TextAnalyticsRequestOptions Class

  • Reference

Definition

Namespace:
Azure.AI.TextAnalytics
Assembly:
Azure.AI.TextAnalytics.dll
Package:
Azure.AI.TextAnalytics v5.3.0
Source:
TextAnalyticsRequestOptions.cs

Options that allow callers to specify details about how the operation is run and what information is returned from it by the service.

For example, set model version, whether to include statistics, and more.

public class TextAnalyticsRequestOptions
type TextAnalyticsRequestOptions = class
Public Class TextAnalyticsRequestOptions
Inheritance
Object
TextAnalyticsRequestOptions
Derived

Constructors

TextAnalyticsRequestOptions()

Initializes a new instance of the TextAnalyticsRequestOptions class which allows callers to specify details about how the operation is run. For example, set model version, whether to include statistics, and more.

Properties

DisableServiceLogs

The default value of this property is false except for methods like AnalyzeHealthcareEntities and RecognizePiiEntities. This means that the Language service logs your input text for 48 hours solely to allow for troubleshooting issues. Setting this property to true disables input logging and may limit our ability to investigate issues that occur.

Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

IncludeStatistics

Gets or sets a value that, if set to true, indicates that the service should return document and document batch statistics with the results of the operation. Returns data for batch document methods only.
ModelVersion

Gets or sets a value that, if set, indicates the version of the Language service model that will be used to generate the result. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle#available-versions.

Applies to