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 Comprehend でサポートされている任意のプライマリ言語を指定できます。すべてのドキュメントは同じ言語である必要があります。

リクエストにカスタムエンティティ認識モデルのエンドポイントが含まれている場合 Amazon Comprehend はカスタムモデルの言語を使用し、ここで指定した言語コードを無視します。

型: 文字列

有効な値: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

必須: いいえ

テキスト

UTF-8 テキスト文字列。各文字列に含まれる UTF-8 エンコード文字は 5,000 バイト未満である必要があります。

型: 文字列

長さの制限: 最小長は 1 です。

必須: はい

レスポンスの構文

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

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

エンティティ

入力テキストで識別されたエンティティのコレクション。エンティティごとに、レスポンスにはエンティティテキスト、エンティティタイプ、エンティティテキストの開始位置と終了位置 Amazon Comprehend の検出における信頼度が示されます。

リクエストがカスタムエンティティ認識モデルを使用している場合 Amazon Comprehend はモデルが認識するようにトレーニングされたエンティティを検出します。それ以外の場合は、デフォルトのエンティティタイプを検出します。デフォルトのエンティティタイプのリストについては、「」エンティティの検出を参照してください。

タイプ: Entity オブジェクトの配列

Errors

すべてのアクションに共通のエラーについては、「一般的なエラー」を参照してください。

InternalServerException

内部サーバーエラーが発生しました。リクエストを再実行します。

HTTP ステータスコード: 500

InvalidRequestException

リクエストが無効です。

HTTP ステータスコード: 400

ResourceUnavailableException

指定されたリソースは使用できません。リソースを確認して、リクエストを再試行してください。

HTTP ステータスコード: 400

TextSizeLimitExceededException

入力テキストのサイズが制限を超えています。小さいドキュメントを使用します。

HTTP ステータスコード: 400

UnsupportedLanguageException

Amazon Comprehend は入力テキストの言語を処理できません。カスタムエンティティ認識 APIs では、英語、スペイン語、フランス語、イタリア語、ドイツ語、ポルトガル語のみが受け入れられます。サポートされている言語のリストについては、「Amazon Comprehend でサポートされている言語」を参照してください。

HTTP ステータスコード: 400

Examples

エンティティの検出

入力テキストが "Bob ordered two matches and 3 client cone condons today from a store in a Seattle" の場合、オペレーションは以下を返します。

{ "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 SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。