AWS CLI を使用する Amazon Comprehend の例 - AWS Command Line Interface

AWS CLI を使用する Amazon Comprehend の例

次のコード例は、Amazon Comprehend で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

次のコード例は、batch-detect-dominant-language を使用する方法を示しています。

AWS CLI

複数の入力テキストの主要言語を検出するには

次の batch-detect-dominant-language の例では、複数の入力テキストを分析し、それぞれの主要言語を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend batch-detect-dominant-language \ --text-list "Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force."

出力:

{ "ResultList": [ { "Index": 0, "Languages": [ { "LanguageCode": "en", "Score": 0.9986501932144165 } ] } ], "ErrorList": [] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「主要言語」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectDominantLanguage」を参照してください。

次の例は、batch-detect-entities を使用する方法を説明しています。

AWS CLI

複数の入力テキストからエンティティを検出するには

次の batch-detect-entities の例では、複数の入力テキストを分析し、それぞれの名前付きエンティティを返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend batch-detect-entities \ --language-code en \ --text-list "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com."

出力:

{ "ResultList": [ { "Index": 0, "Entities": [ { "Score": 0.9985517859458923, "Type": "PERSON", "Text": "Jane", "BeginOffset": 5, "EndOffset": 9 }, { "Score": 0.9767839312553406, "Type": "ORGANIZATION", "Text": "AnyCompany Financial Services, LLC", "BeginOffset": 16, "EndOffset": 50 }, { "Score": 0.9856694936752319, "Type": "OTHER", "Text": "1111-XXXX-1111-XXXX", "BeginOffset": 71, "EndOffset": 90 }, { "Score": 0.9652159810066223, "Type": "QUANTITY", "Text": ".53", "BeginOffset": 116, "EndOffset": 119 }, { "Score": 0.9986667037010193, "Type": "DATE", "Text": "July 31st", "BeginOffset": 135, "EndOffset": 144 } ] }, { "Index": 1, "Entities": [ { "Score": 0.720084547996521, "Type": "ORGANIZATION", "Text": "Sunshine Spa", "BeginOffset": 33, "EndOffset": 45 }, { "Score": 0.9865870475769043, "Type": "LOCATION", "Text": "123 Main St", "BeginOffset": 47, "EndOffset": 58 }, { "Score": 0.5895616412162781, "Type": "LOCATION", "Text": "Anywhere", "BeginOffset": 60, "EndOffset": 68 }, { "Score": 0.6809214353561401, "Type": "PERSON", "Text": "Alice", "BeginOffset": 75, "EndOffset": 80 }, { "Score": 0.9979087114334106, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 84, "EndOffset": 99 } ] } ], "ErrorList": [] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「[Entities] (エンティティ)」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectEntities」を参照してください。

次のコード例は、batch-detect-key-phrases を使用する方法を示しています。

AWS CLI

複数のテキスト入力のキーフレーズを検出するには

次の batch-detect-key-phrases の例では、複数の入力テキストを分析し、それぞれの主要な名詞フレーズを返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend batch-detect-key-phrases \ --language-code en \ --text-list "Hello Zhang Wei, I am John, writing to you about the trip for next Saturday." "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com."

出力:

{ "ResultList": [ { "Index": 0, "KeyPhrases": [ { "Score": 0.99700927734375, "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9929308891296387, "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9997230172157288, "Text": "the trip", "BeginOffset": 49, "EndOffset": 57 }, { "Score": 0.9999470114707947, "Text": "next Saturday", "BeginOffset": 62, "EndOffset": 75 } ] }, { "Index": 1, "KeyPhrases": [ { "Score": 0.8358274102210999, "Text": "Dear Jane", "BeginOffset": 0, "EndOffset": 9 }, { "Score": 0.989359974861145, "Text": "Your AnyCompany Financial Services", "BeginOffset": 11, "EndOffset": 45 }, { "Score": 0.8812323808670044, "Text": "LLC credit card account 1111-XXXX-1111-XXXX", "BeginOffset": 47, "EndOffset": 90 }, { "Score": 0.9999381899833679, "Text": "a minimum payment", "BeginOffset": 95, "EndOffset": 112 }, { "Score": 0.9997439980506897, "Text": ".53", "BeginOffset": 116, "EndOffset": 119 }, { "Score": 0.996875524520874, "Text": "July 31st", "BeginOffset": 135, "EndOffset": 144 } ] }, { "Index": 2, "KeyPhrases": [ { "Score": 0.9990295767784119, "Text": "customer feedback", "BeginOffset": 12, "EndOffset": 29 }, { "Score": 0.9994127750396729, "Text": "Sunshine Spa", "BeginOffset": 33, "EndOffset": 45 }, { "Score": 0.9892991185188293, "Text": "123 Main St", "BeginOffset": 47, "EndOffset": 58 }, { "Score": 0.9969810843467712, "Text": "Alice", "BeginOffset": 75, "EndOffset": 80 }, { "Score": 0.9703696370124817, "Text": "AnySpa@example.com", "BeginOffset": 84, "EndOffset": 99 } ] } ], "ErrorList": [] }

詳細については、「Amazon Comprehend 開発者ガイド」の「キーフレーズ」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectKeyPhrases」を参照してください。

次の例は、batch-detect-sentiment を使用する方法を説明しています。

AWS CLI

複数の入力テキストの一般的な感情を検出するには

次の batch-detect-sentiment の例では、入力テキストを分析し、一般的な感情 (それぞれの POSITIVENEUTRALMIXED、または NEGATIVE) を返しています。

aws comprehend batch-detect-sentiment \ --text-list "That movie was very boring, I can't believe it was over four hours long." "It is a beautiful day for hiking today." "My meal was okay, I'm excited to try other restaurants." \ --language-code en

出力:

{ "ResultList": [ { "Index": 0, "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.00011316669406369328, "Negative": 0.9995445609092712, "Neutral": 0.00014722718333359808, "Mixed": 0.00019498742767609656 } }, { "Index": 1, "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9981263279914856, "Negative": 0.00015240783977787942, "Neutral": 0.0013876151060685515, "Mixed": 0.00033366199932061136 } }, { "Index": 2, "Sentiment": "MIXED", "SentimentScore": { "Positive": 0.15930435061454773, "Negative": 0.11471917480230331, "Neutral": 0.26897063851356506, "Mixed": 0.45700588822364807 } } ], "ErrorList": [] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「感情」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectSentiment」を参照してください。

次のコード例は、batch-detect-syntax を使用する方法を示しています。

AWS CLI

複数の入力テキスト内の単語の構文と品詞を調べるには

次の batch-detect-syntax の例では、複数の入力テキストの構文を分析し、さまざまな品詞を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend batch-detect-syntax \ --text-list "It is a beautiful day." "Can you please pass the salt?" "Please pay the bill before the 31st." \ --language-code en

出力:

{ "ResultList": [ { "Index": 0, "SyntaxTokens": [ { "TokenId": 1, "Text": "It", "BeginOffset": 0, "EndOffset": 2, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999740719795227 } }, { "TokenId": 2, "Text": "is", "BeginOffset": 3, "EndOffset": 5, "PartOfSpeech": { "Tag": "VERB", "Score": 0.999937117099762 } }, { "TokenId": 3, "Text": "a", "BeginOffset": 6, "EndOffset": 7, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999926686286926 } }, { "TokenId": 4, "Text": "beautiful", "BeginOffset": 8, "EndOffset": 17, "PartOfSpeech": { "Tag": "ADJ", "Score": 0.9987891912460327 } }, { "TokenId": 5, "Text": "day", "BeginOffset": 18, "EndOffset": 21, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999778866767883 } }, { "TokenId": 6, "Text": ".", "BeginOffset": 21, "EndOffset": 22, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.9999974966049194 } } ] }, { "Index": 1, "SyntaxTokens": [ { "TokenId": 1, "Text": "Can", "BeginOffset": 0, "EndOffset": 3, "PartOfSpeech": { "Tag": "AUX", "Score": 0.9999770522117615 } }, { "TokenId": 2, "Text": "you", "BeginOffset": 4, "EndOffset": 7, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999986886978149 } }, { "TokenId": 3, "Text": "please", "BeginOffset": 8, "EndOffset": 14, "PartOfSpeech": { "Tag": "INTJ", "Score": 0.9681622385978699 } }, { "TokenId": 4, "Text": "pass", "BeginOffset": 15, "EndOffset": 19, "PartOfSpeech": { "Tag": "VERB", "Score": 0.9999874830245972 } }, { "TokenId": 5, "Text": "the", "BeginOffset": 20, "EndOffset": 23, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999827146530151 } }, { "TokenId": 6, "Text": "salt", "BeginOffset": 24, "EndOffset": 28, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9995040893554688 } }, { "TokenId": 7, "Text": "?", "BeginOffset": 28, "EndOffset": 29, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.999998152256012 } } ] }, { "Index": 2, "SyntaxTokens": [ { "TokenId": 1, "Text": "Please", "BeginOffset": 0, "EndOffset": 6, "PartOfSpeech": { "Tag": "INTJ", "Score": 0.9997857809066772 } }, { "TokenId": 2, "Text": "pay", "BeginOffset": 7, "EndOffset": 10, "PartOfSpeech": { "Tag": "VERB", "Score": 0.9999252557754517 } }, { "TokenId": 3, "Text": "the", "BeginOffset": 11, "EndOffset": 14, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999842643737793 } }, { "TokenId": 4, "Text": "bill", "BeginOffset": 15, "EndOffset": 19, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999588131904602 } }, { "TokenId": 5, "Text": "before", "BeginOffset": 20, "EndOffset": 26, "PartOfSpeech": { "Tag": "ADP", "Score": 0.9958304762840271 } }, { "TokenId": 6, "Text": "the", "BeginOffset": 27, "EndOffset": 30, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999947547912598 } }, { "TokenId": 7, "Text": "31st", "BeginOffset": 31, "EndOffset": 35, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9924124479293823 } }, { "TokenId": 8, "Text": ".", "BeginOffset": 35, "EndOffset": 36, "PartOfSpeech": { "Tag": "PUNCT", "Score": 0.9999955892562866 } } ] } ], "ErrorList": [] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「構文分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectSyntax」を参照してください。

次のコード例は、batch-detect-targeted-sentiment を使用する方法を示しています。

AWS CLI

複数の入力テキストの感情とそれぞれの名前付きエンティティを検出するには

次の batch-detect-targeted-sentiment の例では、複数の入力テキストを分析し、名前付きエンティティとそれぞれのエンティティにアタッチされた一般的な感情を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend batch-detect-targeted-sentiment \ --language-code en \ --text-list "That movie was really boring, the original was way more entertaining" "The trail is extra beautiful today." "My meal was just okay."

出力:

