Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RecognizePiiEntitiesOptions

Package version

Options for the recognize PII entities operation.

Hierarchy

Index

Properties

Optional domainFilter

domainFilter: PiiEntityDomainType

Filters entities to ones only included in the specified domain (e.g., if set to 'PHI', entities in the Protected Healthcare Information domain will only be returned). See https://aka.ms/tanerpii for more information.

Optional includeStatistics

includeStatistics: undefined | false | true

If set to true, response will contain input and document level statistics.

Optional modelVersion

modelVersion: undefined | string

This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning

Generated using TypeDoc