RecognizePiiEntitiesOptions Class

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

RecognizePiiEntitiesOptions.cs

Options that allow callers to specify details about how the operation is run. For example, set model version, whether to include statistics, filter the response entities by a given domain filter, and more.

public class RecognizePiiEntitiesOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions

type RecognizePiiEntitiesOptions = class
    inherit TextAnalyticsRequestOptions

Public Class RecognizePiiEntitiesOptions
Inherits TextAnalyticsRequestOptions

Inheritance

Object

TextAnalyticsRequestOptions

RecognizePiiEntitiesOptions

Constructors

RecognizePiiEntitiesOptions()

Initializes a new instance of the RecognizePiiEntitiesOptions class which allows callers to specify details about how the operation is run. For example, set model version, whether to include statistics, filter the response entities by a given domain filter, and more.

Properties

CategoriesFilter	Filters the response entities to entities that match the PiiEntityCategory specified.
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. (Inherited from TextAnalyticsRequestOptions)
DomainFilter	Filters the response entities to ones only included in the specified domain. For more information see https://aka.ms/azsdk/language/pii.
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. (Inherited from TextAnalyticsRequestOptions)
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. (Inherited from TextAnalyticsRequestOptions)