CustomEntityRecognitionBatchAction interface

Package:

@azure/ai-text-analytics

Options for a custom entity recognition batch action.

Extends

AnalyzeBatchActionCommon,CustomEntityRecognitionAction

Properties

kind	The kind of the action.

Inherited Properties

actionName	The name of the action.
deploymentName
disableServiceLogs	If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur. Default is false.
projectName
stringIndexType	Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType. The default is the JavaScript's default which is "Utf16CodeUnit".

Property Details

kind

The kind of the action.

kind: "CustomEntityRecognition"

Property Value

"CustomEntityRecognition"

Inherited Property Details

actionName

The name of the action.

actionName?: string

Property Value

string

Inherited From AnalyzeBatchActionCommon.actionName

deploymentName

deploymentName: string

Property Value

string

Inherited From CustomEntityRecognitionAction.deploymentName

disableServiceLogs

If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur.

Default is false.

disableServiceLogs?: boolean

Property Value

boolean

Inherited From CustomEntityRecognitionAction.disableServiceLogs

projectName

projectName: string

Property Value

string

Inherited From CustomEntityRecognitionAction.projectName

stringIndexType

Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType.

The default is the JavaScript's default which is "Utf16CodeUnit".

stringIndexType?: string

Property Value

string

Inherited From CustomEntityRecognitionAction.stringIndexType