Categorias:: Funções de cadeia de caracteres e binários (funções de AI)

AI_REDACT¶

Detecta e oculta informações de identificação pessoal (personally identifiable information, PII) de dados de texto não estruturados.

Sintaxe¶

Use AI_REDACT para detectar e ocultar PII:

AI_REDACT( <input> [, <categories> ] [, <return_error_details> ] [, <mode> ] )

Copy

Argumentos¶

Obrigatório:

input: Um valor VARCHAR que contém dados de texto que podem conter informações de identificação pessoal (personally identifiable information, PII).

Opcional:

categories

Um ARRAY de valores de cadeia de caracteres que especificam os tipos de PII a serem ocultados. Se nada for especificado, todas as categorias de PII compatíveis serão ocultadas. Consulte Categorias de PIIs detectadas para obter uma lista de categorias compatíveis.

Passar uma categoria não compatível resulta em um erro.

return_error_details

Um sinalizador BOOLEAN que indica se os detalhes do erro devem ser retornados em caso de erro. Quando definido como TRUE, a função retorna um OBJECT que contém o valor e a mensagem de erro, sendo um deles NULL dependendo se a função foi bem-sucedida ou falhou.

Requer que o parâmetro de sessão AI_SQL_ERROR_HANDLING_USE_FAIL_ON_ERROR seja definido como FALSE.

mode

Um valor VARCHAR que especifica o modo de operação. Valores aceitos:

redact (padrão): substitui as PII detectadas por espaços reservados de categoria, como [NAME] e [ADDRESS].
detect: retorna um OBJECT que contém uma matriz spans que identifica a localização e a categoria de cada instância de PII detectada sem ocultar o texto.

Nota

O argumento mode não diferencia maiúsculas de minúsculas.

Retornos¶

O valor de retorno de AI_REDACT depende do argumento mode.

Modo de ocultação (padrão)¶

Retorna um VARCHAR que contém o texto de entrada com as PII substituídas por espaços reservados de categoria, como [NAME] em que o texto de entrada era «John Smith».

Modo de detecção¶

Retorna um OBJECT que contém uma matriz spans. Cada elemento na matriz é um OBJECT com os seguintes campos:

category: um valor VARCHAR que identifica a categoria da PII (por exemplo, NAME ou ADDRESS).

start: um valor NUMBER que identifica o índice inicial da PII no texto de entrada.

end: um valor NUMBER que identifica o índice final da PII no texto de entrada.

text: um valor VARCHAR que contém o texto da PII correspondente.

Comportamento em caso de erro¶

Por padrão, se AI_REDACT não conseguir processar a entrada, a função retornará um erro. Se a consulta processar várias linhas, toda a consulta falhará.

Quando AI_SQL_ERROR_HANDLING_USE_FAIL_ON_ERROR é definido como FALSE, o valor de retorno em caso de erro depende do argumento return_error_details. A tabela a seguir mostra o valor de retorno com base no argumento return_error_details:

return_error_details

Valor de retorno

Descrição

FALSE

Não passado

NULL

TRUE

OBJECT com campos value e error

value: um valor VARCHAR com o texto redigido ou com NULL se ocorrer um erro.

error: um valor VARCHAR com a mensagem de erro se ocorrer um erro ou com NULL se a função for bem-sucedida.

`return_error_details`	Valor de retorno	Descrição
FALSE Não passado	NULL
TRUE	OBJECT com campos `value` e `error`	`value`: um valor VARCHAR com o texto redigido ou com NULL se ocorrer um erro. `error`: um valor VARCHAR com a mensagem de erro se ocorrer um erro ou com NULL se a função for bem-sucedida.

Para obter mais informações sobre como lidar com erros, consulte Tratar erros no nível da linha em consultas de várias linhas.

Notas de uso¶

Para categorias de PII que AI_REDACT pode ocultar, consulte Categorias de PIIs detectadas.
Para limitações na versão atual de AI_REDACT, consulte Limitações.

Exemplos¶

Consulte Exemplos de ocultação.