CreateDocumentClassifier - Amazon Comprehend

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateDocumentClassifier

ドキュメントの分類に使用できる新しいドキュメントの分類子を作成します。分類子を作成するには、使用するカテゴリをラベル付けした一連のトレーニングドキュメントを指定します。分類子のトレーニングが完了したら、分類子を使用して、ラベル付きドキュメントのセットをカテゴリに分類できます。詳細については、「カスタム分類」を参照してください。

リクエストの構文

{ "ClientRequestToken": "string", "DataAccessRoleArn": "string", "DocumentClassifierName": "string", "InputDataConfig": { "AugmentedManifests": [ { "AnnotationDataS3Uri": "string", "AttributeNames": [ "string" ], "DocumentType": "string", "S3Uri": "string", "SourceDocumentsS3Uri": "string", "Split": "string" } ], "DataFormat": "string", "LabelDelimiter": "string", "S3Uri": "string", "TestS3Uri": "string" }, "LanguageCode": "string", "Mode": "string", "ModelKmsKeyId": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "VersionName": "string", "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }

リクエストパラメータ

すべてのアクションに共通のパラメータについては、「」を参照してください。共通パラメータ

リクエストは以下のデータを JSON 形式で受け入れます。

ClientRequestToken

リクエストの一意の識別子。クライアントリクエストトークンを設定しないと、Amazon Comprehend が生成します。

Type: 文字列

制約: 最小長は 1 です。 最大長は 64 です。

Pattern: ^[a-zA-Z0-9-]+$

: 必須 いいえ

DataAccessRoleArn

入力データへの Amazon Comprehend () の読み取りアクセスを付与する AWS Identity and Management (IAM) ロールの Amazon リソースネーム (ARN)。

Type: 文字列

制約: 最小長は 20 です。 最大長は 2048 です。

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

: 必須 はい

DocumentClassifierName

ドキュメント分類子名。

Type: 文字列

制約: 最大長は 63 です。

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

: 必須 はい

InputDataConfig

ジョブの入力データの形式と場所を指定します。

タイプ: DocumentClassifierInputDataConfig オブジェクト

: 必須 はい

LanguageCode

入力ドキュメントの言語。Amazon Comprehend でサポートされる次のいずれかの言語を指定できます。ドイツ語 (「de」)、英語 (「en」)、スペイン語 (「es」)、フランス語 (「fr」)、イタリア語 (「it」)、またはポルトガル語 (「pt」)。すべてのドキュメントは同じ言語でなければなりません。

Type: 文字列

有効な値: en | es | fr | de | it | pt

: 必須 はい

Mode

分類器がトレーニングされるモードを示します。分類器は、ドキュメントごとに 1 つのクラスを識別するマルチクラスモード、またはドキュメントごとに 1 つ以上のラベルを識別するマルチラベルモードで学習できます。マルチラベルモードでは、個々のドキュメントの複数のラベルは区切り文字で区切られます。ラベル間のデフォルトの区切り文字はパイプ (|) です。

Type: 文字列

有効な値: MULTI_CLASS | MULTI_LABEL

: 必須 いいえ

ModelKmsKeyId

Amazon Comprehend がトレーニング済みのカスタムモデルを暗号化するために使用する AWS Key Management (KMS) キーの ID。ModelkmsKeyID は、以下の形式のいずれかになります。

  • KMS キー ID:"1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS キーの Amazon リソースネーム (ARN):"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Type: 文字列

制約: 最大長は 2048 です。

Pattern: .*

: 必須 いいえ

OutputDataConfig

カスタム分類子ジョブの出力結果構成パラメーターの追加を有効にします。

タイプ: DocumentClassifierOutputDataConfig オブジェクト

: 必須 いいえ

Tags

作成するドキュメント分類子に関連付けるタグ。タグは Amazon Comprehend で使用されるリソースにメタデータとして追加するキーと値のペアです。たとえば、「Sales」をキーとするタグがリソースに追加され、営業部門による使用を示す場合があります。

Type: 配列配列Tagobjects

: 必須 いいえ

VersionName

新しく作成された分類子に割り当てられたバージョン名。バージョン名は最大 256 文字です。英数字、ハイフン (-)、アンダースコア (_) を含めることができます。バージョン名は、アカウント/AWS リージョンの同じ分類子名を持つすべてのモデル間で一意であることが必要です。

Type: 文字列

制約: 最大長は 63 です。

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

: 必須 いいえ

VolumeKmsKeyId

分析ジョブを処理する ML コンピューティングインスタンスにアタッチされたストレージボリュームのデータを暗号化するために Amazon Comprehend が使用する AWS Key Management Service (KMS) キーの ID。VolumeKmsKeyId は、以下の形式のいずれかになります。

  • KMS キー ID:"1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS キーの Amazon リソースネーム (ARN):"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Type: 文字列

制約: 最大長は 2048 です。

Pattern: .*

: 必須 いいえ

VpcConfig

カスタム分類子に使用するリソースを含む、オプションのプライベートVirtual Private Cloud (VPC) の設定パラメーター。詳細については、「Amazon VPC 」を参照してください。

タイプ: VpcConfig オブジェクト

: 必須 いいえ

レスポンスの構文

{ "DocumentClassifierArn": "string" }

レスポンス要素

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

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

DocumentClassifierArn

ドキュメント分類子を識別する Amazon リソースネーム (ARN)。

Type: 文字列

制約: 最大長は 256 です。

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Errors

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

InternalServerException

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

HTTP ステータスコード: 500

InvalidRequestException

リクエストは無効でした。

HTTP ステータスコード: 400

KmsKeyValidationException

入力された KMS カスタマー管理キー (CMK) を検証できません。キーを確認し、もう一度入力してください。

HTTP ステータスコード: 400

ResourceInUseException

指定されたリソースの名前は、既に使われています。別の名前を使用してもう一度試します。

HTTP ステータスコード: 400

ResourceLimitExceededException

アカウントあたりのリソースの最大数を超えました。リソースを確認して、リクエストを再度試みてください。

HTTP ステータスコード: 400

TooManyRequestsException

リクエストの数が制限を超えています。後でリクエストを再送信してください。

HTTP ステータスコード: 400

TooManyTagsException

リクエストには、リソースに関連付けることができるより多くのタグが含まれています (リソースあたり 50 タグ)。タグの最大数には、既存のタグと現在のリクエストに含まれるタグの両方が含まれます。

HTTP ステータスコード: 400

UnsupportedLanguageException

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

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。