RecognizePiiEntitiesOptions interface
Warning
This API is now deprecated.
Options for the recognize PII entities operation.
- Extends
Properties
categories |
Filters entities to ones only included in the specified array of categories |
domain |
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. |
string |
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". |
Inherited Properties
abort |
The signal which can be used to abort requests. |
disable |
If set to true (the default for |
include |
If set to true, response will contain input and document level statistics. |
model |
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 |
on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
request |
Options used when creating and sending HTTP requests for this operation. |
serializer |
Options to override serialization/de-serialization behavior. |
tracing |
Options used when tracing is enabled. |
Property Details
categoriesFilter
Warning
This API is now deprecated.
Filters entities to ones only included in the specified array of categories
categoriesFilter?: string[]
Property Value
string[]
domainFilter
Warning
This API is now deprecated.
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.
domainFilter?: PROTECTED_HEALTH_INFORMATION
Property Value
stringIndexType
Warning
This API is now deprecated.
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".
stringIndexType?: StringIndexType
Property Value
Inherited Property Details
abortSignal
Warning
This API is now deprecated.
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From TextAnalyticsOperationOptions.abortSignal
disableServiceLogs
Warning
This API is now deprecated.
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.
disableServiceLogs?: boolean
Property Value
boolean
Inherited From TextAnalyticsOperationOptions.disableServiceLogs
includeStatistics
Warning
This API is now deprecated.
If set to true, response will contain input and document level statistics.
includeStatistics?: boolean
Property Value
boolean
Inherited From TextAnalyticsOperationOptions.includeStatistics
modelVersion
Warning
This API is now deprecated.
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
modelVersion?: string
Property Value
string
Inherited From TextAnalyticsOperationOptions.modelVersion
onResponse
Warning
This API is now deprecated.
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallback
Property Value
Inherited From TextAnalyticsOperationOptions.onResponse
requestOptions
Warning
This API is now deprecated.
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From TextAnalyticsOperationOptions.requestOptions
serializerOptions
Warning
This API is now deprecated.
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From TextAnalyticsOperationOptions.serializerOptions
tracingOptions
Warning
This API is now deprecated.
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From TextAnalyticsOperationOptions.tracingOptions