• Public
  • Public/Protected
  • All

Interface GeneratedClientEntitiesRecognitionPiiOptionalParams

Package version

Optional parameters.


  • any
    • GeneratedClientEntitiesRecognitionPiiOptionalParams



Optional domain

domain: undefined | string

(Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.

Optional includeStatistics

includeStatistics: undefined | false | true

(Optional) if set to true, response will contain request and document level statistics.

Optional loggingOptOut

loggingOptOut: undefined | false | true

(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate 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/en-us/ai/responsible-ai.

Optional modelVersion

modelVersion: undefined | string

(Optional) 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.

Optional piiCategories

piiCategories: PiiCategory[]

(Optional) describes the PII categories to return

Optional stringIndexType

stringIndexType: StringIndexType

(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets

Generated using TypeDoc