{ "ResultList": [ { "Index": 0, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999009966850281, "GroupScore": 1.0, "Text": "movie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.13887299597263336, "Negative": 0.8057460188865662, "Neutral": 0.05525200068950653, "Mixed": 0.00012799999967683107 } }, "BeginOffset": 5, "EndOffset": 10 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9921110272407532, "GroupScore": 1.0, "Text": "original", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9999989867210388, "Negative": 9.999999974752427e-07, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 34, "EndOffset": 42 } ] } ] }, { "Index": 1, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.7545599937438965, "GroupScore": 1.0, "Text": "trail", "Type": "OTHER", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 1.0, "Negative": 0.0, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 4, "EndOffset": 9 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999960064888, "GroupScore": 1.0, "Text": "today", "Type": "DATE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 9.000000318337698e-06, "Negative": 1.9999999949504854e-06, "Neutral": 0.9999859929084778, "Mixed": 3.999999989900971e-06 } }, "BeginOffset": 29, "EndOffset": 34 } ] } ] }, { "Index": 2, "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999880194664001, "GroupScore": 1.0, "Text": "My", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.0, "Negative": 0.0, "Neutral": 1.0, "Mixed": 0.0 } }, "BeginOffset": 0, "EndOffset": 2 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9995260238647461, "GroupScore": 1.0, "Text": "meal", "Type": "OTHER", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.04695599898695946, "Negative": 0.003226999891921878, "Neutral": 0.6091709733009338, "Mixed": 0.34064599871635437 } }, "BeginOffset": 3, "EndOffset": 7 } ] } ] } ], "ErrorList": [] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Targeted Sentiment」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDetectTargetedSentiment」を参照してください。

次のコード例は、classify-document を使用する方法を示しています。

AWS CLI

モデル固有のエンドポイントを使用してドキュメントを分類するには

次の classify-document の例では、カスタムモデルのエンドポイントを使用してドキュメントを分類しています。この例のモデルは、スパムまたは非スパム (「ハム」) としてラベル付けされた SMS メッセージを含むデータセットでトレーニングされました。

aws comprehend classify-document \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint \ --text "CONGRATULATIONS! TXT 1235550100 to win $5000"

出力:

{ "Classes": [ { "Name": "spam", "Score": 0.9998599290847778 }, { "Name": "ham", "Score": 0.00014001205272506922 } ] }

詳細については、「Amazon Comprehend 開発者ガイド」の「カスタム分類」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ClassifyDocument」を参照してください。

次のコード例は、contains-pii-entities を使用する方法を示しています。

AWS CLI

PII 情報の有無について入力テキストを分析するには

次の contains-pii-entities の例では、入力テキストを分析して個人を特定できる情報 (PII) の有無を確認し、名前、住所、銀行口座番号、電話番号などの識別された PII エンティティタイプのラベルを返しています。

aws comprehend contains-pii-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. Customer feedback for Sunshine Spa, 100 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."

出力:

{ "Labels": [ { "Name": "NAME", "Score": 1.0 }, { "Name": "EMAIL", "Score": 1.0 }, { "Name": "BANK_ACCOUNT_NUMBER", "Score": 0.9995794296264648 }, { "Name": "BANK_ROUTING", "Score": 0.9173126816749573 }, { "Name": "CREDIT_DEBIT_NUMBER", "Score": 1.0 } }

サポートされる PII エンティティタイプの一覧の詳細については、「Amazon Comprehend 開発者ガイド」の「個人を特定できる情報 (PII)」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ContainsPiiEntities」を参照してください。

次の例は、create-dataset を使用する方法を説明しています。

AWS CLI

フライホイールデータセットを作成するには

次の create-dataset の例では、フライホイールのデータセットを作成しています。このデータセットは、--dataset-type タグで指定された追加のトレーニングデータとして使用されます。

aws comprehend create-dataset \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity \ --dataset-name example-dataset \ --dataset-type "TRAIN" \ --input-data-config file://inputConfig.json

file://inputConfig.json の内容:

{ "DataFormat": "COMPREHEND_CSV", "DocumentClassifierInputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/training-data.csv" } }

出力:

{ "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateDataset」を参照してください。

次のコード例は、create-document-classifier を使用する方法を示しています。

AWS CLI

ドキュメントを分類するドキュメント分類子を作成するには

次の create-document-classifier の例では、ドキュメント分類子モデルのトレーニングプロセスを開始します。トレーニングデータファイル「training.csv」は、--input-data-config タグにあります。training.csv は 2 列のドキュメントで、1 番目の列にはラベルまたは分類が、2 番目の列にはドキュメントが表示されます。

aws comprehend create-document-classifier \ --document-classifier-name example-classifier \ --data-access-arn arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --language-code en

出力:

{ "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" }

詳細については、「Amazon Comprehend 開発者ガイド」の「カスタム分類」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「CreateDocumentClassifier」を参照してください。

次のコード例は、create-endpoint を使用する方法を示しています。

AWS CLI

カスタムモデルのエンドポイントを作成するには

次の create-endpoint の例では、以前にトレーニングしたカスタムモデルの同期推論用のエンドポイントを作成しています。

aws comprehend create-endpoint \ --endpoint-name example-classifier-endpoint-1 \ --model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier \ --desired-inference-units 1

出力:

{ "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateEndpoint」を参照してください。

次の例は、create-entity-recognizer を使用する方法を説明しています。

AWS CLI

カスタムエンティティレコグナイザーを作成するには

次の create-entity-recognizer の例では、カスタムエンティティレコグナイザーモデルのトレーニングプロセスを開始しています。この例では、トレーニングドキュメントを含む CSV ファイル (raw_text.csv)、および CSV エンティティリスト (entity_list.csv) を使用してモデルをトレーニングします。entity-list.csv には、テキスト列とタイプ列が含まれています。

aws comprehend create-entity-recognizer \ --recognizer-name example-entity-recognizer --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --input-data-config "EntityTypes=[{Type=DEVICE}],Documents={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/raw_text.csv},EntityList={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv}" --language-code en

出力:

{ "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:example-entity-recognizer/entityrecognizer1" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Custom entity recognition」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateEntityRecognizer」を参照してください。

次の例は、create-flywheel を使用する方法を説明しています。

AWS CLI

フライホイールを作成するには

次の create-flywheel の例では、ドキュメント分類またはエンティティ認識モデルの継続的なトレーニングを調整するためのフライホイールを作成しています。この例でのフライホイールは、--active-model-arn タグで指定された既存のトレーニング済みモデルを管理するために作成されています。フライホイールが作成されると、--input-data-lake タグにデータレイクが作成されます。

aws comprehend create-flywheel \ --flywheel-name example-flywheel \ --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1 \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --data-lake-s3-uri "s3://amzn-s3-demo-bucket"

出力:

{ "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「CreateFlywheel」を参照してください。

次のコード例は、delete-document-classifier を使用する方法を示しています。

AWS CLI

カスタムドキュメント分類子を削除するには

次の delete-document-classifier の例では、カスタムドキュメント分類子モデルを削除します。

aws comprehend delete-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DeleteDocumentClassifier」を参照してください。

次のコード例は、delete-endpoint を使用する方法を示しています。

AWS CLI

カスタムモデルのエンドポイントを削除するには

次の delete-endpoint の例では、モデル固有のエンドポイントを削除しています。モデルを削除するには、すべてのエンドポイントを削除する必要があります。

aws comprehend delete-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteEndpoint」を参照してください。

次の例は、delete-entity-recognizer を使用する方法を説明しています。

AWS CLI

カスタムエンティティレコグナイザーモデルを削除するには

次の delete-entity-recognizer の例では、カスタムエンティティレコグナイザーモデルを削除しています。

aws comprehend delete-entity-recognizer \ --entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/example-entity-recognizer-1

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteEntityRecognizer」を参照してください。

次のコード例は、delete-flywheel を使用する方法を示しています。

AWS CLI

フライホイールを削除するには

次の delete-flywheel の例では、フライホイールを削除しています。フライホイールに関連付けられたデータレイクまたはモデルは削除されません。

aws comprehend delete-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteFlywheel」を参照してください。

次の例は、delete-resource-policy を使用する方法を説明しています。

AWS CLI

リソースベースのポリシーを削除するには

次の delete-resource-policy の例では、Amazon Comprehend リソースからリソースベースのポリシーを削除しています。

aws comprehend delete-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1/version/1

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Copying custom models between AWS accounts」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteResourcePolicy」を参照してください。

次の例は、describe-dataset を使用する方法を説明しています。

AWS CLI

フライホイールデータセットを記述するには

次の describe-dataset の例では、フライホイールのデータセットのプロパティを取得しています。

aws comprehend describe-dataset \ --dataset-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset

出力:

{ "DatasetProperties": { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset", "DatasetName": "example-dataset", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/12345678A123456Z/datasets/example-dataset/20230616T203710Z/", "Status": "CREATING", "CreationTime": "2023-06-16T20:37:10.400000+00:00" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeDataset」を参照してください。

次の例は、describe-document-classification-job を使用する方法を説明しています。

AWS CLI

ドキュメント分類ジョブを記述するには

次の describe-document-classification-job の例では、非同期ドキュメント分類ジョブのプロパティを取得します。

aws comprehend describe-document-classification-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "DocumentClassificationJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "exampleclassificationjob", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:09:51.788000+00:00", "EndTime": "2023-06-14T17:15:58.582000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/1", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-CLN-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタム分類」を参照してください。

次の例は、describe-document-classifier を使用する方法を説明しています。

AWS CLI

ドキュメント分類子を記述するには

次の describe-document-classifier の例では、カスタムドキュメント分類子モデルのプロパティを取得します。

aws comprehend describe-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1

出力:

{ "DocumentClassifierProperties": { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-13T19:04:15.735000+00:00", "EndTime": "2023-06-13T19:42:31.752000+00:00", "TrainingStartTime": "2023-06-13T19:08:20.114000+00:00", "TrainingEndTime": "2023-06-13T19:41:35.080000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "ClassifierMetadata": { "NumberOfLabels": 3, "NumberOfTrainedDocuments": 5016, "NumberOfTestDocuments": 557, "EvaluationMetrics": { "Accuracy": 0.9856, "Precision": 0.9919, "Recall": 0.9459, "F1Score": 0.9673, "MicroPrecision": 0.9856, "MicroRecall": 0.9856, "MicroF1Score": 0.9856, "HammingLoss": 0.0144 } }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "MULTI_CLASS" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタムモデルの作成と管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeDocumentClassifier」を参照してください。

次のコード例は、describe-dominant-language-detection-job を使用する方法を示しています。

AWS CLI

主要言語の検出ジョブを記述するには。

次の describe-dominant-language-detection-job の例では、非同期主要言語検出ジョブのプロパティを取得しています。

aws comprehend describe-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "DominantLanguageDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis1", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:10:38.037000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、describe-endpoint を使用する方法を説明しています。

AWS CLI

特定のエンドポイントを記述するには

次の describe-endpoint の例では、モデル固有のエンドポイントのプロパティを取得しています。

aws comprehend describe-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint

出力:

{ "EndpointProperties": { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint, "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DescribeEndpoint」を参照してください。

次の例は、describe-entities-detection-job を使用する方法を説明しています。

AWS CLI

エンティティ検出ジョブを記述するには

次の describe-entities-detection-job の例では、非同期エンティティ検出ジョブのプロパティを取得しています。

aws comprehend describe-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "EntitiesDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-entity-detector", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeEntitiesDetectionJob」を参照してください。

次のコード例は、describe-entity-recognizer を使用する方法を示しています。

AWS CLI

エンティティレコグナイザーを記述するには

次の describe-entity-recognizer の例では、カスタムエンティティレコグナイザーモデルのプロパティを取得しています。

aws comprehend describe-entity-recognizer \ entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1

出力:

{ "EntityRecognizerProperties": { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T20:44:59.631000+00:00", "EndTime": "2023-06-14T20:59:19.532000+00:00", "TrainingStartTime": "2023-06-14T20:48:52.811000+00:00", "TrainingEndTime": "2023-06-14T20:58:11.473000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "BUSINESS" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 1814, "NumberOfTestDocuments": 486, "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "EntityTypes": [ { "Type": "BUSINESS", "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "NumberOfTrainMentions": 1520 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "VersionName": "1" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Custom entity recognition」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeEntityRecognizer」を参照してください。

次の例は、describe-events-detection-job を使用する方法を説明しています。

AWS CLI

イベント検出ジョブを記述するには。

次の describe-events-detection-job の例では、非同期イベント検出ジョブのプロパティを取得しています。

aws comprehend describe-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "EventsDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "events_job_1", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-12T18:45:56.054000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/EventsData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-EVENTS-123456abcdeb0e11022f22a11EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeEventsDetectionJob」を参照してください。

次の例は、describe-flywheel-iteration を使用する方法を説明しています。

AWS CLI

フライホイールイテレーションを記述するには

次の describe-flywheel-iteration の例では、フライホイールイテレーションのプロパティを取得しています。

aws comprehend describe-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel \ --flywheel-iteration-id 20232222AEXAMPLE

出力:

{ "FlywheelIterationProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity", "FlywheelIterationId": "20232222AEXAMPLE", "CreationTime": "2023-06-16T21:10:26.385000+00:00", "EndTime": "2023-06-16T23:33:16.827000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AveragePrecision": 0.8287636394041166, "AverageRecall": 0.7427084833645399, "AverageAccuracy": 0.8795394154118689 }, "TrainedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/Comprehend-Generated-v1-bb52d585", "TrainedModelMetrics": { "AverageF1Score": 0.9767700253081214, "AveragePrecision": 0.9767700253081214, "AverageRecall": 0.9767700253081214, "AverageAccuracy": 0.9858281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-destination-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/evaluation/20230616T211026Z/" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeFlywheelIteration」を参照してください。

次のコード例は、describe-flywheel を使用する方法を示しています。

AWS CLI

フライホイールを記述するには

次の describe-flywheel の例では、フライホイールのプロパティを取得しています。この例では、フライホイールに関連付けられたモデルは、ドキュメントをスパムまたは非スパム (「ハム」) として分類するようにトレーニングされたカスタム分類子モデルです。

aws comprehend describe-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel

出力:

{ "FlywheelProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TaskConfig": { "LanguageCode": "en", "DocumentClassificationConfig": { "Mode": "MULTI_CLASS", "Labels": [ "ham", "spam" ] } }, "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230616T200543Z/", "DataSecurityConfig": {}, "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-16T20:21:43.567000+00:00" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeFlywheel」を参照してください。

次の例は、describe-key-phrases-detection-job を使用する方法を説明しています。

AWS CLI

キーフレーズ検出ジョブを記述するには

次の describe-key-phrases-detection-job の例では、非同期キーフレーズ検出ジョブのプロパティを取得しています。

aws comprehend describe-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "KeyPhrasesDetectionJobProperties": { "JobId": "69aa080c00fc68934a6a98f10EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/69aa080c00fc68934a6a98f10EXAMPLE", "JobName": "example-key-phrases-detection-job", "JobStatus": "COMPLETED", "SubmitTime": 1686606439.177, "EndTime": 1686606806.157, "InputDataConfig": { "S3Uri": "s3://dereksbucket1001/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://dereksbucket1002/testfolder/111122223333-KP-69aa080c00fc68934a6a98f10EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testrole" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次のコード例は、describe-pii-entities-detection-job を使用する方法を示しています。

AWS CLI

PII エンティティ検出ジョブを記述するには

次の describe-pii-entities-detection-job の例では、非同期 PII エンティティ検出ジョブのプロパティを取得しています。

aws comprehend describe-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "PiiEntitiesDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-pii-entities-job", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次のコード例は、describe-resource-policy を使用する方法を示しています。

AWS CLI

モデルにアタッチされたリソースポリシーを記述するには

次の describe-resource-policy の例では、モデルにアタッチされたリソースベースのポリシーのプロパティを取得しています。

aws comprehend describe-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1

出力:

{ "ResourcePolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"comprehend:ImportModel\",\"Resource\":\"*\"}]}", "CreationTime": "2023-06-19T18:44:26.028000+00:00", "LastModifiedTime": "2023-06-19T18:53:02.002000+00:00", "PolicyRevisionId": "baa675d069d07afaa2aa3106ae280f61" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Copying custom models between AWS accounts」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeResourcePolicy」を参照してください。

次のコード例は、describe-sentiment-detection-job を使用する方法を示しています。

AWS CLI

感情検出ジョブを記述するには

次の describe-sentiment-detection-job の例では、非同期感情検出ジョブのプロパティを取得しています。

aws comprehend describe-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "SentimentDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "movie_review_analysis", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeSentimentDetectionJob」を参照してください。

次の例は、describe-targeted-sentiment-detection-job を使用する方法を説明しています。

AWS CLI

ターゲット感情検出ジョブを記述するには

次の describe-targeted-sentiment-detection-job の例では、非同期ターゲット感情検出ジョブのプロパティを取得しています。

aws comprehend describe-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "TargetedSentimentDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "movie_review_analysis", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、describe-topics-detection-job を使用する方法を説明しています。

AWS CLI

トピック検出ジョブを説明するには

次の describe-topics-detection-job の例では、非同期トピック検出ジョブのプロパティを取得します。

aws comprehend describe-topics-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "TopicsDetectionJobProperties": { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example_topics_detection", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:44:43.414000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-examplerole" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DescribeTopicsDetectionJob」を参照してください。

次の例は、detect-dominant-language を使用する方法を説明しています。

AWS CLI

入力テキストの主要言語を検出するには

以下の detect-dominant-language は、入力テキストを分析し、主要言語を特定します。事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-dominant-language \ --text "It is a beautiful day in Seattle."

出力:

{ "Languages": [ { "LanguageCode": "en", "Score": 0.9877256155014038 } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「主要言語」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DetectDominantLanguage」を参照してください。

次の例は、detect-entities を使用する方法を説明しています。

AWS CLI

入力テキストの名前付きエンティティを検出するには

次の detect-entities の例では、入力テキストを分析し、名前付きエンティティを返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."

出力:

{ "Entities": [ { "Score": 0.9994556307792664, "Type": "PERSON", "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9981022477149963, "Type": "PERSON", "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9986887574195862, "Type": "ORGANIZATION", "Text": "AnyCompany Financial Services, LLC", "BeginOffset": 33, "EndOffset": 67 }, { "Score": 0.9959119558334351, "Type": "OTHER", "Text": "1111-XXXX-1111-XXXX", "BeginOffset": 88, "EndOffset": 107 }, { "Score": 0.9708039164543152, "Type": "QUANTITY", "Text": ".53", "BeginOffset": 133, "EndOffset": 136 }, { "Score": 0.9987268447875977, "Type": "DATE", "Text": "July 31st", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9858865737915039, "Type": "OTHER", "Text": "XXXXXX1111", "BeginOffset": 271, "EndOffset": 281 }, { "Score": 0.9700471758842468, "Type": "OTHER", "Text": "XXXXX0000", "BeginOffset": 306, "EndOffset": 315 }, { "Score": 0.9591118693351746, "Type": "ORGANIZATION", "Text": "Sunshine Spa", "BeginOffset": 340, "EndOffset": 352 }, { "Score": 0.9797496795654297, "Type": "LOCATION", "Text": "123 Main St", "BeginOffset": 354, "EndOffset": 365 }, { "Score": 0.994929313659668, "Type": "PERSON", "Text": "Alice", "BeginOffset": 394, "EndOffset": 399 }, { "Score": 0.9949769377708435, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 403, "EndOffset": 418 } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「[Entities] (エンティティ)」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DetectEntities」を参照してください。

次のコード例は、detect-key-phrases を使用する方法を示しています。

AWS CLI

入力テキスト内のキーフレーズを検出するには

次の detect-key-phrases の例では、入力テキストを分析し、主要な名詞フレーズを特定します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-key-phrases \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."

出力:

{ "KeyPhrases": [ { "Score": 0.8996376395225525, "Text": "Zhang Wei", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9992469549179077, "Text": "John", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.988385021686554, "Text": "Your AnyCompany Financial Services", "BeginOffset": 28, "EndOffset": 62 }, { "Score": 0.8740853071212769, "Text": "LLC credit card account 1111-XXXX-1111-XXXX", "BeginOffset": 64, "EndOffset": 107 }, { "Score": 0.9999437928199768, "Text": "a minimum payment", "BeginOffset": 112, "EndOffset": 129 }, { "Score": 0.9998900890350342, "Text": ".53", "BeginOffset": 133, "EndOffset": 136 }, { "Score": 0.9979453086853027, "Text": "July 31st", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9983011484146118, "Text": "your autopay settings", "BeginOffset": 172, "EndOffset": 193 }, { "Score": 0.9996572136878967, "Text": "your payment", "BeginOffset": 211, "EndOffset": 223 }, { "Score": 0.9995037317276001, "Text": "the due date", "BeginOffset": 227, "EndOffset": 239 }, { "Score": 0.9702621698379517, "Text": "your bank account number XXXXXX1111", "BeginOffset": 245, "EndOffset": 280 }, { "Score": 0.9179925918579102, "Text": "the routing number XXXXX0000.Customer feedback", "BeginOffset": 286, "EndOffset": 332 }, { "Score": 0.9978160858154297, "Text": "Sunshine Spa", "BeginOffset": 337, "EndOffset": 349 }, { "Score": 0.9706913232803345, "Text": "123 Main St", "BeginOffset": 351, "EndOffset": 362 }, { "Score": 0.9941995143890381, "Text": "comments", "BeginOffset": 379, "EndOffset": 387 }, { "Score": 0.9759287238121033, "Text": "Alice", "BeginOffset": 391, "EndOffset": 396 }, { "Score": 0.8376792669296265, "Text": "AnySpa@example.com", "BeginOffset": 400, "EndOffset": 415 } ] }

詳細については、「Amazon Comprehend 開発者ガイド」の「キーフレーズ」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DetectKeyPhrases」を参照してください。

次のコード例は、detect-pii-entities を使用する方法を示しています。

AWS CLI

入力テキストの PII エンティティを検出するには

次の detect-pii-entities の例では、入力テキストを分析し、個人を特定できる情報 (PII) を含むエンティティを特定します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-pii-entities \ --language-code en \ --text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \ account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \ we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \ Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."

出力:

{ "Entities": [ { "Score": 0.9998322129249573, "Type": "NAME", "BeginOffset": 6, "EndOffset": 15 }, { "Score": 0.9998878240585327, "Type": "NAME", "BeginOffset": 22, "EndOffset": 26 }, { "Score": 0.9994089603424072, "Type": "CREDIT_DEBIT_NUMBER", "BeginOffset": 88, "EndOffset": 107 }, { "Score": 0.9999760985374451, "Type": "DATE_TIME", "BeginOffset": 152, "EndOffset": 161 }, { "Score": 0.9999449253082275, "Type": "BANK_ACCOUNT_NUMBER", "BeginOffset": 271, "EndOffset": 281 }, { "Score": 0.9999847412109375, "Type": "BANK_ROUTING", "BeginOffset": 306, "EndOffset": 315 }, { "Score": 0.999925434589386, "Type": "ADDRESS", "BeginOffset": 354, "EndOffset": 365 }, { "Score": 0.9989161491394043, "Type": "NAME", "BeginOffset": 394, "EndOffset": 399 }, { "Score": 0.9994171857833862, "Type": "EMAIL", "BeginOffset": 403, "EndOffset": 418 } ] }

サポートされる PII エンティティタイプの一覧の詳細については、「Amazon Comprehend 開発者ガイド」の「個人を特定できる情報 (PII)」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「DetectPiiEntities」を参照してください。

次の例は、detect-sentiment を使用する方法を説明しています。

AWS CLI

入力テキストの感情を検出するには

次の detect-sentiment の例では、入力テキストを分析し、一般的な感情 (POSITIVENEUTRALMIXED、または NEGATIVE) の推論を返します。

aws comprehend detect-sentiment \ --language-code en \ --text "It is a beautiful day in Seattle"

出力:

{ "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9976957440376282, "Negative": 9.653854067437351e-05, "Neutral": 0.002169104292988777, "Mixed": 3.857641786453314e-05 } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「感情」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DetectSentiment」を参照してください。

次のコード例は、detect-syntax を使用する方法を示しています。

AWS CLI

入力テキスト内の品詞を検出するには

次の detect-syntax の例では、入力テキストの構文を分析し、さまざまな品詞を返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-syntax \ --language-code en \ --text "It is a beautiful day in Seattle."

出力:

{ "SyntaxTokens": [ { "TokenId": 1, "Text": "It", "BeginOffset": 0, "EndOffset": 2, "PartOfSpeech": { "Tag": "PRON", "Score": 0.9999740719795227 } }, { "TokenId": 2, "Text": "is", "BeginOffset": 3, "EndOffset": 5, "PartOfSpeech": { "Tag": "VERB", "Score": 0.999901294708252 } }, { "TokenId": 3, "Text": "a", "BeginOffset": 6, "EndOffset": 7, "PartOfSpeech": { "Tag": "DET", "Score": 0.9999938607215881 } }, { "TokenId": 4, "Text": "beautiful", "BeginOffset": 8, "EndOffset": 17, "PartOfSpeech": { "Tag": "ADJ", "Score": 0.9987351894378662 } }, { "TokenId": 5, "Text": "day", "BeginOffset": 18, "EndOffset": 21, "PartOfSpeech": { "Tag": "NOUN", "Score": 0.9999796748161316 } }, { "TokenId": 6, "Text": "in", "BeginOffset": 22, "EndOffset": 24, "PartOfSpeech": { "Tag": "ADP", "Score": 0.9998047947883606 } }, { "TokenId": 7, "Text": "Seattle", "BeginOffset": 25, "EndOffset": 32, "PartOfSpeech": { "Tag": "PROPN", "Score": 0.9940530061721802 } } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「構文分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DetectSyntax」を参照してください。

次の例は、detect-targeted-sentiment を使用する方法を説明しています。

AWS CLI

入力テキスト内の名前付きエンティティのターゲット感情を検出するには

次の detect-targeted-sentiment の例では、入力テキストを分析し、名前付きエンティティと、各エンティティに関連付けられたターゲット感情を返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。

aws comprehend detect-targeted-sentiment \ --language-code en \ --text "I do not enjoy January because it is too cold but August is the perfect temperature"

出力:

{ "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9999979734420776, "GroupScore": 1.0, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Positive": 0.0, "Negative": 0.0, "Neutral": 1.0, "Mixed": 0.0 } }, "BeginOffset": 0, "EndOffset": 1 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9638869762420654, "GroupScore": 1.0, "Text": "January", "Type": "DATE", "MentionSentiment": { "Sentiment": "NEGATIVE", "SentimentScore": { "Positive": 0.0031610000878572464, "Negative": 0.9967250227928162, "Neutral": 0.00011100000119768083, "Mixed": 1.9999999949504854e-06 } }, "BeginOffset": 15, "EndOffset": 22 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { { "Score": 0.9664419889450073, "GroupScore": 1.0, "Text": "August", "Type": "DATE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9999549984931946, "Negative": 3.999999989900971e-06, "Neutral": 4.099999932805076e-05, "Mixed": 0.0 } }, "BeginOffset": 50, "EndOffset": 56 } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "Score": 0.9803199768066406, "GroupScore": 1.0, "Text": "temperature", "Type": "ATTRIBUTE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 1.0, "Negative": 0.0, "Neutral": 0.0, "Mixed": 0.0 } }, "BeginOffset": 77, "EndOffset": 88 } ] } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Targeted Sentiment」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「DetectTargetedSentiment」を参照してください。

次の例は、import-model を使用する方法を説明しています。

AWS CLI

モデルをインポートするには

次の import-model の例では、別の AWS アカウントからモデルをインポートしています。アカウント 444455556666 のドキュメント分類子モデルには、アカウント 111122223333 がモデルをインポートできるようにするリソースベースのポリシーがあります。

aws comprehend import-model \ --source-model-arn arn:aws:comprehend:us-west-2:444455556666:document-classifier/example-classifier

出力:

{ "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Copying custom models between AWS accounts」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ImportModel」を参照してください。

次のコード例は、list-datasets を使用する方法を示しています。

AWS CLI

すべてのフライホイールデータセットを一覧表示するには

次の list-datasets の例では、フライホイールに関連付けられているすべてのデータセットを一覧表示しています。

aws comprehend list-datasets \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity

出力:

{ "DatasetPropertiesList": [ { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-1", "DatasetName": "example-dataset-1", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-1/20230616T203710Z/", "Status": "CREATING", "CreationTime": "2023-06-16T20:37:10.400000+00:00" }, { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-2", "DatasetName": "example-dataset-2", "DatasetType": "TRAIN", "DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-2/20230616T200607Z/", "Description": "TRAIN Dataset created by Flywheel creation.", "Status": "COMPLETED", "NumberOfDocuments": 5572, "CreationTime": "2023-06-16T20:06:07.722000+00:00" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListDatasets」を参照してください。

次のコード例は、list-document-classification-jobs を使用する方法を示しています。

AWS CLI

すべてのドキュメント分類ジョブを一覧表示するには

次の list-document-classification-jobs の例では、すべてのドキュメント分類ジョブを一覧表示しています。

aws comprehend list-document-classification-jobs

出力:

{ "DocumentClassificationJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "exampleclassificationjob", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:09:51.788000+00:00", "EndTime": "2023-06-14T17:15:58.582000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-e758dd56b824aa717ceab551f11749fb/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "exampleclassificationjob2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-14T17:22:39.829000+00:00", "EndTime": "2023-06-14T17:28:46.107000+00:00", "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/jobdata/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend 開発者ガイド」の「カスタム分類」を参照してください。

次の例は、list-document-classifier-summaries を使用する方法を説明しています。

AWS CLI

作成されたすべてのドキュメント分類子の概要を一覧表示するには

次の list-document-classifier-summaries の例では、作成されたすべてのドキュメント分類子の概要を一覧表示しています。

aws comprehend list-document-classifier-summaries

出力:

{ "DocumentClassifierSummariesList": [ { "DocumentClassifierName": "example-classifier-1", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-13T22:07:59.825000+00:00", "LatestVersionName": "1", "LatestVersionStatus": "TRAINED" }, { "DocumentClassifierName": "example-classifier-2", "NumberOfVersions": 2, "LatestVersionCreatedAt": "2023-06-13T21:54:59.589000+00:00", "LatestVersionName": "2", "LatestVersionStatus": "TRAINED" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタムモデルの作成と管理」を参照してください。

次の例は、list-document-classifiers を使用する方法を説明しています。

AWS CLI

すべてのドキュメント分類子を一覧表示するには

次の list-document-classifiers の例は、トレーニング済みおよびトレーニング中のすべてのドキュメント分類子モデルを一覧表示します。

aws comprehend list-document-classifiers

出力:

{ "DocumentClassifierPropertiesList": [ { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-13T19:04:15.735000+00:00", "EndTime": "2023-06-13T19:42:31.752000+00:00", "TrainingStartTime": "2023-06-13T19:08:20.114000+00:00", "TrainingEndTime": "2023-06-13T19:41:35.080000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "ClassifierMetadata": { "NumberOfLabels": 3, "NumberOfTrainedDocuments": 5016, "NumberOfTestDocuments": 557, "EvaluationMetrics": { "Accuracy": 0.9856, "Precision": 0.9919, "Recall": 0.9459, "F1Score": 0.9673, "MicroPrecision": 0.9856, "MicroRecall": 0.9856, "MicroF1Score": 0.9856, "HammingLoss": 0.0144 } }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle", "Mode": "MULTI_CLASS" }, { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "LanguageCode": "en", "Status": "TRAINING", "SubmitTime": "2023-06-13T21:20:28.690000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata" }, "OutputDataConfig": {}, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle", "Mode": "MULTI_CLASS" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタムモデルの作成と管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListDocumentClassifiers」を参照してください。

次の例は、list-dominant-language-detection-jobs を使用する方法を説明しています。

AWS CLI

すべての主要言語検出ジョブを一覧表示するには

次の list-dominant-language-detection-jobs の例では、進行中および完了したすべての非同期主要言語検出ジョブを一覧表示しています。

aws comprehend list-dominant-language-detection-jobs

出力:

{ "DominantLanguageDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T18:10:38.037000+00:00", "EndTime": "2023-06-09T18:18:45.498000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "languageanalysis2", "JobStatus": "STOPPED", "SubmitTime": "2023-06-09T18:16:33.690000+00:00", "EndTime": "2023-06-09T18:24:40.608000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、list-endpoints を使用する方法を説明しています。

AWS CLI

すべてのエンドポイントを一覧表示するには

次の list-endpoints の例では、すべてのアクティブなモデル固有のエンドポイントを一覧表示しています。

aws comprehend list-endpoints

出力:

{ "EndpointPropertiesList": [ { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint", "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" }, { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint2", "Status": "IN_SERVICE", "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2", "DesiredInferenceUnits": 1, "CurrentInferenceUnits": 1, "CreationTime": "2023-06-13T20:32:54.526000+00:00", "LastModifiedTime": "2023-06-13T20:32:54.526000+00:00" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEndpoints」を参照してください。

次の例は、list-entities-detection-jobs を使用する方法を説明しています。

AWS CLI

すべてのエンティティ検出ジョブを一覧表示するには

次の list-entities-detection-jobs の例では、すべての非同期エンティティ検出ジョブを一覧表示しています。

aws comprehend list-entities-detection-jobs

出力:

{ "EntitiesDetectionJobPropertiesList": [ { "JobId": "468af39c28ab45b83eb0c4ab9EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/468af39c28ab45b83eb0c4ab9EXAMPLE", "JobName": "example-entities-detection", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T20:57:46.476000+00:00", "EndTime": "2023-06-08T21:05:53.718000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-468af39c28ab45b83eb0c4ab9EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "809691caeaab0e71406f80a28EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/809691caeaab0e71406f80a28EXAMPLE", "JobName": "example-entities-detection-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T21:30:15.323000+00:00", "EndTime": "2023-06-08T21:40:23.509000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-809691caeaab0e71406f80a28EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "e00597c36b448b91d70dea165EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/e00597c36b448b91d70dea165EXAMPLE", "JobName": "example-entities-detection-3", "JobStatus": "STOPPED", "SubmitTime": "2023-06-08T22:19:28.528000+00:00", "EndTime": "2023-06-08T22:27:33.991000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-e00597c36b448b91d70dea165EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「[Entities] (エンティティ)」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEntitiesDetectionJobs」を参照してください。

次のコード例は、list-entity-recognizer-summaries を使用する方法を示しています。

AWS CLI

作成されたすべてのエンティティレコグナイザーの概要を一覧表示するには

次の list-entity-recognizer-summaries の例では、すべてのエンティティレコグナイザーの概要を一覧表示しています。

aws comprehend list-entity-recognizer-summaries

出力:

{ "EntityRecognizerSummariesList": [ { "RecognizerName": "entity-recognizer-3", "NumberOfVersions": 2, "LatestVersionCreatedAt": "2023-06-15T23:15:07.621000+00:00", "LatestVersionName": "2", "LatestVersionStatus": "STOP_REQUESTED" }, { "RecognizerName": "entity-recognizer-2", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-14T22:55:27.805000+00:00", "LatestVersionName": "2" "LatestVersionStatus": "TRAINED" }, { "RecognizerName": "entity-recognizer-1", "NumberOfVersions": 1, "LatestVersionCreatedAt": "2023-06-14T20:44:59.631000+00:00", "LatestVersionName": "1", "LatestVersionStatus": "TRAINED" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Custom entity recognition」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEntityRecognizerSummaries」を参照してください。

次のコード例は、list-entity-recognizers を使用する方法を示しています。

AWS CLI

すべてのカスタムエンティティレコグナイザーを一覧表示するには

次の list-entity-recognizers の例では、作成されたすべてのカスタムエンティティレコグナイザーを一覧表示しています。

aws comprehend list-entity-recognizers

出力:

{ "EntityRecognizerPropertiesList": [ { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/EntityRecognizer/version/1", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T20:44:59.631000+00:00", "EndTime": "2023-06-14T20:59:19.532000+00:00", "TrainingStartTime": "2023-06-14T20:48:52.811000+00:00", "TrainingEndTime": "2023-06-14T20:58:11.473000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "BUSINESS" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 1814, "NumberOfTestDocuments": 486, "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "EntityTypes": [ { "Type": "BUSINESS", "EvaluationMetrics": { "Precision": 100.0, "Recall": 100.0, "F1Score": 100.0 }, "NumberOfTrainMentions": 1520 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole", "VersionName": "1" }, { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer3", "LanguageCode": "en", "Status": "TRAINED", "SubmitTime": "2023-06-14T22:57:51.056000+00:00", "EndTime": "2023-06-14T23:14:13.894000+00:00", "TrainingStartTime": "2023-06-14T23:01:33.984000+00:00", "TrainingEndTime": "2023-06-14T23:13:02.984000+00:00", "InputDataConfig": { "DataFormat": "COMPREHEND_CSV", "EntityTypes": [ { "Type": "DEVICE" } ], "Documents": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/raw_txt.csv", "InputFormat": "ONE_DOC_PER_LINE" }, "EntityList": { "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv" } }, "RecognizerMetadata": { "NumberOfTrainedDocuments": 4616, "NumberOfTestDocuments": 3489, "EvaluationMetrics": { "Precision": 98.54227405247813, "Recall": 100.0, "F1Score": 99.26578560939794 }, "EntityTypes": [ { "Type": "DEVICE", "EvaluationMetrics": { "Precision": 98.54227405247813, "Recall": 100.0, "F1Score": 99.26578560939794 }, "NumberOfTrainMentions": 2764 } ] }, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Custom entity recognition」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEntityRecognizers」を参照してください。

次のコード例は、list-events-detection-jobs を使用する方法を示しています。

AWS CLI

すべてのイベント検出ジョブを一覧表示するには

次の list-events-detection-jobs の例では、すべての非同期イベント検出ジョブを一覧表示しています。

aws comprehend list-events-detection-jobs

出力:

{ "EventsDetectionJobPropertiesList": [ { "JobId": "aa9593f9203e84f3ef032ce18EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/aa9593f9203e84f3ef032ce18EXAMPLE", "JobName": "events_job_1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-12T19:14:57.751000+00:00", "EndTime": "2023-06-12T19:21:04.962000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-aa9593f9203e84f3ef032ce18EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] }, { "JobId": "4a990a2f7e82adfca6e171135EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/4a990a2f7e82adfca6e171135EXAMPLE", "JobName": "events_job_2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-12T19:55:43.702000+00:00", "EndTime": "2023-06-12T20:03:49.893000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-4a990a2f7e82adfca6e171135EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role", "TargetEventTypes": [ "BANKRUPTCY", "EMPLOYMENT", "CORPORATE_ACQUISITION", "CORPORATE_MERGER", "INVESTMENT_GENERAL" ] } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListEventsDetectionJobs」を参照してください。

次のコード例は、list-flywheel-iteration-history を使用する方法を示しています。

AWS CLI

すべてのフライホイールイテレーション履歴を一覧表示するには

次の list-flywheel-iteration-history の例では、すべてのフライホイールイテレーションを一覧表示しています。

aws comprehend list-flywheel-iteration-history --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel

出力:

{ "FlywheelIterationPropertiesList": [ { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "FlywheelIterationId": "20230619TEXAMPLE", "CreationTime": "2023-06-19T04:00:32.594000+00:00", "EndTime": "2023-06-19T04:00:49.248000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AverageF1Score": 0.9876464664646313, "AveragePrecision": 0.9800000253081214, "AverageRecall": 0.9445600253081214, "AverageAccuracy": 0.9997281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230619TEXAMPLE/evaluation/20230619TEXAMPLE/" }, { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2", "FlywheelIterationId": "20230616TEXAMPLE", "CreationTime": "2023-06-16T21:10:26.385000+00:00", "EndTime": "2023-06-16T23:33:16.827000+00:00", "Status": "COMPLETED", "Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.", "EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/spamvshamclassify/version/1", "EvaluatedModelMetrics": { "AverageF1Score": 0.7742663922375772, "AverageF1Score": 0.9767700253081214, "AveragePrecision": 0.9767700253081214, "AverageRecall": 0.9767700253081214, "AverageAccuracy": 0.9858281665190434 }, "EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20230616TEXAMPLE/evaluation/20230616TEXAMPLE/" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListFlywheelIterationHistory」を参照してください。

次の例は、list-flywheels を使用する方法を説明しています。

AWS CLI

すべてのフライホイールを一覧表示するには

次の list-flywheels の例では、作成されたすべてのフライホイールを一覧表示しています。

aws comprehend list-flywheels

出力:

{ "FlywheelSummaryList": [ { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier/version/1", "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-1/schemaVersion=1/20230616T200543Z/", "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20230619T040032Z" }, { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2/version/1", "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20220616T200543Z/", "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2022-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2022-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20220619T040032Z" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListFlywheels」を参照してください。

次の例は、list-key-phrases-detection-jobs を使用する方法を説明しています。

AWS CLI

すべてのキーフレーズ検出ジョブを一覧表示するには

次の list-key-phrases-detection-jobs の例では、進行中および完了したすべての非同期キーフレーズ検出ジョブを一覧表示しています。

aws comprehend list-key-phrases-detection-jobs

出力:

{ "KeyPhrasesDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "keyphrasesanalysis1", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-08T22:31:43.767000+00:00", "EndTime": "2023-06-08T22:39:52.565000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a33EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a33EXAMPLE", "JobName": "keyphrasesanalysis2", "JobStatus": "STOPPED", "SubmitTime": "2023-06-08T22:57:52.154000+00:00", "EndTime": "2023-06-08T23:05:48.385000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a33EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a44EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a44EXAMPLE", "JobName": "keyphrasesanalysis3", "JobStatus": "FAILED", "Message": "NO_READ_ACCESS_TO_INPUT: The provided data access role does not have proper access to the input data.", "SubmitTime": "2023-06-09T16:47:04.029000+00:00", "EndTime": "2023-06-09T16:47:18.413000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a44EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListKeyPhrasesDetectionJobs」を参照してください。

次のコード例は、list-pii-entities-detection-jobs を使用する方法を示しています。

AWS CLI

すべての PII エンティティ検出ジョブを一覧表示するには

次の list-pii-entities-detection-jobs の例では、進行中および完了したすべての非同期 PII 検出ジョブを一覧表示しています。

aws comprehend list-pii-entities-detection-jobs

出力:

{ "PiiEntitiesDetectionJobPropertiesList": [ { "JobId": "6f9db0c42d0c810e814670ee4EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/6f9db0c42d0c810e814670ee4EXAMPLE", "JobName": "example-pii-detection-job", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T21:02:46.241000+00:00", "EndTime": "2023-06-09T21:12:52.602000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-source-bucket/111122223333-PII-6f9db0c42d0c810e814670ee4EXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "ONLY_OFFSETS" }, { "JobId": "d927562638cfa739331a99b3cEXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/d927562638cfa739331a99b3cEXAMPLE", "JobName": "example-pii-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T21:20:58.211000+00:00", "EndTime": "2023-06-09T21:31:06.027000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-PII-d927562638cfa739331a99b3cEXAMPLE/output/" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "Mode": "ONLY_OFFSETS" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListPiiEntitiesDetectionJobs」を参照してください。

次の例は、list-sentiment-detection-jobs を使用する方法を説明しています。

AWS CLI

すべての感情検出ジョブを一覧表示するには

次の list-sentiment-detection-jobs の例では、進行中および完了したすべての非同期感情検出ジョブを一覧表示しています。

aws comprehend list-sentiment-detection-jobs

出力:

{ "SentimentDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-sentiment-detection-job", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T22:42:20.545000+00:00", "EndTime": "2023-06-09T22:52:27.416000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "example-sentiment-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "EndTime": "2023-06-09T23:26:00.168000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData2", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListSentimentDetectionJobs」を参照してください。

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

リソースのタグを一覧表示するには

次の list-tags-for-resource の例では、Amazon Comprehend リソースのタグを一覧表示しています。

aws comprehend list-tags-for-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1

出力:

{ "ResourceArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "Tags": [ { "Key": "Department", "Value": "Finance" }, { "Key": "location", "Value": "Seattle" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Tagging your resources」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource」を参照してください。

次のコード例は、list-targeted-sentiment-detection-jobs を使用する方法を示しています。

AWS CLI

すべてのターゲット感情検出ジョブを一覧表示するには

次の list-targeted-sentiment-detection-jobs の例では、進行中および完了したすべての非同期ターゲット感情検出ジョブを一覧表示しています。

aws comprehend list-targeted-sentiment-detection-jobs

出力:

{ "TargetedSentimentDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName": "example-targeted-sentiment-detection-job", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T22:42:20.545000+00:00", "EndTime": "2023-06-09T22:52:27.416000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "example-targeted-sentiment-detection-job-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T23:16:15.956000+00:00", "EndTime": "2023-06-09T23:26:00.168000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/MovieData2", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "LanguageCode": "en", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、list-topics-detection-jobs を使用する方法を説明しています。

AWS CLI

トピック検出ジョブをすべて一覧表示するには

次の list-topics-detection-jobs の例では、進行中および完了した非同期トピック検出ジョブをすべて一覧表示します。

aws comprehend list-topics-detection-jobs

出力:

{ "TopicsDetectionJobPropertiesList": [ { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobName" "topic-analysis-1" "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:40:35.384000+00:00", "EndTime": "2023-06-09T18:46:41.936000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE2", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE2", "JobName": "topic-analysis-2", "JobStatus": "COMPLETED", "SubmitTime": "2023-06-09T18:44:43.414000+00:00", "EndTime": "2023-06-09T18:50:50.872000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" }, { "JobId": "123456abcdeb0e11022f22a1EXAMPLE3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE3", "JobName": "topic-analysis-2", "JobStatus": "IN_PROGRESS", "SubmitTime": "2023-06-09T18:50:56.737000+00:00", "InputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket", "InputFormat": "ONE_DOC_PER_LINE" }, "OutputDataConfig": { "S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE3/output/output.tar.gz" }, "NumberOfTopics": 10, "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" } ] }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「ListTopicsDetectionJobs」を参照してください。

次のコード例は、put-resource-policy を使用する方法を示しています。

AWS CLI

リソースベースのポリシーをアタッチするには

次の put-resource-policy の例では、リソースベースのポリシーをモデルにアタッチして、別の AWS アカウントでインポートできるようにしています。ポリシーがアカウント 111122223333 のモデルにアタッチされ、アカウント 444455556666 がモデルをインポートできます。

aws comprehend put-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \ --resource-policy '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Action":"comprehend:ImportModel","Resource":"*","Principal":{"AWS":["arn:aws:iam::444455556666:root"]}}]}'

出力:

{ "PolicyRevisionId": "aaa111d069d07afaa2aa3106aEXAMPLE" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Copying custom models between AWS accounts」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「PutResourcePolicy」を参照してください。

次のコード例は、start-document-classification-job を使用する方法を示しています。

AWS CLI

ドキュメント分類ジョブを開始するには

次の start-document-classification-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して、カスタムモデルを使用してドキュメント分類ジョブを開始します。この例では、入力 S3 バケットには、SampleSMStext1.txtSampleSMStext2.txtSampleSMStext3.txt が含まれています。このモデルは以前、迷惑メールと迷惑メールでない正規のメール、または SMS メッセージにドキュメントを分類するトレーニングを受けていました。ジョブが完了すると、output.tar.gz--output-data-config タグで指定された場所に配置されます。output.tar.gz には各ドキュメントの分類を一覧表示する predictions.jsonl が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-document-classification-job \ --job-name exampleclassificationjob \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket-INPUT/jobdata/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/12

SampleSMStext1.txt の内容:

"CONGRATULATIONS! TXT 2155550100 to win $5000"

SampleSMStext2.txt の内容:

"Hi, when do you want me to pick you up from practice?"

SampleSMStext3.txt の内容:

"Plz send bank account # to 2155550100 to claim prize!!"

出力:

{ "JobId": "e758dd56b824aa717ceab551fEXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/e758dd56b824aa717ceab551fEXAMPLE", "JobStatus": "SUBMITTED" }

predictions.jsonl の内容:

{"File": "SampleSMSText1.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]} {"File": "SampleSMStext2.txt", "Line": "0", "Classes": [{"Name": "ham", "Score": 0.9994}, {"Name": "spam", "Score": 0.0006}]} {"File": "SampleSMSText3.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]}

詳細については、「Amazon Comprehend 開発者ガイド」の「カスタム分類」を参照してください。

次の例は、start-dominant-language-detection-job を使用する方法を説明しています。

AWS CLI

非同期言語検出ジョブを開始するには

次の start-dominant-language-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期言語検出ジョブを開始します。この例の S3 バケットには Sampletext1.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには output.txt が含まれており、これには各テキストファイルの主要言語と、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。

aws comprehend start-dominant-language-detection-job \ --job-name example_language_analysis_job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en

Sampletext1.txt の内容:

"Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force."

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

output.txt の内容:

{"File": "Sampletext1.txt", "Languages": [{"LanguageCode": "en", "Score": 0.9913753867149353}], "Line": 0}

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、start-entities-detection-job を使用する方法を説明しています。

AWS CLI

例 1: 事前トレーニング済みモデルを使用して標準エンティティ検出ジョブを開始するには

次の start-entities-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期エンティティ検出ジョブを開始します。この例の S3 バケットには Sampletext1.txtSampletext2.txtSampletext3.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには output.txt が含まれており、これには各テキストファイル内で検出されたすべての名前付きエンティティと、予測ごとの事前トレーニング済みモデルの信頼スコアが一覧表示されています。Json の出力は、入力ファイルごとに 1 行に出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-entities-detection-job \ --job-name entitiestest \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en

Sampletext1.txt の内容:

"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."

Sampletext2.txt の内容:

"Dear Max, based on your autopay settings for your account example1.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "

Sampletext3.txt の内容:

"Jane, please submit any customer feedback from this weekend to AnySpa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた output.txt の内容:

{ "Entities": [ { "BeginOffset": 6, "EndOffset": 15, "Score": 0.9994006636420306, "Text": "Zhang Wei", "Type": "PERSON" }, { "BeginOffset": 22, "EndOffset": 26, "Score": 0.9976647915128143, "Text": "John", "Type": "PERSON" }, { "BeginOffset": 33, "EndOffset": 67, "Score": 0.9984608700836206, "Text": "AnyCompany Financial Services, LLC", "Type": "ORGANIZATION" }, { "BeginOffset": 88, "EndOffset": 107, "Score": 0.9868521019555556, "Text": "1111-XXXX-1111-XXXX", "Type": "OTHER" }, { "BeginOffset": 133, "EndOffset": 139, "Score": 0.998242565709204, "Text": "$24.53", "Type": "QUANTITY" }, { "BeginOffset": 155, "EndOffset": 164, "Score": 0.9993039263159287, "Text": "July 31st", "Type": "DATE" } ], "File": "SampleText1.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 5, "EndOffset": 8, "Score": 0.9866232147545232, "Text": "Max", "Type": "PERSON" }, { "BeginOffset": 156, "EndOffset": 166, "Score": 0.9797723450933329, "Text": "XXXXXX1111", "Type": "OTHER" }, { "BeginOffset": 191, "EndOffset": 200, "Score": 0.9247838572396843, "Text": "XXXXX0000", "Type": "OTHER" } ], "File": "SampleText2.txt", "Line": 0 } { "Entities": [ { "Score": 0.9990532994270325, "Type": "PERSON", "Text": "Jane", "BeginOffset": 0, "EndOffset": 4 }, { "Score": 0.9519651532173157, "Type": "DATE", "Text": "this weekend", "BeginOffset": 47, "EndOffset": 59 }, { "Score": 0.5566426515579224, "Type": "ORGANIZATION", "Text": "AnySpa", "BeginOffset": 63, "EndOffset": 69 }, { "Score": 0.8059805631637573, "Type": "LOCATION", "Text": "123 Main St, Anywhere", "BeginOffset": 71, "EndOffset": 92 }, { "Score": 0.998830258846283, "Type": "PERSON", "Text": "Alice", "BeginOffset": 114, "EndOffset": 119 }, { "Score": 0.997818112373352, "Type": "OTHER", "Text": "AnySpa@example.com", "BeginOffset": 123, "EndOffset": 138 } ], "File": "SampleText3.txt", "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

例 2: カスタムエンティティ検出ジョブを開始するには

次の start-entities-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期カスタムエンティティ検出ジョブを開始します。この例では、S3 バケットに SampleFeedback1.txtSampleFeedback2.txtSampleFeedback3.txt が含まれています。エンティティレコグナイザーモデルは、デバイス名を認識するためにカスタマーサポートフィードバックでトレーニングされました。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには output.txt が含まれており、これには各テキストファイル内で検出されたすべての名前付きエンティティと、予測ごとの事前トレーニング済みモデルの信頼スコアが一覧表示されています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-entities-detection-job \ --job-name customentitiestest \ --entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer" \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/jobdata/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole"

SampleFeedback1.txt の内容:

"I've been on the AnyPhone app have had issues for 24 hours when trying to pay bill. Cannot make payment. Sigh. | Oh man! Lets get that app up and running. DM me, and we can get to work!"

SampleFeedback2.txt の内容:

"Hi, I have a discrepancy with my new bill. Could we get it sorted out? A rep added stuff I didnt sign up for when I did my AnyPhone 10 upgrade. | We can absolutely get this sorted!"

SampleFeedback3.txt の内容:

"Is the by 1 get 1 free AnySmartPhone promo still going on? | Hi Christian! It ended yesterday, send us a DM if you have any questions and we can take a look at your options!"

出力:

{ "JobId": "019ea9edac758806850fa8a79ff83021", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/019ea9edac758806850fa8a79ff83021", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた output.txt の内容:

{ "Entities": [ { "BeginOffset": 17, "EndOffset": 25, "Score": 0.9999728210205924, "Text": "AnyPhone", "Type": "DEVICE" } ], "File": "SampleFeedback1.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 123, "EndOffset": 133, "Score": 0.9999892116761524, "Text": "AnyPhone 10", "Type": "DEVICE" } ], "File": "SampleFeedback2.txt", "Line": 0 } { "Entities": [ { "BeginOffset": 23, "EndOffset": 35, "Score": 0.9999971389852362, "Text": "AnySmartPhone", "Type": "DEVICE" } ], "File": "SampleFeedback3.txt", "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Custom entity recognition」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartEntitiesDetectionJob」を参照してください。

次の例は、start-events-detection-job を使用する方法を説明しています。

AWS CLI

非同期イベント検出ジョブを開始するには

次の start-events-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期イベント検出ジョブを開始します。考えられるターゲットイベントタイプには、BANKRUPCTYEMPLOYMENTCORPORATE_ACQUISITIONINVESTMENT_GENERALCORPORATE_MERGERIPORIGHTS_ISSUESECONDARY_OFFERINGSHELF_OFFERINGTENDER_OFFERINGSTOCK_SPLIT があります。この例の S3 バケットには SampleText1.txtSampleText2.txtSampleText3.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには SampleText1.txt.outSampleText2.txt.outSampleText3.txt.out が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-events-detection-job \ --job-name events-detection-1 \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/EventsData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole \ --language-code en \ --target-event-types "BANKRUPTCY" "EMPLOYMENT" "CORPORATE_ACQUISITION" "CORPORATE_MERGER" "INVESTMENT_GENERAL"

SampleText1.txt の内容:

"Company AnyCompany grew by increasing sales and through acquisitions. After purchasing competing firms in 2020, AnyBusiness, a part of the AnyBusinessGroup, gave Jane Does firm a going rate of one cent a gallon or forty-two cents a barrel."

SampleText2.txt の内容:

"In 2021, AnyCompany officially purchased AnyBusiness for 100 billion dollars, surprising and exciting the shareholders."

SampleText3.txt の内容:

"In 2022, AnyCompany stock crashed 50. Eventually later that year they filed for bankruptcy."

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた SampleText1.txt.out の内容:

{ "Entities": [ { "Mentions": [ { "BeginOffset": 8, "EndOffset": 18, "Score": 0.99977, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 }, { "BeginOffset": 112, "EndOffset": 123, "Score": 0.999747, "Text": "AnyBusiness", "Type": "ORGANIZATION", "GroupScore": 0.979826 }, { "BeginOffset": 171, "EndOffset": 175, "Score": 0.999615, "Text": "firm", "Type": "ORGANIZATION", "GroupScore": 0.871647 } ] }, { "Mentions": [ { "BeginOffset": 97, "EndOffset": 102, "Score": 0.987687, "Text": "firms", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 103, "EndOffset": 110, "Score": 0.999458, "Text": "in 2020", "Type": "DATE", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 160, "EndOffset": 168, "Score": 0.999649, "Text": "John Doe", "Type": "PERSON", "GroupScore": 1 } ] } ], "Events": [ { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 0, "Role": "INVESTOR", "Score": 0.99977 } ], "Triggers": [ { "BeginOffset": 56, "EndOffset": 68, "Score": 0.999967, "Text": "acquisitions", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] }, { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 1, "Role": "INVESTEE", "Score": 0.987687 }, { "EntityIndex": 2, "Role": "DATE", "Score": 0.999458 }, { "EntityIndex": 3, "Role": "INVESTOR", "Score": 0.999649 } ], "Triggers": [ { "BeginOffset": 76, "EndOffset": 86, "Score": 0.999973, "Text": "purchasing", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] } ], "File": "SampleText1.txt", "Line": 0 }

SampleText2.txt.out の内容:

{ "Entities": [ { "Mentions": [ { "BeginOffset": 0, "EndOffset": 7, "Score": 0.999473, "Text": "In 2021", "Type": "DATE", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 9, "EndOffset": 19, "Score": 0.999636, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 45, "EndOffset": 56, "Score": 0.999712, "Text": "AnyBusiness", "Type": "ORGANIZATION", "GroupScore": 1 } ] }, { "Mentions": [ { "BeginOffset": 61, "EndOffset": 80, "Score": 0.998886, "Text": "100 billion dollars", "Type": "MONETARY_VALUE", "GroupScore": 1 } ] } ], "Events": [ { "Type": "CORPORATE_ACQUISITION", "Arguments": [ { "EntityIndex": 3, "Role": "AMOUNT", "Score": 0.998886 }, { "EntityIndex": 2, "Role": "INVESTEE", "Score": 0.999712 }, { "EntityIndex": 0, "Role": "DATE", "Score": 0.999473 }, { "EntityIndex": 1, "Role": "INVESTOR", "Score": 0.999636 } ], "Triggers": [ { "BeginOffset": 31, "EndOffset": 40, "Score": 0.99995, "Text": "purchased", "Type": "CORPORATE_ACQUISITION", "GroupScore": 1 } ] } ], "File": "SampleText2.txt", "Line": 0 }

SampleText3.txt.out の内容:

{ "Entities": [ { "Mentions": [ { "BeginOffset": 9, "EndOffset": 19, "Score": 0.999774, "Text": "AnyCompany", "Type": "ORGANIZATION", "GroupScore": 1 }, { "BeginOffset": 66, "EndOffset": 70, "Score": 0.995717, "Text": "they", "Type": "ORGANIZATION", "GroupScore": 0.997626 } ] }, { "Mentions": [ { "BeginOffset": 50, "EndOffset": 65, "Score": 0.999656, "Text": "later that year", "Type": "DATE", "GroupScore": 1 } ] } ], "Events": [ { "Type": "BANKRUPTCY", "Arguments": [ { "EntityIndex": 1, "Role": "DATE", "Score": 0.999656 }, { "EntityIndex": 0, "Role": "FILER", "Score": 0.995717 } ], "Triggers": [ { "BeginOffset": 81, "EndOffset": 91, "Score": 0.999936, "Text": "bankruptcy", "Type": "BANKRUPTCY", "GroupScore": 1 } ] } ], "File": "SampleText3.txt", "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartEventsDetectionJob」を参照してください。

次の例は、start-flywheel-iteration を使用する方法を説明しています。

AWS CLI

フライホイールイテレーションを開始するには

次の start-flywheel-iteration の例では、フライホイールイテレーションを開始しています。このオペレーションでは、フライホイール内の新しいデータセットを使用して、新しいモデルバージョンをトレーニングしています。

aws comprehend start-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel

出力:

{ "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "FlywheelIterationId": "12345123TEXAMPLE" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartFlywheelIteration」を参照してください。

次のコード例は、start-key-phrases-detection-job を使用する方法を示しています。

AWS CLI

キーフレーズ検出ジョブを開始するには

次の start-key-phrases-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期キーフレーズ検出ジョブを開始しています。この例の S3 バケットには Sampletext1.txtSampletext2.txtSampletext3.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには output.txt ファイルが含まれており、これには各テキストファイル内で検出されたすべてのキーフレーズと、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-key-phrases-detection-job \ --job-name keyphrasesanalysistest1 \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" \ --language-code en

Sampletext1.txt の内容:

"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."

Sampletext2.txt の内容:

"Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "

Sampletext3.txt の内容:

"Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた output.txt の内容:

{ "File": "SampleText1.txt", "KeyPhrases": [ { "BeginOffset": 6, "EndOffset": 15, "Score": 0.9748965572679326, "Text": "Zhang Wei" }, { "BeginOffset": 22, "EndOffset": 26, "Score": 0.9997344722354619, "Text": "John" }, { "BeginOffset": 28, "EndOffset": 62, "Score": 0.9843791074032948, "Text": "Your AnyCompany Financial Services" }, { "BeginOffset": 64, "EndOffset": 107, "Score": 0.8976122401721824, "Text": "LLC credit card account 1111-XXXX-1111-XXXX" }, { "BeginOffset": 112, "EndOffset": 129, "Score": 0.9999612982629748, "Text": "a minimum payment" }, { "BeginOffset": 133, "EndOffset": 139, "Score": 0.99975728947036, "Text": "$24.53" }, { "BeginOffset": 155, "EndOffset": 164, "Score": 0.9940866241449973, "Text": "July 31st" } ], "Line": 0 } { "File": "SampleText2.txt", "KeyPhrases": [ { "BeginOffset": 0, "EndOffset": 8, "Score": 0.9974021100118472, "Text": "Dear Max" }, { "BeginOffset": 19, "EndOffset": 40, "Score": 0.9961120519515884, "Text": "your autopay settings" }, { "BeginOffset": 45, "EndOffset": 78, "Score": 0.9980620070116009, "Text": "your account Internet.org account" }, { "BeginOffset": 97, "EndOffset": 109, "Score": 0.999919660140754, "Text": "your payment" }, { "BeginOffset": 113, "EndOffset": 125, "Score": 0.9998370719754205, "Text": "the due date" }, { "BeginOffset": 131, "EndOffset": 166, "Score": 0.9955068678502509, "Text": "your bank account number XXXXXX1111" }, { "BeginOffset": 172, "EndOffset": 200, "Score": 0.8653433315829526, "Text": "the routing number XXXXX0000" } ], "Line": 0 } { "File": "SampleText3.txt", "KeyPhrases": [ { "BeginOffset": 0, "EndOffset": 4, "Score": 0.9142947833681668, "Text": "Jane" }, { "BeginOffset": 20, "EndOffset": 41, "Score": 0.9984325676596763, "Text": "any customer feedback" }, { "BeginOffset": 47, "EndOffset": 59, "Score": 0.9998782448150636, "Text": "this weekend" }, { "BeginOffset": 63, "EndOffset": 75, "Score": 0.99866741830757, "Text": "Sunshine Spa" }, { "BeginOffset": 77, "EndOffset": 88, "Score": 0.9695803485466054, "Text": "123 Main St" }, { "BeginOffset": 108, "EndOffset": 116, "Score": 0.9997065928550928, "Text": "comments" }, { "BeginOffset": 120, "EndOffset": 125, "Score": 0.9993466833825161, "Text": "Alice" }, { "BeginOffset": 129, "EndOffset": 144, "Score": 0.9654563612885667, "Text": "AnySpa@example.com" } ], "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartKeyPhrasesDetectionJob」を参照してください。

次の例は、start-pii-entities-detection-job を使用する方法を説明しています。

AWS CLI

非同期 PII 検出ジョブを開始するには

次の start-pii-entities-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期の個人を特定できる情報 (PII) エンティティ検出ジョブを開始します。この例の S3 バケットには Sampletext1.txtSampletext2.txtSampletext3.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには、各テキストファイル内の名前付きエンティティを一覧表示している SampleText1.txt.outSampleText2.txt.outSampleText3.txt.out が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-pii-entities-detection-job \ --job-name entities_test \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en \ --mode ONLY_OFFSETS

Sampletext1.txt の内容:

"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."

Sampletext2.txt の内容:

"Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "

Sampletext3.txt の内容:

"Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた SampleText1.txt.out の内容:

{ "Entities": [ { "BeginOffset": 6, "EndOffset": 15, "Type": "NAME", "Score": 0.9998490510222595 }, { "BeginOffset": 22, "EndOffset": 26, "Type": "NAME", "Score": 0.9998937958019426 }, { "BeginOffset": 88, "EndOffset": 107, "Type": "CREDIT_DEBIT_NUMBER", "Score": 0.9554297245278491 }, { "BeginOffset": 155, "EndOffset": 164, "Type": "DATE_TIME", "Score": 0.9999720462925257 } ], "File": "SampleText1.txt", "Line": 0 }

読みやすいように行にインデントを加えた SampleText2.txt.out の内容:

{ "Entities": [ { "BeginOffset": 5, "EndOffset": 8, "Type": "NAME", "Score": 0.9994390774924007 }, { "BeginOffset": 58, "EndOffset": 70, "Type": "URL", "Score": 0.9999958276922101 }, { "BeginOffset": 156, "EndOffset": 166, "Type": "BANK_ACCOUNT_NUMBER", "Score": 0.9999721058045592 }, { "BeginOffset": 191, "EndOffset": 200, "Type": "BANK_ROUTING", "Score": 0.9998968945989909 } ], "File": "SampleText2.txt", "Line": 0 }

読みやすいように行にインデントを加えた SampleText3.txt.out の内容:

{ "Entities": [ { "BeginOffset": 0, "EndOffset": 4, "Type": "NAME", "Score": 0.999949934606805 }, { "BeginOffset": 77, "EndOffset": 88, "Type": "ADDRESS", "Score": 0.9999035300466904 }, { "BeginOffset": 120, "EndOffset": 125, "Type": "NAME", "Score": 0.9998203838716296 }, { "BeginOffset": 129, "EndOffset": 144, "Type": "EMAIL", "Score": 0.9998313473105228 } ], "File": "SampleText3.txt", "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartPiiEntitiesDetectionJob」を参照してください。

次の例は、start-sentiment-detection-job を使用する方法を説明しています。

AWS CLI

非同期感情分析ジョブを開始するには

次の start-sentiment-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期感情分析検出ジョブを開始します。この例の S3 バケットフォルダには SampleMovieReview1.txtSampleMovieReview2.txtSampleMovieReview3.txt が含まれています。ジョブが完了すると、output フォルダが --output-data-config タグで指定された場所に配置されます。フォルダには output.txt ファイルが含まれており、これには各テキストファイルの一般的な感情と、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。

aws comprehend start-sentiment-detection-job \ --job-name example-sentiment-detection-job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role

SampleMovieReview1.txt の内容:

"The film, AnyMovie2, is fairly predictable and just okay."

SampleMovieReview2.txt の内容:

"AnyMovie2 is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie."

SampleMovieReview3.txt の内容:

"Don't get fooled by the 'awards' for AnyMovie2. All parts of the film were poorly stolen from other modern directors."

出力:

{ "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた output.txt の内容:

{ "File": "SampleMovieReview1.txt", "Line": 0, "Sentiment": "MIXED", "SentimentScore": { "Mixed": 0.6591159105300903, "Negative": 0.26492202281951904, "Neutral": 0.035430654883384705, "Positive": 0.04053137078881264 } } { "File": "SampleMovieReview2.txt", "Line": 0, "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.000008718466233403888, "Negative": 0.00006134175055194646, "Neutral": 0.0002941041602753103, "Positive": 0.9996358156204224 } } { "File": "SampleMovieReview3.txt", "Line": 0, "Sentiment": "NEGATIVE", "SentimentScore": { "Mixed": 0.004146667663007975, "Negative": 0.9645107984542847, "Neutral": 0.016559595242142677, "Positive": 0.014782938174903393 } } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartSentimentDetectionJob」を参照してください。

次の例は、start-targeted-sentiment-detection-job を使用する方法を説明しています。

AWS CLI

非同期ターゲット感情分析ジョブを開始するには

次の start-targeted-sentiment-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルに対して非同期ターゲット感情分析検出ジョブを開始しています。この例の S3 バケットフォルダには SampleMovieReview1.txtSampleMovieReview2.txtSampleMovieReview3.txt が含まれています。ジョブが完了すると、output.tar.gz--output-data-config タグで指定された場所に配置されます。output.tar.gz には、ファイル SampleMovieReview1.txt.outSampleMovieReview2.txt.outSampleMovieReview3.txt.out が含まれており、それぞれには 1 つの入力テキストファイルの名前付きエンティティと関連する感情がすべて含まれています。

aws comprehend start-targeted-sentiment-detection-job \ --job-name targeted_movie_review_analysis1 \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role

SampleMovieReview1.txt の内容:

"The film, AnyMovie, is fairly predictable and just okay."

SampleMovieReview2.txt の内容:

"AnyMovie is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie."

SampleMovieReview3.txt の内容:

"Don't get fooled by the 'awards' for AnyMovie. All parts of the film were poorly stolen from other modern directors."

出力:

{ "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" }

読みやすいように行にインデントを加えた SampleMovieReview1.txt.out の内容:

{ "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 4, "EndOffset": 8, "Score": 0.994972, "GroupScore": 1, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 10, "EndOffset": 18, "Score": 0.631368, "GroupScore": 1, "Text": "AnyMovie", "Type": "ORGANIZATION", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.001729, "Negative": 0.000001, "Neutral": 0.000318, "Positive": 0.997952 } } } ] } ], "File": "SampleMovieReview1.txt", "Line": 0 }

読みやすいように行にインデントを加えた SampleMovieReview2.txt.out の内容:

{ "Entities": [ { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 0, "EndOffset": 8, "Score": 0.854024, "GroupScore": 1, "Text": "AnyMovie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0.000007, "Positive": 0.999993 } } }, { "BeginOffset": 104, "EndOffset": 109, "Score": 0.999129, "GroupScore": 0.502937, "Text": "movie", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0, "Positive": 1 } } }, { "BeginOffset": 33, "EndOffset": 37, "Score": 0.999823, "GroupScore": 0.999252, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 0.000001, "Positive": 0.999999 } } } ] }, { "DescriptiveMentionIndex": [ 0, 1, 2 ], "Mentions": [ { "BeginOffset": 43, "EndOffset": 44, "Score": 0.999997, "GroupScore": 1, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } }, { "BeginOffset": 80, "EndOffset": 81, "Score": 0.999996, "GroupScore": 0.52523, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } }, { "BeginOffset": 67, "EndOffset": 68, "Score": 0.999994, "GroupScore": 0.999499, "Text": "I", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 75, "EndOffset": 78, "Score": 0.999978, "GroupScore": 1, "Text": "kid", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] } ], "File": "SampleMovieReview2.txt", "Line": 0 }

読みやすいように行にインデントを加えた SampleMovieReview3.txt.out の内容:

{ "Entities": [ { "DescriptiveMentionIndex": [ 1 ], "Mentions": [ { "BeginOffset": 64, "EndOffset": 68, "Score": 0.992953, "GroupScore": 0.999814, "Text": "film", "Type": "MOVIE", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0.000004, "Negative": 0.010425, "Neutral": 0.989543, "Positive": 0.000027 } } }, { "BeginOffset": 37, "EndOffset": 45, "Score": 0.999782, "GroupScore": 1, "Text": "AnyMovie", "Type": "ORGANIZATION", "MentionSentiment": { "Sentiment": "POSITIVE", "SentimentScore": { "Mixed": 0.000095, "Negative": 0.039847, "Neutral": 0.000673, "Positive": 0.959384 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 47, "EndOffset": 50, "Score": 0.999991, "GroupScore": 1, "Text": "All", "Type": "QUANTITY", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0.000001, "Negative": 0.000001, "Neutral": 0.999998, "Positive": 0 } } } ] }, { "DescriptiveMentionIndex": [ 0 ], "Mentions": [ { "BeginOffset": 106, "EndOffset": 115, "Score": 0.542083, "GroupScore": 1, "Text": "directors", "Type": "PERSON", "MentionSentiment": { "Sentiment": "NEUTRAL", "SentimentScore": { "Mixed": 0, "Negative": 0, "Neutral": 1, "Positive": 0 } } } ] } ], "File": "SampleMovieReview3.txt", "Line": 0 }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次の例は、start-topics-detection-job を使用する方法を説明しています。

AWS CLI

トピック検出分析ジョブを開始するには

次の start-topics-detection-job の例では、--input-data-config タグで指定されたアドレスにあるすべてのファイルの非同期トピック検出ジョブを開始します。ジョブが完了すると、フォルダ、output--ouput-data-config タグで指定された場所に配置されます。output には topic-terms.csv と doc-topics.csv が含まれています。最初の出力ファイル topic-terms.csv は、コレクション内のトピックのリストです。デフォルトでは、リストには、各トピックの上位の言葉が重みに応じてトピック別に含まれています。2 つ目のファイル doc-topics.csv には、トピックに関連するドキュメントと、そのトピックに関係するドキュメントの割合が一覧表示されます。

aws comprehend start-topics-detection-job \ --job-name example_topics_detection_job \ --language-code en \ --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \ --output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \ --data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \ --language-code en

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「トピックのモデリング」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartTopicsDetectionJob」を参照してください。

次の例は、stop-dominant-language-detection-job を使用する方法を説明しています。

AWS CLI

非同期主要言語検出ジョブを停止するには

次の stop-dominant-language-detection-job の例では、進行中の非同期主要言語検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次のコード例は、stop-entities-detection-job を使用する方法を示しています。

AWS CLI

非同期エンティティ検出ジョブを停止するには

次の stop-entities-detection-job の例では、進行中の非同期エンティティ検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopEntitiesDetectionJob」を参照してください。

次の例は、stop-events-detection-job を使用する方法を説明しています。

AWS CLI

非同期イベント検出ジョブを停止するには

次の stop-events-detection-job の例では、進行中の非同期イベント検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopEventsDetectionJob」を参照してください。

次の例は、stop-key-phrases-detection-job を使用する方法を説明しています。

AWS CLI

非同期キーフレーズ検出ジョブを停止するには

次の stop-key-phrases-detection-job の例では、進行中の非同期キーフレーズ検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopKeyPhrasesDetectionJob」を参照してください。

次のコード例は、stop-pii-entities-detection-job を使用する方法を示しています。

AWS CLI

非同期 PII エンティティ検出ジョブを停止するには

次の stop-pii-entities-detection-job の例では、進行中の非同期 PII エンティティ検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopPiiEntitiesDetectionJob」を参照してください。

次の例は、stop-sentiment-detection-job を使用する方法を説明しています。

AWS CLI

非同期感情検出ジョブを停止するには

次の stop-sentiment-detection-job の例では、進行中の非同期感情検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopSentimentDetectionJob」を参照してください。

次の例は、stop-targeted-sentiment-detection-job を使用する方法を説明しています。

AWS CLI

非同期ターゲット感情検出ジョブを停止するには

次の stop-targeted-sentiment-detection-job の例では、進行中の非同期ターゲット感情検出ジョブを停止しています。ジョブの現在の状態が IN_PROGRESS の場合、そのジョブは終了としてマークされ、状態が STOP_REQUESTED になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は COMPLETED になります。

aws comprehend stop-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE

出力:

{ "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のインサイトのための非同期分析」を参照してください。

次のコード例は、stop-training-document-classifier を使用する方法を示しています。

AWS CLI

ドキュメント分類子モデルのトレーニングを停止するには

次の stop-training-document-classifier の例では、進行中のドキュメント分類子モデルのトレーニングを停止しています。

aws comprehend stop-training-document-classifier --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタムモデルの作成と管理」を参照してください。

次のコード例は、stop-training-entity-recognizer を使用する方法を示しています。

AWS CLI

エンティティレコグナイザーモデルのトレーニングを停止するには

次の stop-training-entity-recognizer の例では、進行中のエンティティレコグナイザーモデルのトレーニングを停止しています。

aws comprehend stop-training-entity-recognizer --entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/examplerecognizer1"

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「カスタムモデルの作成と管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StopTrainingEntityRecognizer」を参照してください。

次のコード例は、tag-resource を使用する方法を示しています。

AWS CLI

例 1: リソースにタグを付けるには

次の tag-resource の例では、Amazon Comprehend リソースにタグを 1 つ追加しています。

aws comprehend tag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \ --tags Key=Location,Value=Seattle

このコマンドには出力がありません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Tagging your resources」を参照してください。

例 2: 複数のタグをリソースに追加する

次の tag-resource の例では、Amazon Comprehend リソースに複数のタグを追加しています。

aws comprehend tag-resource \ --resource-arn "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1" \ --tags Key=location,Value=Seattle Key=Department,Value=Finance

このコマンドには出力がありません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Tagging your resources」を参照してください。

  • API の詳細については、AWS CLI コマンドリファレンスの「TagResource」を参照してください。

次のコード例は、untag-resource を使用する方法を示しています。

AWS CLI

例 1: リソースから 1 つのタグを削除するには

次の untag-resource の例では、Amazon Comprehend リソースからタグを 1 つ削除しています。

aws comprehend untag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 --tag-keys Location

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Tagging your resources」を参照してください。

例 2: リソースから複数のタグを削除するには

次の untag-resource の例では、Amazon Comprehend リソースから複数のタグを削除しています。

aws comprehend untag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 --tag-keys Location Department

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Tagging your resources」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource」を参照してください。

次の例は、update-endpoint を使用する方法を説明しています。

AWS CLI

例 1: エンドポイントの推論ユニットを更新するには

次の update-endpoint の例では、エンドポイントに関する情報を更新しています。この例では、推論ユニットの数が増加します。

aws comprehend update-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint --desired-inference-units 2

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

例 2: エンドポイントのアクティブモデルを更新するには

次の update-endpoint の例では、エンドポイントに関する情報を更新しています。この例では、アクティブモデルが変更されます。

aws comprehend update-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-new

このコマンドでは何も出力されません。

詳細については、「Amazon Comprehend デベロッパーガイド」の「Amazon Comprehend のエンドポイントの管理」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateEndpoint」を参照してください。

次のコード例は、update-flywheel を使用する方法を示しています。

AWS CLI

フライホイールの設定を更新するには

次の update-flywheel の例では、フライホイールの設定を更新しています。この例では、フライホイールのアクティブモデルが更新されます。

aws comprehend update-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1 \ --active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model

出力:

{ "FlywheelProperties": { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity", "ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model", "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role", "TaskConfig": { "LanguageCode": "en", "DocumentClassificationConfig": { "Mode": "MULTI_CLASS" } }, "DataLakeS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/", "DataSecurityConfig": {}, "Status": "ACTIVE", "ModelType": "DOCUMENT_CLASSIFIER", "CreationTime": "2023-06-16T20:05:43.242000+00:00", "LastModifiedTime": "2023-06-19T04:00:43.027000+00:00", "LatestFlywheelIteration": "20230619T040032Z" } }

詳細については、「Amazon Comprehend デベロッパーガイド」の「Flywheel Overview」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateFlywheel」を参照してください。