ConversationPIITaskParameters interface

Package:

@azure/ai-language-conversations

Supported parameters for a Conversational PII detection and redaction task.

Extends

PreBuiltTaskParameters

Properties

includeAudioRedaction	Flag to indicate if audio redaction is requested. By default audio redaction will not be performed.
piiCategories	Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.
redactionSource	For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.

Inherited Properties

loggingOptOut
modelVersion

Property Details

includeAudioRedaction

Flag to indicate if audio redaction is requested. By default audio redaction will not be performed.

includeAudioRedaction?: boolean

Property Value

boolean

piiCategories

Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.

piiCategories?: string[]

Property Value

string[]

redactionSource

For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.

redactionSource?: string

Property Value

string

Inherited Property Details

loggingOptOut

loggingOptOut?: boolean

Property Value

boolean

Inherited From PreBuiltTaskParameters.loggingOptOut

modelVersion

modelVersion?: string

Property Value

string

Inherited From PreBuiltTaskParameters.modelVersion