类别:

:doc:`/sql-reference/functions-string`(AI 函数)

AI_REDACT

对非结构化文本数据的个人身份信息 (PII) 进行脱敏处理。

语法

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

实参

必填:

input

一个包含可能含有个人身份信息 (PII) 的文本数据的 VARCHAR 值。

可选:

categories

一个字符串值的 ARRAY,用于指定需要进行脱敏处理的 PII 类型。如未指定,则对所有受支持的 PII 类别进行脱敏处理。请参阅 检测到 PII 类别 查看支持的类别列表。

传递不受支持的类别会导致错误。

return_error_details

BOOLEAN 标志,指示在发生错误时是否返回错误详细信息。当设置为 TRUE 时,该函数返回一个 OBJECT,其中包含值和错误消息,二者之一为 NULL,具体取决于函数是成功还是失败。

要求将会话参数 AI_SQL_ERROR_HANDLING_USE_FAIL_ON_ERROR 设置为 FALSE。

返回

Generally, a VARCHAR containing placeholder values in place of redacted PII, such as [NAME] where the input text had "John Smith".

如果会话参数 AI_SQL_ERROR_HANDLING_USE_FAIL_ON_ERROR 设置为 FALSE,且可选参数 return_error_details 设置为 FALSE 或未传递,并且函数无法处理输入,则函数返回 NULL。

如果会话参数 AI_SQL_ERROR_HANDLING_USE_FAIL_ON_ERROR 设置为 FALSE,可选实参 return_error_details 设置为 TRUE,该函数返回一个包含以下字段的 OBJECT:

  • value:选择使用 时默认使用的角色和仓库。包含编辑文本的 VARCHAR 值,或者如果发生错误,则返回 NULL。

  • error:选择使用 时默认使用的角色和仓库。包含错误消息(如果发生错误)的 VARCHAR 值,或者如果函数成功,则返回 NULL。

使用说明

  • 关于 AI_REDACT 可脱敏的 PII 类别,请参阅 检测到 PII 类别

  • 对于 AI_REDACT 当前版本的限制,请参阅 限制

示例

请参阅 示例

语言: 中文