Share via

RecognizeCategorizedEntitiesOptions interface

  • Reference
Package:
@azure/ai-text-analytics

Options for the recognize entities operation.

Extends
TextAnalyticsOperationOptions

Properties

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".

Inherited Properties

abortSignal

The signal which can be used to abort requests.
disableServiceLogs

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.
includeStatistics

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

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
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
serializerOptions

Options to override serialization/de-serialization behavior.
tracingOptions

Options used when tracing is enabled.

Property Details

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".

stringIndexType?: StringIndexType

Property Value

StringIndexType

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From TextAnalyticsOperationOptions.abortSignal

disableServiceLogs

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

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

includeStatistics?: boolean

Property Value

boolean

Inherited From TextAnalyticsOperationOptions.includeStatistics

modelVersion

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

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

RawResponseCallback

Inherited From TextAnalyticsOperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From TextAnalyticsOperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From TextAnalyticsOperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From TextAnalyticsOperationOptions.tracingOptions