DetectEntities - Amazon Comprehend

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

DetectEntities

检查指定实体的文本,并返回有关它们的信息。有关命名实体的更多信息,请参阅实体(在开发人员指南中)。

请求语法

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

请求参数

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

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

EndpointArn

与自定义实体识别模型关联的终端节点的Amazon 资源名称。如果您希望使用自己的自定义模型(而不是 Amazon Comprehend 使用的默认模型)来检测实体,请提供终端节点。

如果您指定终端节点,则 Amazon Comprehend 将使用您的自定义模型的语言,并忽略您在请求中提供的任何语言代码。

有关终端节点的更多信息,请参阅管理终端节点.

类型: 字符串

长度约束:长度上限为 256。

模式:arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

必需: 否

LanguageCode

输入文档的语言。您可以指定 Amazon Compehend 支持的任何一种主要语言。所有文件必须使用相同的语言。

如果您的请求包含自定义实体识别模型的终端节点,则 Amazon Comprehend 将使用您的自定义模型的语言,并忽略您在此处指定的任何语言代码。

类型: 字符串

有效值: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

必需: 否

Text

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

类型: 字符串

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

必需: 是

响应语法

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

响应元素

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

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

Entities

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

如果您的请求使用自定义实体识别模型,则 Amazon Comprehend 会检测模型经过训练以识别的实体。否则,它会检测默认的实体类型。有关默认实体的列表,请参阅实体(在开发人员指南中)。

类型: 数组Entity对象

错误

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

InternalServerException

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

HTTP P P P P 代码:500

InvalidRequestException

该请求无效。

HTTP P P P P 代码:400

ResourceUnavailableException

指定的资源不可用。检查资源并重试发送您的请求。

HTTP P P P P 代码:400

TextSizeLimitExceededException

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

HTTP P P P P 代码:400

UnsupportedLanguageException

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

HTTP P P P P 代码:400

示例

检测实体

如果输入的文字是 “鲍勃今天从西雅图的一家商店订购了两个三明治和三个冰淇淋蛋筒。 “,该操作返回以下内容:

{ "Entities": [ { "Text": "Bob", "Score": 1.0, "Type": "PERSON", "BeginOffset": 0, "EndOffset": 3 }, { "Text": "two", "Score": 1.0, "Type": "QUANTITY", "BeginOffset": 12, "EndOffset": 15 }, { "Text": "three", "Score": 1.0, "Type": "QUANTITY", "BeginOffset": 32, "EndOffset": 37 }, { "Text": "Today", "Score": 1.0, "Type": "DATE", "BeginOffset": 54, "EndOffset": 59 }, { "Text": "Seattle", "Score": 1.0, "Type": "LOCATION", "BeginOffset": 76, "EndOffset": 83 } ], }

另请参阅

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