Compartilhar via

PIIDetectionSkill interface

  • Referência
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 mascara-la.

Extends
BaseSearchIndexerSkill

Propriedades

categories

Uma lista de categorias de entidade 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 é 'none'.
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 detectadas no texto de entrada. O padrão é 'none'.
minimumPrecision

Um valor entre 0 e 1 que será usado apenas para incluir entidades cuja pontuação de confiança é maior que o valor especificado. Se não for definido (padrão) ou se definido explicitamente 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. Ele usará o padrão para o mais recente disponível quando não for especificado. Recomendamos que você não especifique esse valor, a menos que seja absolutamente necessário.
odatatype

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

Propriedades herdadas

context

Representa o nível em que 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, as saídas e o 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 upstream.
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, prefixado 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 entrada por outra habilidade.

Detalhes da propriedade

categories

Uma lista de categorias de entidade pii que devem ser extraídas e mascaradas.

categories?: string[]

Valor da propriedade

string[]

defaultLanguageCode

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

defaultLanguageCode?: string

Valor da 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 é 'none'.

domain?: string

Valor da 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 da propriedade

string

maskingMode

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

maskingMode?: "none" | "replace"

Valor da propriedade

"none" | "replace"

minimumPrecision

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

minimumPrecision?: number

Valor da propriedade

number

modelVersion

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

modelVersion?: string

Valor da propriedade

string

odatatype

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

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

Valor da propriedade

"#Microsoft.Skills.Text.PIIDetectionSkill"

Detalhes das propriedades herdadas

context

Representa o nível em que 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 da propriedade

string

Herdado deBaseSearchIndexerSkill.context

description

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

description?: string

Valor da 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 upstream.

inputs: InputFieldMappingEntry[]

Valor da 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, prefixado com o caractere '#'.

name?: string

Valor da propriedade

string

herdado deBaseSearchIndexerSkill.name

outputs

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

outputs: OutputFieldMappingEntry[]

Valor da propriedade

OutputFieldMappingEntry[]

Herdado deBaseSearchIndexerSkill.outputs