Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS SDKs を使用した Amazon Comprehend の基本的な例
以下のコード例は、 AWS SDK で Amazon Comprehend を使用する基本的な方法を説明しています。
**Contents**
+ [アクション](comprehend_code_examples_actions.md)
+ [`CreateDocumentClassifier`](comprehend_example_comprehend_CreateDocumentClassifier_section.md)
+ [`DeleteDocumentClassifier`](comprehend_example_comprehend_DeleteDocumentClassifier_section.md)
+ [`DescribeDocumentClassificationJob`](comprehend_example_comprehend_DescribeDocumentClassificationJob_section.md)
+ [`DescribeDocumentClassifier`](comprehend_example_comprehend_DescribeDocumentClassifier_section.md)
+ [`DescribeTopicsDetectionJob`](comprehend_example_comprehend_DescribeTopicsDetectionJob_section.md)
+ [`DetectDominantLanguage`](comprehend_example_comprehend_DetectDominantLanguage_section.md)
+ [`DetectEntities`](comprehend_example_comprehend_DetectEntities_section.md)
+ [`DetectKeyPhrases`](comprehend_example_comprehend_DetectKeyPhrases_section.md)
+ [`DetectPiiEntities`](comprehend_example_comprehend_DetectPiiEntities_section.md)
+ [`DetectSentiment`](comprehend_example_comprehend_DetectSentiment_section.md)
+ [`DetectSyntax`](comprehend_example_comprehend_DetectSyntax_section.md)
+ [`ListDocumentClassificationJobs`](comprehend_example_comprehend_ListDocumentClassificationJobs_section.md)
+ [`ListDocumentClassifiers`](comprehend_example_comprehend_ListDocumentClassifiers_section.md)
+ [`ListTopicsDetectionJobs`](comprehend_example_comprehend_ListTopicsDetectionJobs_section.md)
+ [`StartDocumentClassificationJob`](comprehend_example_comprehend_StartDocumentClassificationJob_section.md)
+ [`StartTopicsDetectionJob`](comprehend_example_comprehend_StartTopicsDetectionJob_section.md)
# SDK を使用した Amazon Comprehend のアクション AWS SDKs
次のコード例は、 AWS SDKs を使用して個々の Amazon Comprehend アクションを実行する方法を示しています。それぞれの例には、GitHub へのリンクがあり、そこにはコードの設定と実行に関する説明が記載されています。
これらの抜粋は、Amazon Comprehend API を呼び出し、コンテキスト内で実行する必要がある大規模なプログラムからのコード抜粋です。アクションは [SDK を使用した Amazon Comprehend のシナリオ AWS SDKs](comprehend_code_examples_scenarios.md) のコンテキスト内で確認できます。
以下の例には、最も一般的に使用されるアクションのみ含まれています。詳細な一覧については、『[Amazon Comprehend API Reference](https://docs.aws.amazon.com/comprehend/latest/APIReference/welcome.html)』(Amazon S3 API リファレンス) を参照してください。
**Topics**
+ [`CreateDocumentClassifier`](comprehend_example_comprehend_CreateDocumentClassifier_section.md)
+ [`DeleteDocumentClassifier`](comprehend_example_comprehend_DeleteDocumentClassifier_section.md)
+ [`DescribeDocumentClassificationJob`](comprehend_example_comprehend_DescribeDocumentClassificationJob_section.md)
+ [`DescribeDocumentClassifier`](comprehend_example_comprehend_DescribeDocumentClassifier_section.md)
+ [`DescribeTopicsDetectionJob`](comprehend_example_comprehend_DescribeTopicsDetectionJob_section.md)
+ [`DetectDominantLanguage`](comprehend_example_comprehend_DetectDominantLanguage_section.md)
+ [`DetectEntities`](comprehend_example_comprehend_DetectEntities_section.md)
+ [`DetectKeyPhrases`](comprehend_example_comprehend_DetectKeyPhrases_section.md)
+ [`DetectPiiEntities`](comprehend_example_comprehend_DetectPiiEntities_section.md)
+ [`DetectSentiment`](comprehend_example_comprehend_DetectSentiment_section.md)
+ [`DetectSyntax`](comprehend_example_comprehend_DetectSyntax_section.md)
+ [`ListDocumentClassificationJobs`](comprehend_example_comprehend_ListDocumentClassificationJobs_section.md)
+ [`ListDocumentClassifiers`](comprehend_example_comprehend_ListDocumentClassifiers_section.md)
+ [`ListTopicsDetectionJobs`](comprehend_example_comprehend_ListTopicsDetectionJobs_section.md)
+ [`StartDocumentClassificationJob`](comprehend_example_comprehend_StartDocumentClassificationJob_section.md)
+ [`StartTopicsDetectionJob`](comprehend_example_comprehend_StartTopicsDetectionJob_section.md)
# AWS SDK または CLI `CreateDocumentClassifier`で を使用する
次のサンプルコードは、`CreateDocumentClassifier` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[CreateDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-document-classifier.html)」を参照してください。**
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import software.amazon.awssdk.services.comprehend.model.CreateDocumentClassifierRequest;
import software.amazon.awssdk.services.comprehend.model.CreateDocumentClassifierResponse;
import software.amazon.awssdk.services.comprehend.model.DocumentClassifierInputDataConfig;
/**
* Before running this code example, you can setup the necessary resources, such
* as the CSV file and IAM Roles, by following this document:
* https://aws.amazon.com/blogs/machine-learning/building-a-custom-classifier-using-amazon-comprehend/
*
* Also, set up your development environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DocumentClassifierDemo {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
dataAccessRoleArn - The ARN value of the role used for this operation.
s3Uri - The Amazon S3 bucket that contains the CSV file.
documentClassifierName - The name of the document classifier.
""";
if (args.length != 3) {
System.out.println(usage);
System.exit(1);
}
String dataAccessRoleArn = args[0];
String s3Uri = args[1];
String documentClassifierName = args[2];
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
createDocumentClassifier(comClient, dataAccessRoleArn, s3Uri, documentClassifierName);
comClient.close();
}
public static void createDocumentClassifier(ComprehendClient comClient, String dataAccessRoleArn, String s3Uri,
String documentClassifierName) {
try {
DocumentClassifierInputDataConfig config = DocumentClassifierInputDataConfig.builder()
.s3Uri(s3Uri)
.build();
CreateDocumentClassifierRequest createDocumentClassifierRequest = CreateDocumentClassifierRequest.builder()
.documentClassifierName(documentClassifierName)
.dataAccessRoleArn(dataAccessRoleArn)
.languageCode("en")
.inputDataConfig(config)
.build();
CreateDocumentClassifierResponse createDocumentClassifierResult = comClient
.createDocumentClassifier(createDocumentClassifierRequest);
String documentClassifierArn = createDocumentClassifierResult.documentClassifierArn();
System.out.println("Document Classifier ARN: " + documentClassifierArn);
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、『AWS SDK for Java 2.x SDK for Rust API リファレンス』の「[CreateDocumentClassifier](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/CreateDocumentClassifier)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def create(
self,
name,
language_code,
training_bucket,
training_key,
data_access_role_arn,
mode,
):
"""
Creates a custom classifier. After the classifier is created, it immediately
starts training on the data found in the specified Amazon S3 bucket. Training
can take 30 minutes or longer. The `describe_document_classifier` function
can be used to get training status and returns a status of TRAINED when the
classifier is ready to use.
:param name: The name of the classifier.
:param language_code: The language the classifier can operate on.
:param training_bucket: The Amazon S3 bucket that contains the training data.
:param training_key: The prefix used to find training data in the training
bucket. If multiple objects have the same prefix, all
of them are used.
:param data_access_role_arn: The Amazon Resource Name (ARN) of a role that
grants Comprehend permission to read from the
training bucket.
:return: The ARN of the newly created classifier.
"""
try:
response = self.comprehend_client.create_document_classifier(
DocumentClassifierName=name,
LanguageCode=language_code,
InputDataConfig={"S3Uri": f"s3://{training_bucket}/{training_key}"},
DataAccessRoleArn=data_access_role_arn,
Mode=mode.value,
)
self.classifier_arn = response["DocumentClassifierArn"]
logger.info("Started classifier creation. Arn is: %s.", self.classifier_arn)
except ClientError:
logger.exception("Couldn't create classifier %s.", name)
raise
else:
return self.classifier_arn
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[CreateDocumentClassifier](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/CreateDocumentClassifier)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->createdocumentclassifier(
iv_documentclassifiername = iv_classifier_name
iv_languagecode = iv_language_code
io_inputdataconfig = NEW /aws1/cl_cpddocclifierinpdat00(
iv_s3uri = iv_training_s3_uri
)
iv_dataaccessrolearn = iv_data_access_role_arn
iv_mode = iv_mode
).
MESSAGE 'Document classifier creation started.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdresrclimitexcdex.
MESSAGE 'Resource limit exceeded.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanytagsex.
MESSAGE 'Too many tags.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[CreateDocumentClassifier](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DeleteDocumentClassifier`で を使用する
次のサンプルコードは、`DeleteDocumentClassifier` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[DeleteDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-document-classifier.html)」を参照してください。**
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def delete(self):
"""
Deletes the classifier.
"""
try:
self.comprehend_client.delete_document_classifier(
DocumentClassifierArn=self.classifier_arn
)
logger.info("Deleted classifier %s.", self.classifier_arn)
self.classifier_arn = None
except ClientError:
logger.exception("Couldn't deleted classifier %s.", self.classifier_arn)
raise
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DeleteDocumentClassifier](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DeleteDocumentClassifier)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->deletedocumentclassifier(
iv_documentclassifierarn = iv_classifier_arn
).
MESSAGE 'Document classifier deleted.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdresourcenotfoundex.
MESSAGE 'Resource not found.' TYPE 'E'.
CATCH /aws1/cx_cpdresourceinuseex.
MESSAGE 'Resource in use.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DeleteDocumentClassifier](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DescribeDocumentClassificationJob`で を使用する
次のサンプルコードは、`DescribeDocumentClassificationJob` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 デベロッパーガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classification-job.html)」を参照してください。**
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def describe_job(self, job_id):
"""
Gets metadata about a classification job.
:param job_id: The ID of the job to look up.
:return: Metadata about the job.
"""
try:
response = self.comprehend_client.describe_document_classification_job(
JobId=job_id
)
job = response["DocumentClassificationJobProperties"]
logger.info("Got classification job %s.", job["JobName"])
except ClientError:
logger.exception("Couldn't get classification job %s.", job_id)
raise
else:
return job
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DescribeDocumentClassificationJob](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DescribeDocumentClassificationJob)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->describedocclassificationjob(
iv_jobid = iv_job_id
).
MESSAGE 'Document classification job described.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdjobnotfoundex.
MESSAGE 'Job not found.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[DescribeDocumentClassificationJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DescribeDocumentClassifier`で を使用する
次のサンプルコードは、`DescribeDocumentClassifier` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[DescribeDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classifier.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def describe(self, classifier_arn=None):
"""
Gets metadata about a custom classifier, including its current status.
:param classifier_arn: The ARN of the classifier to look up.
:return: Metadata about the classifier.
"""
if classifier_arn is not None:
self.classifier_arn = classifier_arn
try:
response = self.comprehend_client.describe_document_classifier(
DocumentClassifierArn=self.classifier_arn
)
classifier = response["DocumentClassifierProperties"]
logger.info("Got classifier %s.", self.classifier_arn)
except ClientError:
logger.exception("Couldn't get classifier %s.", self.classifier_arn)
raise
else:
return classifier
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DescribeDocumentClassifier](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DescribeDocumentClassifier)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->describedocumentclassifier(
iv_documentclassifierarn = iv_classifier_arn
).
MESSAGE 'Document classifier described.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdresourcenotfoundex.
MESSAGE 'Resource not found.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[DescribeDocumentClassifier](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DescribeTopicsDetectionJob`で を使用する
次のサンプルコードは、`DescribeTopicsDetectionJob` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [サンプルデータに対してトピックモデリングジョブを実行する。](comprehend_example_comprehend_Usage_TopicModeler_section.md)
------
#### [ CLI ]
**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 のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-topics-detection-job.html)」を参照してください。**
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendTopicModeler:
"""Encapsulates a Comprehend topic modeler."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def describe_job(self, job_id):
"""
Gets metadata about a topic modeling job.
:param job_id: The ID of the job to look up.
:return: Metadata about the job.
"""
try:
response = self.comprehend_client.describe_topics_detection_job(
JobId=job_id
)
job = response["TopicsDetectionJobProperties"]
logger.info("Got topic detection job %s.", job_id)
except ClientError:
logger.exception("Couldn't get topic detection job %s.", job_id)
raise
else:
return job
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DescribeTopicsDetectionJob](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DescribeTopicsDetectionJob)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->describetopicsdetectionjob(
iv_jobid = iv_job_id
).
MESSAGE 'Topics detection job described.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdjobnotfoundex.
MESSAGE 'Job not found.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の「[DescribeTopicsDetectionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectDominantLanguage`で を使用する
次のサンプルコードは、`DetectDominantLanguage` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example calls the Amazon Comprehend service to determine the
/// dominant language.
///
public static class DetectDominantLanguage
{
///
/// Calls Amazon Comprehend to determine the dominant language used in
/// the sample text.
///
public static async Task Main()
{
string text = "It is raining today in Seattle.";
var comprehendClient = new AmazonComprehendClient(Amazon.RegionEndpoint.USWest2);
Console.WriteLine("Calling DetectDominantLanguage\n");
var detectDominantLanguageRequest = new DetectDominantLanguageRequest()
{
Text = text,
};
var detectDominantLanguageResponse = await comprehendClient.DetectDominantLanguageAsync(detectDominantLanguageRequest);
foreach (var dl in detectDominantLanguageResponse.Languages)
{
Console.WriteLine($"Language Code: {dl.LanguageCode}, Score: {dl.Score}");
}
Console.WriteLine("Done");
}
}
```
+ API の詳細については、*AWS SDK for .NET API リファレンス*の「[DetectDominantLanguage](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectDominantLanguage)」を参照してください。
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[主要言語](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[DetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-dominant-language.html)」を参照してください。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import software.amazon.awssdk.services.comprehend.model.DetectDominantLanguageRequest;
import software.amazon.awssdk.services.comprehend.model.DetectDominantLanguageResponse;
import software.amazon.awssdk.services.comprehend.model.DominantLanguage;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DetectLanguage {
public static void main(String[] args) {
// Specify French text - "It is raining today in Seattle".
String text = "Il pleut aujourd'hui à Seattle";
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
System.out.println("Calling DetectDominantLanguage");
detectTheDominantLanguage(comClient, text);
comClient.close();
}
public static void detectTheDominantLanguage(ComprehendClient comClient, String text) {
try {
DetectDominantLanguageRequest request = DetectDominantLanguageRequest.builder()
.text(text)
.build();
DetectDominantLanguageResponse resp = comClient.detectDominantLanguage(request);
List allLanList = resp.languages();
for (DominantLanguage lang : allLanList) {
System.out.println("Language is " + lang.languageCode());
}
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、[AWS SDK for Java 2.x API リファレンス](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DetectDominantLanguage) の「DetectDominantLanguage」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_languages(self, text):
"""
Detects languages used in a document.
:param text: The document to inspect.
:return: The list of languages along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_dominant_language(Text=text)
languages = response["Languages"]
logger.info("Detected %s languages.", len(languages))
except ClientError:
logger.exception("Couldn't detect languages.")
raise
else:
return languages
```
+ API の詳細については、「AWS SDK for Python (Boto3) API リファレンス」**の「[DetectDominantLanguage](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectDominantLanguage)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectdominantlanguage( iv_text = iv_text ).
MESSAGE 'Languages detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectDominantLanguage](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectEntities`で を使用する
次のサンプルコードは、`DetectEntities` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example shows how to use the AmazonComprehend service detect any
/// entities in submitted text.
///
public static class DetectEntities
{
///
/// The main method calls the DetectEntitiesAsync method to find any
/// entities in the sample code.
///
public static async Task Main()
{
string text = "It is raining today in Seattle";
var comprehendClient = new AmazonComprehendClient();
Console.WriteLine("Calling DetectEntities\n");
var detectEntitiesRequest = new DetectEntitiesRequest()
{
Text = text,
LanguageCode = "en",
};
var detectEntitiesResponse = await comprehendClient.DetectEntitiesAsync(detectEntitiesRequest);
foreach (var e in detectEntitiesResponse.Entities)
{
Console.WriteLine($"Text: {e.Text}, Type: {e.Type}, Score: {e.Score}, BeginOffset: {e.BeginOffset}, EndOffset: {e.EndOffset}");
}
Console.WriteLine("Done");
}
}
```
+ API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[DetectEntities](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectEntities)」を参照してください。
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[エンティティ](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html)」を参照してください。
+ API の詳細については、AWS CLI コマンドリファレンスの「[DetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-entities.html)」を参照してください。**
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.DetectEntitiesRequest;
import software.amazon.awssdk.services.comprehend.model.DetectEntitiesResponse;
import software.amazon.awssdk.services.comprehend.model.Entity;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DetectEntities {
public static void main(String[] args) {
String text = "Amazon.com, Inc. is located in Seattle, WA and was founded July 5th, 1994 by Jeff Bezos, allowing customers to buy everything from books to blenders. Seattle is north of Portland and south of Vancouver, BC. Other notable Seattle - based companies are Starbucks and Boeing.";
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
System.out.println("Calling DetectEntities");
detectAllEntities(comClient, text);
comClient.close();
}
public static void detectAllEntities(ComprehendClient comClient, String text) {
try {
DetectEntitiesRequest detectEntitiesRequest = DetectEntitiesRequest.builder()
.text(text)
.languageCode("en")
.build();
DetectEntitiesResponse detectEntitiesResult = comClient.detectEntities(detectEntitiesRequest);
List entList = detectEntitiesResult.entities();
for (Entity entity : entList) {
System.out.println("Entity text is " + entity.text());
}
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、『AWS SDK for Java 2.x API リファレンス』の「[DetectEntities](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DetectEntities)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_entities(self, text, language_code):
"""
Detects entities in a document. Entities can be things like people and places
or other common terms.
:param text: The document to inspect.
:param language_code: The language of the document.
:return: The list of entities along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_entities(
Text=text, LanguageCode=language_code
)
entities = response["Entities"]
logger.info("Detected %s entities.", len(entities))
except ClientError:
logger.exception("Couldn't detect entities.")
raise
else:
return entities
```
+ API の詳細については、**「AWS SDK for Python (Boto3) API リファレンス」の「[DetectEntities](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectEntities)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectentities(
iv_text = iv_text
iv_languagecode = iv_language_code
).
MESSAGE 'Entities detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdunsuppedlanguageex.
MESSAGE 'Unsupported language.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectEntities](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectKeyPhrases`で を使用する
次のサンプルコードは、`DetectKeyPhrases` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example shows how to use the Amazon Comprehend service to
/// search text for key phrases.
///
public static class DetectKeyPhrase
{
///
/// This method calls the Amazon Comprehend method DetectKeyPhrasesAsync
/// to detect any key phrases in the sample text.
///
public static async Task Main()
{
string text = "It is raining today in Seattle";
var comprehendClient = new AmazonComprehendClient(Amazon.RegionEndpoint.USWest2);
// Call DetectKeyPhrases API
Console.WriteLine("Calling DetectKeyPhrases");
var detectKeyPhrasesRequest = new DetectKeyPhrasesRequest()
{
Text = text,
LanguageCode = "en",
};
var detectKeyPhrasesResponse = await comprehendClient.DetectKeyPhrasesAsync(detectKeyPhrasesRequest);
foreach (var kp in detectKeyPhrasesResponse.KeyPhrases)
{
Console.WriteLine($"Text: {kp.Text}, Score: {kp.Score}, BeginOffset: {kp.BeginOffset}, EndOffset: {kp.EndOffset}");
}
Console.WriteLine("Done");
}
}
```
+ API の詳細については、AWS SDK for .NET API リファレンスの「[DetectKeyPhrases](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectKeyPhrases)」を参照してください。
------
#### [ CLI ]
**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 開発者ガイド」の「[キーフレーズ](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[DetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-key-phrases.html)」を参照してください。**
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.DetectKeyPhrasesRequest;
import software.amazon.awssdk.services.comprehend.model.DetectKeyPhrasesResponse;
import software.amazon.awssdk.services.comprehend.model.KeyPhrase;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DetectKeyPhrases {
public static void main(String[] args) {
String text = "Amazon.com, Inc. is located in Seattle, WA and was founded July 5th, 1994 by Jeff Bezos, allowing customers to buy everything from books to blenders. Seattle is north of Portland and south of Vancouver, BC. Other notable Seattle - based companies are Starbucks and Boeing.";
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
System.out.println("Calling DetectKeyPhrases");
detectAllKeyPhrases(comClient, text);
comClient.close();
}
public static void detectAllKeyPhrases(ComprehendClient comClient, String text) {
try {
DetectKeyPhrasesRequest detectKeyPhrasesRequest = DetectKeyPhrasesRequest.builder()
.text(text)
.languageCode("en")
.build();
DetectKeyPhrasesResponse detectKeyPhrasesResult = comClient.detectKeyPhrases(detectKeyPhrasesRequest);
List phraseList = detectKeyPhrasesResult.keyPhrases();
for (KeyPhrase keyPhrase : phraseList) {
System.out.println("Key phrase text is " + keyPhrase.text());
}
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、『AWS SDK for Java 2.x API リファレンス』の「[DetectKeyPhrases](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DetectKeyPhrases)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_key_phrases(self, text, language_code):
"""
Detects key phrases in a document. A key phrase is typically a noun and its
modifiers.
:param text: The document to inspect.
:param language_code: The language of the document.
:return: The list of key phrases along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_key_phrases(
Text=text, LanguageCode=language_code
)
phrases = response["KeyPhrases"]
logger.info("Detected %s phrases.", len(phrases))
except ClientError:
logger.exception("Couldn't detect phrases.")
raise
else:
return phrases
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DetectKeyPhrases](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectKeyPhrases)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectkeyphrases(
iv_text = iv_text
iv_languagecode = iv_language_code
).
MESSAGE 'Key phrases detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdunsuppedlanguageex.
MESSAGE 'Unsupported language.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectKeyPhrases](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectPiiEntities`で を使用する
次のサンプルコードは、`DetectPiiEntities` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example shows how to use the Amazon Comprehend service to find
/// personally identifiable information (PII) within text submitted to the
/// DetectPiiEntitiesAsync method.
///
public class DetectingPII
{
///
/// This method calls the DetectPiiEntitiesAsync method to locate any
/// personally dientifiable information within the supplied text.
///
public static async Task Main()
{
var comprehendClient = new AmazonComprehendClient();
var text = @"Hello Paul Santos. The latest statement for your
credit card account 1111-0000-1111-0000 was
mailed to 123 Any Street, Seattle, WA 98109.";
var request = new DetectPiiEntitiesRequest
{
Text = text,
LanguageCode = "EN",
};
var response = await comprehendClient.DetectPiiEntitiesAsync(request);
if (response.Entities.Count > 0)
{
foreach (var entity in response.Entities)
{
var entityValue = text.Substring(entity.BeginOffset, entity.EndOffset - entity.BeginOffset);
Console.WriteLine($"{entity.Type}: {entityValue}");
}
}
}
}
```
+ API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[DetectPIIEntities](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectPiiEntities)」を参照してください。
------
#### [ CLI ]
**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)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html)」を参照してください。**
+ API の詳細については、AWS CLI コマンドリファレンスの「[DetectPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-pii-entities.html)」を参照してください。**
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_pii(self, text, language_code):
"""
Detects personally identifiable information (PII) in a document. PII can be
things like names, account numbers, or addresses.
:param text: The document to inspect.
:param language_code: The language of the document.
:return: The list of PII entities along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_pii_entities(
Text=text, LanguageCode=language_code
)
entities = response["Entities"]
logger.info("Detected %s PII entities.", len(entities))
except ClientError:
logger.exception("Couldn't detect PII entities.")
raise
else:
return entities
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DetectPiiEntities](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectPiiEntities)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectpiientities(
iv_text = iv_text
iv_languagecode = iv_language_code
).
MESSAGE 'PII entities detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdunsuppedlanguageex.
MESSAGE 'Unsupported language.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectPiiEntities](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectSentiment`で を使用する
次のサンプルコードは、`DetectSentiment` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example shows how to detect the overall sentiment of the supplied
/// text using the Amazon Comprehend service.
///
public static class DetectSentiment
{
///
/// This method calls the DetetectSentimentAsync method to analyze the
/// supplied text and determine the overal sentiment.
///
public static async Task Main()
{
string text = "It is raining today in Seattle";
var comprehendClient = new AmazonComprehendClient(Amazon.RegionEndpoint.USWest2);
// Call DetectKeyPhrases API
Console.WriteLine("Calling DetectSentiment");
var detectSentimentRequest = new DetectSentimentRequest()
{
Text = text,
LanguageCode = "en",
};
var detectSentimentResponse = await comprehendClient.DetectSentimentAsync(detectSentimentRequest);
Console.WriteLine($"Sentiment: {detectSentimentResponse.Sentiment}");
Console.WriteLine("Done");
}
}
```
+ API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[DetectSentiment](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectSentiment)」を参照してください。
------
#### [ CLI ]
**AWS CLI**
**入力テキストの感情を検出するには**
次の `detect-sentiment` の例では、入力テキストを分析し、一般的な感情 (`POSITIVE`、`NEUTRAL`、`MIXED`、または `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 デベロッパーガイド*」の「[感情](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[DetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-sentiment.html)」を参照してください。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import software.amazon.awssdk.services.comprehend.model.DetectSentimentRequest;
import software.amazon.awssdk.services.comprehend.model.DetectSentimentResponse;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DetectSentiment {
public static void main(String[] args) {
String text = "Amazon.com, Inc. is located in Seattle, WA and was founded July 5th, 1994 by Jeff Bezos, allowing customers to buy everything from books to blenders. Seattle is north of Portland and south of Vancouver, BC. Other notable Seattle - based companies are Starbucks and Boeing.";
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
System.out.println("Calling DetectSentiment");
detectSentiments(comClient, text);
comClient.close();
}
public static void detectSentiments(ComprehendClient comClient, String text) {
try {
DetectSentimentRequest detectSentimentRequest = DetectSentimentRequest.builder()
.text(text)
.languageCode("en")
.build();
DetectSentimentResponse detectSentimentResult = comClient.detectSentiment(detectSentimentRequest);
System.out.println("The Neutral value is " + detectSentimentResult.sentimentScore().neutral());
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、『*AWS SDK for Java 2.x SDK for Rust API リファレンス*』の「[DetectSentiment](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DetectSentiment)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_sentiment(self, text, language_code):
"""
Detects the overall sentiment expressed in a document. Sentiment can
be positive, negative, neutral, or a mixture.
:param text: The document to inspect.
:param language_code: The language of the document.
:return: The sentiments along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_sentiment(
Text=text, LanguageCode=language_code
)
logger.info("Detected primary sentiment %s.", response["Sentiment"])
except ClientError:
logger.exception("Couldn't detect sentiment.")
raise
else:
return response
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[DetectSentiment](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectSentiment)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectsentiment(
iv_text = iv_text
iv_languagecode = iv_language_code
).
MESSAGE 'Sentiment detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdunsuppedlanguageex.
MESSAGE 'Unsupported language.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectSentiment](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `DetectSyntax`で を使用する
次のサンプルコードは、`DetectSyntax` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [ドキュメントの要素を検出する](comprehend_example_comprehend_Usage_DetectApis_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example shows how to use Amazon Comprehend to detect syntax
/// elements by calling the DetectSyntaxAsync method.
///
public class DetectingSyntax
{
///
/// This method calls DetectSynaxAsync to identify the syntax elements
/// in the sample text.
///
public static async Task Main()
{
string text = "It is raining today in Seattle";
var comprehendClient = new AmazonComprehendClient();
// Call DetectSyntax API
Console.WriteLine("Calling DetectSyntaxAsync\n");
var detectSyntaxRequest = new DetectSyntaxRequest()
{
Text = text,
LanguageCode = "en",
};
DetectSyntaxResponse detectSyntaxResponse = await comprehendClient.DetectSyntaxAsync(detectSyntaxRequest);
foreach (SyntaxToken s in detectSyntaxResponse.SyntaxTokens)
{
Console.WriteLine($"Text: {s.Text}, PartOfSpeech: {s.PartOfSpeech.Tag}, BeginOffset: {s.BeginOffset}, EndOffset: {s.EndOffset}");
}
Console.WriteLine("Done");
}
}
```
+ API の詳細については、「[AWS SDK for .NET API リファレンス](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/DetectSyntax)」の「*DetectSyntax*」を参照してください。
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[構文分析](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[DetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-syntax.html)」を参照してください。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.comprehend.ComprehendClient;
import software.amazon.awssdk.services.comprehend.model.ComprehendException;
import software.amazon.awssdk.services.comprehend.model.DetectSyntaxRequest;
import software.amazon.awssdk.services.comprehend.model.DetectSyntaxResponse;
import software.amazon.awssdk.services.comprehend.model.SyntaxToken;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DetectSyntax {
public static void main(String[] args) {
String text = "Amazon.com, Inc. is located in Seattle, WA and was founded July 5th, 1994 by Jeff Bezos, allowing customers to buy everything from books to blenders. Seattle is north of Portland and south of Vancouver, BC. Other notable Seattle - based companies are Starbucks and Boeing.";
Region region = Region.US_EAST_1;
ComprehendClient comClient = ComprehendClient.builder()
.region(region)
.build();
System.out.println("Calling DetectSyntax");
detectAllSyntax(comClient, text);
comClient.close();
}
public static void detectAllSyntax(ComprehendClient comClient, String text) {
try {
DetectSyntaxRequest detectSyntaxRequest = DetectSyntaxRequest.builder()
.text(text)
.languageCode("en")
.build();
DetectSyntaxResponse detectSyntaxResult = comClient.detectSyntax(detectSyntaxRequest);
List syntaxTokens = detectSyntaxResult.syntaxTokens();
for (SyntaxToken token : syntaxTokens) {
System.out.println("Language is " + token.text());
System.out.println("Part of speech is " + token.partOfSpeech().tagAsString());
}
} catch (ComprehendException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ API の詳細については、『[AWS SDK for Java 2.x API リファレンス](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/DetectSyntax)』 の「*DetectSyntax*」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendDetect:
"""Encapsulates Comprehend detection functions."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def detect_syntax(self, text, language_code):
"""
Detects syntactical elements of a document. Syntax tokens are portions of
text along with their use as parts of speech, such as nouns, verbs, and
interjections.
:param text: The document to inspect.
:param language_code: The language of the document.
:return: The list of syntax tokens along with their confidence scores.
"""
try:
response = self.comprehend_client.detect_syntax(
Text=text, LanguageCode=language_code
)
tokens = response["SyntaxTokens"]
logger.info("Detected %s syntax tokens.", len(tokens))
except ClientError:
logger.exception("Couldn't detect syntax.")
raise
else:
return tokens
```
+ API の詳細については、[AWS SDK for Python (Boto3) API リファレンス](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/DetectSyntax) の「*DetectSyntax*」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->detectsyntax(
iv_text = iv_text
iv_languagecode = iv_language_code
).
MESSAGE 'Syntax tokens detected.' TYPE 'I'.
CATCH /aws1/cx_cpdtextsizelmtexcdex.
MESSAGE 'Text size exceeds limit.' TYPE 'E'.
CATCH /aws1/cx_cpdunsuppedlanguageex.
MESSAGE 'Unsupported language.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[DetectSyntax](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `ListDocumentClassificationJobs`で を使用する
次のサンプルコードは、`ListDocumentClassificationJobs` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。**
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[ListDocumentClassificationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classification-jobs.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def list_jobs(self):
"""
Lists the classification jobs for the current account.
:return: The list of jobs.
"""
try:
response = self.comprehend_client.list_document_classification_jobs()
jobs = response["DocumentClassificationJobPropertiesList"]
logger.info("Got %s document classification jobs.", len(jobs))
except ClientError:
logger.exception(
"Couldn't get document classification jobs.",
)
raise
else:
return jobs
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[ListDocumentClassificationJobs](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/ListDocumentClassificationJobs)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->listdocclassificationjobs( ).
MESSAGE 'Document classification jobs listed.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidfilterex.
MESSAGE 'Invalid filter.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[ListDocumentClassificationJobs](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `ListDocumentClassifiers`で を使用する
次のサンプルコードは、`ListDocumentClassifiers` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[ListDocumentClassifiers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifiers.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def list(self):
"""
Lists custom classifiers for the current account.
:return: The list of classifiers.
"""
try:
response = self.comprehend_client.list_document_classifiers()
classifiers = response["DocumentClassifierPropertiesList"]
logger.info("Got %s classifiers.", len(classifiers))
except ClientError:
logger.exception(
"Couldn't get classifiers.",
)
raise
else:
return classifiers
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[ListDocumentClassifiers](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/ListDocumentClassifiers)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->listdocumentclassifiers( ).
MESSAGE 'Document classifiers listed.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidfilterex.
MESSAGE 'Invalid filter.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[ListDocumentClassifiers](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `ListTopicsDetectionJobs`で を使用する
次のサンプルコードは、`ListTopicsDetectionJobs` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [サンプルデータに対してトピックモデリングジョブを実行する。](comprehend_example_comprehend_Usage_TopicModeler_section.md)
------
#### [ CLI ]
**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 のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTopicsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-topics-detection-jobs.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendTopicModeler:
"""Encapsulates a Comprehend topic modeler."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def list_jobs(self):
"""
Lists topic modeling jobs for the current account.
:return: The list of jobs.
"""
try:
response = self.comprehend_client.list_topics_detection_jobs()
jobs = response["TopicsDetectionJobPropertiesList"]
logger.info("Got %s topic detection jobs.", len(jobs))
except ClientError:
logger.exception("Couldn't get topic detection jobs.")
raise
else:
return jobs
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[ListTopicsDetectionJobs](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/ListTopicsDetectionJobs)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->listtopicsdetectionjobs( ).
MESSAGE 'Topics detection jobs listed.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdinvalidfilterex.
MESSAGE 'Invalid filter.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[ListTopicsDetectionJobs](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `StartDocumentClassificationJob`で を使用する
次のサンプルコードは、`StartDocumentClassificationJob` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [カスタム分類子をトレーニングしてドキュメントを分類します。](comprehend_example_comprehend_Usage_ComprehendClassifier_section.md)
------
#### [ CLI ]
**AWS CLI**
**ドキュメント分類ジョブを開始するには**
次の `start-document-classification-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して、カスタムモデルを使用してドキュメント分類ジョブを開始します。この例では、入力 S3 バケットには、`SampleSMStext1.txt`、`SampleSMStext2.txt`、`SampleSMStext3.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 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。**
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[StartDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-document-classification-job.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendClassifier:
"""Encapsulates an Amazon Comprehend custom classifier."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
self.classifier_arn = None
def start_job(
self,
job_name,
input_bucket,
input_key,
input_format,
output_bucket,
output_key,
data_access_role_arn,
):
"""
Starts a classification job. The classifier must be trained or the job
will fail. Input is read from the specified Amazon S3 input bucket and
written to the specified output bucket. Output data is stored in a tar
archive compressed in gzip format. The job runs asynchronously, so you can
call `describe_document_classification_job` to get job status until it
returns a status of SUCCEEDED.
:param job_name: The name of the job.
:param input_bucket: The Amazon S3 bucket that contains input data.
:param input_key: The prefix used to find input data in the input
bucket. If multiple objects have the same prefix, all
of them are used.
:param input_format: The format of the input data, either one document per
file or one document per line.
:param output_bucket: The Amazon S3 bucket where output data is written.
:param output_key: The prefix prepended to the output data.
:param data_access_role_arn: The Amazon Resource Name (ARN) of a role that
grants Comprehend permission to read from the
input bucket and write to the output bucket.
:return: Information about the job, including the job ID.
"""
try:
response = self.comprehend_client.start_document_classification_job(
DocumentClassifierArn=self.classifier_arn,
JobName=job_name,
InputDataConfig={
"S3Uri": f"s3://{input_bucket}/{input_key}",
"InputFormat": input_format.value,
},
OutputDataConfig={"S3Uri": f"s3://{output_bucket}/{output_key}"},
DataAccessRoleArn=data_access_role_arn,
)
logger.info(
"Document classification job %s is %s.", job_name, response["JobStatus"]
)
except ClientError:
logger.exception("Couldn't start classification job %s.", job_name)
raise
else:
return response
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[StartDocumentClassificationJob](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/StartDocumentClassificationJob)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->startdocclassificationjob(
iv_jobname = iv_job_name
iv_documentclassifierarn = iv_classifier_arn
io_inputdataconfig = NEW /aws1/cl_cpdinputdataconfig(
iv_s3uri = iv_input_s3_uri
iv_inputformat = iv_input_format
)
io_outputdataconfig = NEW /aws1/cl_cpdoutputdataconfig(
iv_s3uri = iv_output_s3_uri
)
iv_dataaccessrolearn = iv_data_access_role_arn
).
MESSAGE 'Document classification job started.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdresourcenotfoundex.
MESSAGE 'Resource not found.' TYPE 'E'.
CATCH /aws1/cx_cpdresourceunavailex.
MESSAGE 'Resource unavailable.' TYPE 'E'.
CATCH /aws1/cx_cpdkmskeyvalidationex.
MESSAGE 'KMS key validation error.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanytagsex.
MESSAGE 'Too many tags.' TYPE 'E'.
CATCH /aws1/cx_cpdresrclimitexcdex.
MESSAGE 'Resource limit exceeded.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[StartDocumentClassificationJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------
# AWS SDK または CLI `StartTopicsDetectionJob`で を使用する
次のサンプルコードは、`StartTopicsDetectionJob` を使用する方法を説明しています。
アクション例は、より大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。次のコード例で、このアクションのコンテキストを確認できます。
+ [サンプルデータに対してトピックモデリングジョブを実行する。](comprehend_example_comprehend_Usage_TopicModeler_section.md)
------
#### [ .NET ]
**SDK for .NET**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Comprehend/#code-examples)での設定と実行の方法を確認してください。
```
using System;
using System.Threading.Tasks;
using Amazon.Comprehend;
using Amazon.Comprehend.Model;
///
/// This example scans the documents in an Amazon Simple Storage Service
/// (Amazon S3) bucket and analyzes it for topics. The results are stored
/// in another bucket and then the resulting job properties are displayed
/// on the screen. This example was created using the AWS SDK for .NEt
/// version 3.7 and .NET Core version 5.0.
///
public static class TopicModeling
{
///
/// This methos calls a topic detection job by calling the Amazon
/// Comprehend StartTopicsDetectionJobRequest.
///
public static async Task Main()
{
var comprehendClient = new AmazonComprehendClient();
string inputS3Uri = "s3://input bucket/input path";
InputFormat inputDocFormat = InputFormat.ONE_DOC_PER_FILE;
string outputS3Uri = "s3://output bucket/output path";
string dataAccessRoleArn = "arn:aws:iam::account ID:role/data access role";
int numberOfTopics = 10;
var startTopicsDetectionJobRequest = new StartTopicsDetectionJobRequest()
{
InputDataConfig = new InputDataConfig()
{
S3Uri = inputS3Uri,
InputFormat = inputDocFormat,
},
OutputDataConfig = new OutputDataConfig()
{
S3Uri = outputS3Uri,
},
DataAccessRoleArn = dataAccessRoleArn,
NumberOfTopics = numberOfTopics,
};
var startTopicsDetectionJobResponse = await comprehendClient.StartTopicsDetectionJobAsync(startTopicsDetectionJobRequest);
var jobId = startTopicsDetectionJobResponse.JobId;
Console.WriteLine("JobId: " + jobId);
var describeTopicsDetectionJobRequest = new DescribeTopicsDetectionJobRequest()
{
JobId = jobId,
};
var describeTopicsDetectionJobResponse = await comprehendClient.DescribeTopicsDetectionJobAsync(describeTopicsDetectionJobRequest);
PrintJobProperties(describeTopicsDetectionJobResponse.TopicsDetectionJobProperties);
var listTopicsDetectionJobsResponse = await comprehendClient.ListTopicsDetectionJobsAsync(new ListTopicsDetectionJobsRequest());
foreach (var props in listTopicsDetectionJobsResponse.TopicsDetectionJobPropertiesList)
{
PrintJobProperties(props);
}
}
///
/// This method is a helper method that displays the job properties
/// from the call to StartTopicsDetectionJobRequest.
///
/// A list of properties from the call to
/// StartTopicsDetectionJobRequest.
private static void PrintJobProperties(TopicsDetectionJobProperties props)
{
Console.WriteLine($"JobId: {props.JobId}, JobName: {props.JobName}, JobStatus: {props.JobStatus}");
Console.WriteLine($"NumberOfTopics: {props.NumberOfTopics}\nInputS3Uri: {props.InputDataConfig.S3Uri}");
Console.WriteLine($"InputFormat: {props.InputDataConfig.InputFormat}, OutputS3Uri: {props.OutputDataConfig.S3Uri}");
}
}
```
+ API の詳細については、「*AWS SDK for .NET API リファレンス*」の「[StartTopicsDetectionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/comprehend-2017-11-27/StartTopicsDetectionJob)」を参照してください。
------
#### [ CLI ]
**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 デベロッパーガイド*」の「[トピックのモデリング](https://docs.aws.amazon.com/comprehend/latest/dg/topic-modeling.html)」を参照してください。
+ API の詳細については、「AWS CLI コマンドリファレンス」の「[StartTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-topics-detection-job.html)」を参照してください。
------
#### [ Python ]
**SDK for Python (Boto3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/comprehend#code-examples)での設定と実行の方法を確認してください。
```
class ComprehendTopicModeler:
"""Encapsulates a Comprehend topic modeler."""
def __init__(self, comprehend_client):
"""
:param comprehend_client: A Boto3 Comprehend client.
"""
self.comprehend_client = comprehend_client
def start_job(
self,
job_name,
input_bucket,
input_key,
input_format,
output_bucket,
output_key,
data_access_role_arn,
):
"""
Starts a topic modeling job. Input is read from the specified Amazon S3
input bucket and written to the specified output bucket. Output data is stored
in a tar archive compressed in gzip format. The job runs asynchronously, so you
can call `describe_topics_detection_job` to get job status until it
returns a status of SUCCEEDED.
:param job_name: The name of the job.
:param input_bucket: An Amazon S3 bucket that contains job input.
:param input_key: The prefix used to find input data in the input
bucket. If multiple objects have the same prefix, all
of them are used.
:param input_format: The format of the input data, either one document per
file or one document per line.
:param output_bucket: The Amazon S3 bucket where output data is written.
:param output_key: The prefix prepended to the output data.
:param data_access_role_arn: The Amazon Resource Name (ARN) of a role that
grants Comprehend permission to read from the
input bucket and write to the output bucket.
:return: Information about the job, including the job ID.
"""
try:
response = self.comprehend_client.start_topics_detection_job(
JobName=job_name,
DataAccessRoleArn=data_access_role_arn,
InputDataConfig={
"S3Uri": f"s3://{input_bucket}/{input_key}",
"InputFormat": input_format.value,
},
OutputDataConfig={"S3Uri": f"s3://{output_bucket}/{output_key}"},
)
logger.info("Started topic modeling job %s.", response["JobId"])
except ClientError:
logger.exception("Couldn't start topic modeling job.")
raise
else:
return response
```
+ API の詳細については、*AWS SDK for Python (Boto3) API リファレンス*の「[StartTopicsDetectionJob](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/StartTopicsDetectionJob)」を参照してください。
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cpd#code-examples)での設定と実行の方法を確認してください。
```
TRY.
oo_result = lo_cpd->starttopicsdetectionjob(
iv_jobname = iv_job_name
io_inputdataconfig = NEW /aws1/cl_cpdinputdataconfig(
iv_s3uri = iv_input_s3_uri
iv_inputformat = iv_input_format
)
io_outputdataconfig = NEW /aws1/cl_cpdoutputdataconfig(
iv_s3uri = iv_output_s3_uri
)
iv_dataaccessrolearn = iv_data_access_role_arn
).
MESSAGE 'Topics detection job started.' TYPE 'I'.
CATCH /aws1/cx_cpdinvalidrequestex.
MESSAGE 'Invalid request.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanyrequestsex.
MESSAGE 'Too many requests.' TYPE 'E'.
CATCH /aws1/cx_cpdkmskeyvalidationex.
MESSAGE 'KMS key validation error.' TYPE 'E'.
CATCH /aws1/cx_cpdtoomanytagsex.
MESSAGE 'Too many tags.' TYPE 'E'.
CATCH /aws1/cx_cpdresrclimitexcdex.
MESSAGE 'Resource limit exceeded.' TYPE 'E'.
CATCH /aws1/cx_cpdinternalserverex.
MESSAGE 'Internal server error occurred.' TYPE 'E'.
ENDTRY.
```
+ API の詳細については、 *AWS SDK for SAP ABAP API リファレンス*の[StartTopicsDetectionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)」を参照してください。
------