Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PIIDetectionSkill interface

  • 参考
包:
@azure/search-documents

使用 文本分析 API，从输入文本中提取个人信息，并提供屏蔽信息的选项。

Extends
BaseSearchIndexerSkill

属性

categories

应提取和屏蔽的 PII 实体类别列表。
defaultLanguageCode

一个值，该值指示要使用的语言代码。 默认值为 en。
domain

如果指定，则会将 PII 域设置为仅包含实体类别的子集。 可能的值包括：“phi”、“none”。 默认值为“none”。
maskingCharacter

如果 maskingMode 参数设置为替换，则用于屏蔽文本的字符。 默认值为“*”。
maskingMode

一个参数，提供各种方法来屏蔽在输入文本中检测到的个人信息。 默认值为“none”。
minimumPrecision

介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。
modelVersion

调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
odatatype

多态鉴别器，它指定此对象可以是的不同类型

继承属性

context

表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
description

技能的说明，描述技能的输入、输出和用法。
inputs

技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name

在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在 skills 数组中为其基于 1 的索引提供默认名称，前缀为 字符 #。
outputs

技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

属性详细信息

categories

应提取和屏蔽的 PII 实体类别列表。

categories?: string[]

属性值

string[]

defaultLanguageCode

一个值，该值指示要使用的语言代码。 默认值为 en。

defaultLanguageCode?: string

属性值

string

domain

如果指定，则会将 PII 域设置为仅包含实体类别的子集。 可能的值包括：“phi”、“none”。 默认值为“none”。

domain?: string

属性值

string

maskingCharacter

如果 maskingMode 参数设置为替换，则用于屏蔽文本的字符。 默认值为“*”。

maskingCharacter?: string

属性值

string

maskingMode

一个参数，提供各种方法来屏蔽在输入文本中检测到的个人信息。 默认值为“none”。

maskingMode?: PIIDetectionSkillMaskingMode

属性值

PIIDetectionSkillMaskingMode

minimumPrecision

介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。

minimumPrecision?: number

属性值

number

modelVersion

调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。

modelVersion?: string

属性值

string

odatatype

多态鉴别器，它指定此对象可以是的不同类型

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

属性值

"#Microsoft.Skills.Text.PIIDetectionSkill"

继承属性详细信息

context

表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。

context?: string

属性值

string

继承自BaseSearchIndexerSkill.context

description

技能的说明，描述技能的输入、输出和用法。

description?: string

属性值

string

继承自BaseSearchIndexerSkill.description

inputs

技能的输入可以是源数据集中的列，也可以是上游技能的输出。

inputs: InputFieldMappingEntry[]

属性值

InputFieldMappingEntry[]

继承自BaseSearchIndexerSkill.inputs

name

在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在 skills 数组中为其基于 1 的索引提供默认名称，前缀为 字符 #。

name?: string

属性值

string

继承自BaseSearchIndexerSkill.name

outputs

技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

outputs: OutputFieldMappingEntry[]

属性值

OutputFieldMappingEntry[]

继承自BaseSearchIndexerSkill.outputs