DetectPiiEntities - Amazon Comprehend

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DetectPiiEntities

检查包含个人身份信息 (PII) 的实体的输入文本并返回有关它们的信息。

请求语法

{ "LanguageCode": "string", "Text": "string" }

请求参数

有关所有操作的通用参数的信息,请参阅常见参数.

请求接受采用 JSON 格式的以下数据。

LanguageCode

输入文档的语言。目前,英语是唯一有效的语言。

类型: 字符串

有效值: en

必需: 是

Text

UTF-8 文本字符串。最大字符串大小为 100 KB。

类型: 字符串

长度约束:最小长度为 1。

必需: 是

响应语法

{ "Entities": [ { "BeginOffset": number, "EndOffset": number, "Score": number, "Type": "string" } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

Entities

在输入文本中标识的 PII 实体的集合。对于每个实体,响应提供实体类型、实体文本的开头和结尾位置以及 Amazon Comprehend 对检测的置信程度。

类型: 数组PiiEntity对象

错误

有关所有操作常见错误的信息,请参阅常见错误.

InternalServerException

发生内部服务器错误。重试您的请求。

HTTP 状态代码:500

InvalidRequestException

该请求无效。

HTTP 状态代码:400

TextSizeLimitExceededException

输入文本的大小超出了限制。使用较小文档。

HTTP 状态代码:400

UnsupportedLanguageException

Amazon Comprehend (Comprehend) 无法处理输入文本的语言。对于自定义实体识别 API,仅接受英语、西班牙语、法语、意大利语、德语或葡萄牙语。有关受支持的语言的列表,支持的语言(在开发人员指南中)。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: