RecognizePiiEntitiesOptions | @azure/ai-text-analytics

Options for the recognize PII entities operation.

Hierarchy

TextAnalyticsOperationOptions
- RecognizePiiEntitiesOptions

Index

Properties

Optional categoriesFilter

categoriesFilter: PiiCategory[]

Specifies the list of Pii categories to return.

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

If set to true (the default for beginAnalyzeHealthcareEntities and recognizePiiEntities), 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. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur.

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

Optional stringIndexType

stringIndexType: StringIndexType

Specifies the measurement unit used to calculate the offset and length properties. Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". The default is the JavaScript's default which is "Utf16CodeUnit".