PIIDetectionSkill interface

Pacote:

@azure/search-documents

Usando a API de Análise de Texto, extrai informações pessoais de um texto de entrada e oferece a opção de mascará-lo.

Extends

BaseSearchIndexerSkill

Propriedades

categories	Uma lista de categorias de entidades PII que devem ser extraídas e mascaradas.
defaultLanguageCode	Um valor que indica qual código de idioma usar. O padrão é en.
domain	Se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'phi', 'none'. O padrão é 'nenhum'.
maskingCharacter	O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'.
maskingMode	Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detetadas no texto de entrada. O padrão é 'nenhum'.
minimumPrecision	Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido como nulo, todas as entidades serão incluídas.
modelVersion	A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
odatatype	Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

Propriedades Herdadas

context	Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.
description	A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.
inputs	As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.
name	O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.
outputs	A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

Detalhes de Propriedade

categories

Uma lista de categorias de entidades PII que devem ser extraídas e mascaradas.

categories?: string[]

Valor de Propriedade

string[]

defaultLanguageCode

Um valor que indica qual código de idioma usar. O padrão é en.

defaultLanguageCode?: string

Valor de Propriedade

string

domain

Se especificado, definirá o domínio PII para incluir apenas um subconjunto das categorias de entidade. Os valores possíveis incluem: 'phi', 'none'. O padrão é 'nenhum'.

domain?: string

Valor de Propriedade

string

maskingCharacter

O caractere usado para mascarar o texto se o parâmetro maskingMode estiver definido para substituir. O padrão é '*'.

maskingCharacter?: string

Valor de Propriedade

string

maskingMode

Um parâmetro que fornece várias maneiras de mascarar as informações pessoais detetadas no texto de entrada. O padrão é 'nenhum'.

maskingMode?: "none" | "replace"

Valor de Propriedade

"none" | "replace"

minimumPrecision

Um valor entre 0 e 1 que deve ser usado para incluir apenas entidades cuja pontuação de confiança é maior do que o valor especificado. Se não estiver definido (padrão), ou se explicitamente definido como nulo, todas as entidades serão incluídas.

minimumPrecision?: number

Valor de Propriedade

number

modelVersion

A versão do modelo a ser usada ao chamar o serviço de Análise de Texto. O padrão será o mais recente disponível quando não especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.

modelVersion?: string

Valor de Propriedade

string

odatatype

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill"

Valor de Propriedade

"#Microsoft.Skills.Text.PIIDetectionSkill"

Detalhes da Propriedade Herdada

context

Representa o nível no qual as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

context?: string

Valor de Propriedade

string

herdado de BaseSearchIndexerSkill.context

description

A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.

description?: string

Valor de Propriedade

string

herdado deBaseSearchIndexerSkill.description

inputs

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade a montante.

inputs: InputFieldMappingEntry[]

Valor de Propriedade

InputFieldMappingEntry[]

herdado deBaseSearchIndexerSkill.inputs

name

O nome da habilidade que a identifica exclusivamente dentro do conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixada com o caractere '#'.

name?: string

Valor de Propriedade

string

herdada deBaseSearchIndexerSkill.name

outputs

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

outputs: OutputFieldMappingEntry[]

Valor de Propriedade

OutputFieldMappingEntry[]

herdado deBaseSearchIndexerSkill.outputs