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

RecognizePiiEntitiesAction 类

  • 参考

RecognizePiiEntitiesAction 封装了用于启动长时间运行的 PII 实体识别操作的参数。 有关详细信息，请参阅服务文档中： https://aka.ms/azsdk/language/pii

如果只想识别文档列表中的 pii 实体，而不对文档的输入执行多个长时间运行的操作，则调用 方法 recognize_pii_entities ，而不是与此模型交互。

继承
azure.ai.textanalytics._dict_mixin.DictMixin
RecognizePiiEntitiesAction

构造函数

RecognizePiiEntitiesAction(*, categories_filter: List[str | PiiEntityCategory] | None = None, domain_filter: str | None = None, model_version: str | None = None, string_index_type: str | None = None, disable_service_logs: bool | None = None, **kwargs: Any)

仅限关键字的参数

名称 说明
model_version
Optional[str]

用于分析的模型版本，例如“latest”。 如果未指定模型版本，API 将默认为最新的非预览版本。 有关详细信息，请参阅此处： https://aka.ms/text-analytics-model-versioning
domain_filter
Optional[str]

一个可选字符串，用于将 PII 域设置为仅包含 PII 实体类别的子集。 可能的值包括“phi”或“无”。
categories_filter
Optional[list[str 或 PiiEntityCategory]]

可以传入要筛选出的特定 PII 实体类别的列表，而不是筛选所有 PII 实体类别。例如，如果只想在文档中筛选出美国社会安全号码，则可以为此 kwarg 传入 [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER]。
string_index_type
Optional[str]

指定用于解释字符串偏移量的方法。 UnicodeCodePoint 是默认的 Python 编码。 若要替代 Python 默认值，还可以传入 Utf16CodeUnit 或 TextElement_v8。 有关其他信息，请参阅 https://aka.ms/text-analytics-offsets
disable_service_logs
Optional[bool]

默认为 true，这意味着语言服务不会在服务端记录输入文本进行故障排除。 如果设置为 False，则语言服务会记录输入文本 48 小时，仅用于排查在提供服务的自然语言处理功能时出现的问题。 有关详细信息，请参阅 上的 https://aka.ms/cs-compliance 认知服务合规性和隐私说明，以及 Microsoft https://www.microsoft.com/ai/responsible-ai负责任 AI 原则。

方法

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

参数

名称 说明
key
必需
default
默认值: None

has_key 

has_key(k: str) -> bool

参数

名称 说明
k
必需

items 

items() -> Iterable[Tuple[str, Any]]

keys 

keys() -> Iterable[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> Iterable[Any]

属性

categories_filter

可以传入要筛选出的特定 PII 实体类别的列表，而不是筛选所有 PII 实体类别。例如，如果只想在文档中筛选出美国社会安全号码，则可以为此 kwarg 传入 [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER]。

categories_filter: List[str | PiiEntityCategory] | None = None

disable_service_logs

默认为 true，这意味着语言服务不会在服务端记录输入文本进行故障排除。 如果设置为 False，则语言服务会记录输入文本 48 小时，仅用于排查在提供服务的自然语言处理功能时出现的问题。 有关详细信息，请参阅 上的 https://aka.ms/cs-compliance 认知服务合规性和隐私说明，以及 Microsoft https://www.microsoft.com/ai/responsible-ai负责任 AI 原则。

disable_service_logs: bool | None = None

domain_filter

一个可选字符串，用于将 PII 域设置为仅包含 PII 实体类别的子集。 可能的值包括“phi”或“无”。

domain_filter: str | None = None

model_version

用于分析的模型版本，例如“latest”。 如果未指定模型版本，API 将默认为最新的非预览版本。 有关详细信息，请参阅此处： https://aka.ms/text-analytics-model-versioning

model_version: str | None = None

string_index_type

指定用于解释字符串偏移量的方法。 UnicodeCodePoint 是默认的 Python 编码。 若要替代 Python 默认值，还可以传入 Utf16CodeUnit 或 TextElement_v8。 有关其他信息，请参阅 https://aka.ms/text-analytics-offsets

string_index_type: str | None = None