翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # アクション 以下のアクションがサポートされています: + [AnalyzeDocument](API_AnalyzeDocument.md) + [AnalyzeExpense](API_AnalyzeExpense.md) + [AnalyzeID](API_AnalyzeID.md) + [DetectDocumentText](API_DetectDocumentText.md) + [GetDocumentAnalysis](API_GetDocumentAnalysis.md) + [GetDocumentTextDetection](API_GetDocumentTextDetection.md) + [GetExpenseAnalysis](API_GetExpenseAnalysis.md) + [StartDocumentAnalysis](API_StartDocumentAnalysis.md) + [StartDocumentTextDetection](API_StartDocumentTextDetection.md) + [StartExpenseAnalysis](API_StartExpenseAnalysis.md) # AnalyzeDocument 入力ドキュメントで検出されたアイテム間の関係を分析します。 返される情報のタイプは次のとおりです。 + フォームデータ (キーと値のペア)。2 つの関連情報が返されます[Block](API_Block.md)オブジェクト、各タイプ`KEY_VALUE_SET`: KEY`Block`オブジェクトと VALUE`Block`オブジェクト。たとえば、*名前: アナ・シルバ・カロライナ*キーと値が含まれます。*名前:*が鍵です。*アナ・シルバ・カロライナ*は値です。 + テーブルとテーブルのセルデータ。テーブル`Block`オブジェクトには、検出されたテーブルに関する情報が含まれています。セルのある`Block`オブジェクトは、テーブル内の各セルに対して返されます。 + テキストの行と単語。行線`Block`オブジェクトのある WORD が 1 つ以上含まれています`Block`オブジェクト。ドキュメント内で検出されたすべての行と単語が返されます (の値と関係のないテキストを含む)。`FeatureTypes`). チェックボックスやオプションボタン (ラジオボタン) などの選択要素は、フォームデータやテーブル内で検出できます。セレクションエレメント`Block`オブジェクトには、選択状態など、選択要素に関する情報が含まれます。 実行する解析のタイプは、`FeatureTypes`リスト。 出力は、のリストに返されます。`Block`オブジェクト。 `AnalyzeDocument` は同期演算です。ドキュメントを非同期的に分析するには、[StartDocumentAnalysis](API_StartDocumentAnalysis.md)。 詳細については、「」を参照してください。[ドキュメントテキスト分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## リクエストの構文 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "HumanLoopConfig": { "DataAttributes": { "ContentClassifiers": [ "string" ] }, "FlowDefinitionArn": "string", "HumanLoopName": "string" } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [Document](#API_AnalyzeDocument_RequestSyntax) ** base64 でエンコードされたバイトまたは Amazon S3 オブジェクトとしての入力ドキュメント。AWS CLI を使用して Amazon Textract オペレーションを呼び出す場合、イメージバイトを渡すことはできません。ドキュメントは、JPEG、PNG、PDF、または TIFF 形式の画像である必要があります。 AWS SDK を使用して Amazon Textract を呼び出す場合は、を使用して渡されるイメージバイトを base64 エンコードする必要がない場合があります。`Bytes`フィールド。 型: [Document](API_Document.md) オブジェクト : 必須 はい ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) ** 実行する解析のタイプのリスト。TABLES をリストに追加して、入力ドキュメントで検出されたテーブルに関する情報を返します。FORMS を追加して、検出されたフォームデータを返します。両方のタイプの分析を実行するには、TABLES と FORMS を`FeatureTypes`。ドキュメント内で検出されたすべての行と単語が応答に含まれます（次の値に関連しないテキストを含む）。`FeatureTypes`). Type: 文字列の配列 有効な値: ` TABLES | FORMS` : 必須 はい ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) ** ドキュメントを分析するためのループワークフローで、人間の構成を設定します。 型: [HumanLoopConfig](API_HumanLoopConfig.md) オブジェクト : 必須 いいえ ## レスポンスの構文 ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "HumanLoopActivationOutput": { "HumanLoopActivationConditionsEvaluationResults": "string", "HumanLoopActivationReasons": [ "string" ], "HumanLoopArn": "string" } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) ** ドキュメントの分析に使用されたモデルのバージョン。 Type: 文字列 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) ** によって検出および分析される項目`AnalyzeDocument`。 Type: の配列[Block](API_Block.md)オブジェクト ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) ** 分析されたドキュメントに関するメタデータ。一例はページ数です。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) ** ループ評価で人間の結果を表示します。 型: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。10 MB の同期オペレーションの最大ドキュメントサイズ。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** HumanLoopQuotaExceededException ** 使用可能なループワークフローでアクティブな人間の最大数を超過したことを示します HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeDocument) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument) # AnalyzeExpense `AnalyzeExpense`テキスト間の財政的関連関係について、入力ドキュメントを同期的に分析します。 情報は次のように返されます。`ExpenseDocuments`とし、以下のように分離した。 + `LineItemGroups`-を含むデータセット`LineItems`購入したアイテムや領収書の価格など、テキスト行に関する情報を格納する場所。 + `SummaryFields`-ヘッダー情報や仕入先名など、領収書のその他のすべての情報が含まれます。 ## リクエストの構文 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [Document](#API_AnalyzeExpense_RequestSyntax) ** バイトまたは S3 オブジェクトとしての入力ドキュメント。 イメージのバイトを Amazon Textract API オペレーションに渡すには、`Bytes`プロパティ。たとえば、`Bytes`ローカルファイルシステムからロードされたドキュメントを渡すプロパティです。を使用して渡されるイメージバイト数`Bytes`プロパティは base64 でエンコードされている必要があります。AWS SDK を使用してAmazon Textract API オペレーションを呼び出す場合、コードでは、ドキュメントファイルのバイトをエンコードする必要がない場合があります。 S3 バケットに保存されたイメージを Amazon Textract API オペレーションに渡すには、`S3Object`プロパティ。S3 バケットに保存されたドキュメントは base64 でエンコードする必要はありません。 S3 オブジェクトが含まれている S3 バケットの AWS リージョンと Amazon Textract オペレーションで使用する AWS リージョンが一致している必要があります。 AWS CLI を使用して Amazon Textract オペレーションを呼び出す場合、Bytes プロパティを使用したイメージのバイトを渡すことはサポートされていません。最初に Amazon S3 バケットにドキュメントをアップロードし、次に S3Object プロパティを使用してオペレーションを呼び出します。 Amazon Textract が S3 オブジェクトを処理するには、ユーザーが S3 オブジェクトにアクセスするためのアクセス許可が必要です。 型: [Document](API_Document.md) オブジェクト 必須 はい ## レスポンスの構文 ``` { "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) ** 入力ドキュメントに関する情報。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) ** Amazon Textract によって検出された経費。 Type: 配列の[ExpenseDocument](API_ExpenseDocument.md)オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。10 MB の同期オペレーションの最大ドキュメントサイズ。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeExpense) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense) # AnalyzeID アイデンティティドキュメントを分析し、関連情報を確認します。この情報は抽出され、次のように返されます。`IdentityDocumentFields`。抽出されたテキストの正規化されたフィールドと値の両方を記録します。他の Amazon Textract オペレーションとは異なり、`AnalyzeID`は Geometry データを返しません。 ## リクエストの構文 ``` { "DocumentPages": [ { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } ] } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) ** AnalyzeID に渡されるドキュメント。 Type: 配列の[Document](API_Document.md)オブジェクト 配列メンバー: 最小数は 1 項目です。最大数は 2 項目です。 必須 はい ## レスポンスの構文 ``` { "AnalyzeIDModelVersion": "string", "DocumentMetadata": { "Pages": number }, "IdentityDocuments": [ { "DocumentIndex": number, "IdentityDocumentFields": [ { "Type": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" }, "ValueDetection": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" } } ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) ** ドキュメントの処理に使用されている AnalyzeIdentity API のバージョン。 Type: 文字列 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) ** 入力ドキュメントに関する情報。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) ** AnalyzeID によって処理されるドキュメントのリスト。リスト内での位置を示す数字と、ドキュメントの応答構造が含まれます。 Type: 配列の[IdentityDocument](API_IdentityDocument.md)オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。10 MB 同期オペレーションの最大ドキュメントサイズ。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeID) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID) # DetectDocumentText 入力ドキュメント内のテキストを検出します。Amazon Textract では、テキスト行とテキスト行を構成する単語を検出できます。入力ドキュメントは、JPEG、PNG、PDF、または TIFF 形式の画像である必要があります。`DetectDocumentText`検出されたテキストを次の配列で返します。[Block](API_Block.md)オブジェクト。 各ドキュメントページには、`Block`タイプの PAGE。各ページ`Block`オブジェクトはLINEの親です`Block`ページ上で検出されたテキストの行を表すオブジェクト。[1 行]`Block`オブジェクトは、行を構成する各単語の親です。単語は次のように表されます。`Block`WORD 型のオブジェクト。 `DetectDocumentText` は同期演算です。ドキュメントを非同期的に分析するには、[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。 詳細については、「」を参照してください。[ドキュメントのテキストの検出](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## リクエストの構文 ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [Document](#API_DetectDocumentText_RequestSyntax) ** base64 でエンコードされたバイトまたは Amazon S3 オブジェクトとしての入力ドキュメント。AWS CLI を使用して Amazon Textract オペレーションを呼び出す場合、イメージバイトを渡すことはできません。ドキュメントは、JPEG または PNG 形式であることが必要です。 AWS SDK を使用して Amazon Textract を呼び出す場合は、を使用して渡されるイメージバイトを base64 エンコードする必要がない場合があります。`Bytes`フィールド。 型: [Document](API_Document.md) オブジェクト : 必須 はい ## レスポンスの構文 ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) ** の配列`Block`文書内で検出されたテキストを含むオブジェクト。 Type: の配列[Block](API_Block.md)オブジェクト ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) ** Type: 文字列 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) ** ドキュメントに関するメタデータ。ドキュメント内で検出されたページ数が含まれます。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。10 MB の同期オペレーションの最大ドキュメントサイズ。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DetectDocumentText) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText) # GetDocumentAnalysis ドキュメント内のテキストを分析する Amazon Textract 非同期オペレーションの結果を取得します。 非同期テキスト分析を開始するには、を呼び出します。[StartDocumentAnalysis](API_StartDocumentAnalysis.md)。ジョブ識別子 (`JobId`). テキスト分析操作が完了すると、Amazon Textract は、への最初の呼び出しに登録された Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスを公開します。`StartDocumentAnalysis`。テキスト検出操作の結果を取得するには、まず Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください`GetDocumentAnalysis`をクリックし、ジョブ識別子を渡します (`JobId`) の最初の呼び出しから`StartDocumentAnalysis`。 `GetDocumentAnalysis`の配列を返します。[Block](API_Block.md)オブジェクト。次のタイプの情報が返されます。 + フォームデータ (キーと値のペア)。関連情報は 2 つで返されます。[Block](API_Block.md)オブジェクト、各タイプ`KEY_VALUE_SET`: Key`Block`オブジェクトと VALUE`Block`オブジェクト。たとえば、*名前: アナ・シルバ・カロライナ*キーと値が含まれます。*名前:*が鍵です。*アナ・シルバ・カロライナ*は値です。 + 表および表のセルデータ。テーブル`Block`オブジェクトには、検出されたテーブルに関する情報が含まれています。セルのある`Block`オブジェクトは、テーブル内の各セルに対して返されます。 + テキストの行と単語。[1 行]`Block`オブジェクトには、1 つ以上の WORD が含まれています`Block`オブジェクト。ドキュメント内で検出されたすべての行と単語が返されます (文字列の値と関係のないテキストを含む)。`StartDocumentAnalysis` `FeatureTypes`入力パラメータ)。 チェックボックスやオプションボタン (ラジオボタン) などの選択要素は、フォームデータやテーブル内で検出できます。セレクションエレメント`Block`オブジェクトには、選択状態など、選択要素に関する情報が含まれます。 を使用する`MaxResults`返されるブロックの数を制限するパラメータです。で指定した数を超える結果がある場合`MaxResults`とすると、の値`NextToken`オペレーションのレスポンスは、次の結果セットを取得するためのページ割りトークンが含まれています。次の結果ページを取得したい場合`GetDocumentAnalysis`を設定し、`NextToken`前回の呼び出しから返されたトークン値を持つリクエストパラメータ`GetDocumentAnalysis`。 詳細については、「」を参照してください。[ドキュメントテキスト分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## リクエストの構文 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) ** テキスト検出ジョブの一意の識別子。-`JobId`から返されました`StartDocumentAnalysis`。ある`JobId`値は 7 日間だけ有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` 必須: はい ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) ** ページ割りコールごとに返す結果の最大数。指定できる最大値は 1,000 です。1,000 より大きい値を指定した場合、最大 1,000 件の結果が返されます。デフォルト値は 1,000 です。 Type: 整数 有効範囲: 最小値は 1 です。 必須: いいえ ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) ** 前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` 必須: いいえ ## レスポンスの構文 ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) ** Type: 文字列 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) ** テキスト分析操作の結果。 Type: の配列[Block](API_Block.md)オブジェクト ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) ** Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract ビデオオペレーションからページ分割されたレスポンスの各ページに返されます。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) ** テキスト検出ジョブの現在のステータス。 Type: 文字列 有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) ** レスポンスが切り捨てられた場合、Amazon Textract はこのトークンを返します。次のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) ** 検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。 Type: 文字列 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) ** ドキュメント分析操作中に発生した警告のリスト。 Type: の配列[Warning](API_Warning.md)オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidJobIdException ** 無効なジョブ識別子が渡されました[GetDocumentAnalysis](#API_GetDocumentAnalysis)または[GetDocumentAnalysis](#API_GetDocumentAnalysis)。 HTTP ステータスコード: 400 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentAnalysis) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis) # GetDocumentTextDetection ドキュメント内のテキストを検出する Amazon Textract 非同期オペレーションの結果を取得します。Amazon Textract では、テキスト行とテキスト行を構成する単語を検出できます。 非同期テキスト検出を開始するには、を呼び出します。[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。ジョブ識別子 (`JobId`). テキスト検出操作が完了すると、Amazon Textract は、への最初の呼び出しに登録された Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスを公開します。`StartDocumentTextDetection`。テキスト検出操作の結果を取得するには、まず Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください`GetDocumentTextDetection`を選択し、ジョブ識別子を渡します (`JobId`) の最初の呼び出しから`StartDocumentTextDetection`。 `GetDocumentTextDetection`の配列を返します。[Block](API_Block.md)オブジェクト。 各ドキュメントページには、`Block`タイプの PAGE。各ページ`Block`オブジェクトは LINE の親です`Block`ページ上で検出されたテキストの行を表すオブジェクト。行です`Block`オブジェクトは、行を構成する各単語の親です。単語は次のように表されます。`Block`WORD 型のオブジェクト。 MaxResults パラメーターを使用して、返されるブロックの数を制限します。で指定した数を超える結果がある場合`MaxResults`とすると、の値`NextToken`オペレーションのレスポンスには、次の結果セットを取得するためのページ割りトークンが含まれています。次の結果ページを取得するには、`GetDocumentTextDetection`を入力し、`NextToken`前回の呼び出しから返されたトークン値を持つリクエストパラメータ`GetDocumentTextDetection`。 詳細については、「」を参照してください。[ドキュメントのテキストの検出](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## リクエストの構文 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) ** テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartDocumentTextDetection`。ある`JobId`値は 7 日間だけ有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` : 必須 はい ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) ** ページ割りコールごとに返す結果の最大数。指定できる最大値は 1,000 です。1,000 より大きい値を指定した場合、最大 1,000 件の結果が返されます。デフォルト値は 1,000 です。 Type: 整数 有効範囲: 最小値は 1 です。 : 必須 いいえ ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) ** 前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` : 必須 いいえ ## レスポンスの構文 ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Id": "string", "Page": number, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) ** テキスト検出操作の結果。 Type: の配列[Block](API_Block.md)オブジェクト ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) ** Type: 文字列 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) ** Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract ビデオオペレーションからページ分割されたレスポンスの各ページに返されます。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) ** テキスト検出ジョブの現在のステータス。 Type: 文字列 有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) ** レスポンスが切り捨てられると、Amazon Textract はこのトークンを返します。後続のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) ** 検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。 Type: 文字列 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) ** ドキュメントのテキスト検出操作中に発生した警告のリスト。 Type: の配列[Warning](API_Warning.md)オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidJobIdException ** 無効なジョブ識別子が渡されました[GetDocumentAnalysis](API_GetDocumentAnalysis.md)または[GetDocumentAnalysis](API_GetDocumentAnalysis.md)。 HTTP ステータスコード: 400 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetDocumentTextDetection) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) # GetExpenseAnalysis 請求書と領収書を分析する Amazon Textract 非同期オペレーションの結果を取得します。Amazon Textract は、入力された請求書と領収書から、連絡先情報、購入した商品、およびベンダー名を検索します。 非同期請求書/領収書の分析を開始するには、[StartExpenseAnalysis](API_StartExpenseAnalysis.md)。ジョブ識別子 (`JobId`). 請求書/領収分析が完了すると、Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスが発行されます。このトピックは、への最初の呼び出しで登録する必要があります。`StartExpenseAnalysis`。請求書/領収分析オペレーションの結果を取得するには、Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください`GetExpenseAnalysis`を選択し、ジョブ識別子を渡します (`JobId`) を最初の呼び出しから`StartExpenseAnalysis`。 MaxResults パラメーターを使用して、返されるブロックの数を制限します。で指定した数を超える結果がある場合`MaxResults`とすると、の値`NextToken`オペレーションレスポンスには、次の結果セットを取得するためのページ割りトークンが含まれています。次の結果ページを取得するには、`GetExpenseAnalysis`を入力し、`NextToken`前回の呼び出しから返されたトークン値を持つリクエストパラメータ`GetExpenseAnalysis`。 詳細については、「」を参照してください。[請求書と領収書の分析](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html)。 ## リクエストの構文 ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) ** テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartExpenseAnalysis`。ある`JobId`値は 7 日間だけ有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` 必須: はい ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) ** ページ割りコールごとに返す結果の最大数。指定できる最大値は 20 です。20 より大きい値を指定した場合、最大 20 件の結果が返されます。デフォルト値は 20 です。 Type: 整数 有効範囲: 最小値は 1 です。 必須: いいえ ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) ** 前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` 必須: いいえ ## レスポンスの構文 ``` { "AnalyzeExpenseModelVersion": "string", "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ] }, "Text": "string" } } ] } ], "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) ** AnalyzeExpense の現在のモデルバージョンです。 Type: 文字列 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) ** Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract オペレーションからページ分割されたレスポンスの各ページに返されます。 型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) ** Amazon Textract によって検出された経費。 Type: 配列の[ExpenseDocument](API_ExpenseDocument.md)オブジェクト ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) ** テキスト検出ジョブの現在のステータス。 Type: 文字列 有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) ** レスポンスが切り捨てられると、Amazon Textract はこのトークンを返します。後続のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 255 です。 パターン: `.*\S.*` ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) ** 検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。 Type: 文字列 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) ** ドキュメントのテキスト検出操作中に発生した警告のリスト。 Type: 配列の[Warning](API_Warning.md)オブジェクト ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidJobIdException ** 無効なジョブ識別子が渡されました[GetDocumentAnalysis](API_GetDocumentAnalysis.md)または[GetDocumentAnalysis](API_GetDocumentAnalysis.md)。 HTTP ステータスコード: 400 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/GetExpenseAnalysis) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis) # StartDocumentAnalysis キーと値のペア、表、選択要素など、検出された項目間のリレーションシップについて、入力ドキュメントの非同期分析を開始します。 `StartDocumentAnalysis`では、JPEG、PNG、TIFF、および PDF 形式のドキュメント内のテキストを分析できます。ドキュメントは Amazon S3 バケットに格納されます。を使用する[DocumentLocation](API_DocumentLocation.md)を使用して、ドキュメントのバケット名とファイル名を指定します。 `StartDocumentAnalysis`ジョブ識別子を返します (`JobId`) を使用して、オペレーションの結果を取得します。テキスト分析が完了すると、Amazon Textract は、で指定した Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスを発行します。`NotificationChannel`。テキスト分析操作の結果を取得するには、まず Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください[GetDocumentAnalysis](API_GetDocumentAnalysis.md)をクリックし、ジョブ識別子を渡します (`JobId`) の最初の呼び出しから`StartDocumentAnalysis`。 詳細については、「」を参照してください。[ドキュメントテキスト分析](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html)。 ## リクエストの構文 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) ** 開始リクエストを識別するために使用するべき等トークン。同じトークンを複数で使用する場合`StartDocumentAnalysis`リクエスト、同じ`JobId`が返されます。を使用する`ClientRequestToken`同じジョブが誤って複数回開始されないようにするためです。詳細については、「」を参照してください。[Amazon Textract 非同期オペレーションを呼び出す](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` 必須: いいえ ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) ** 処理されるドキュメントの場所。 型: [DocumentLocation](API_DocumentLocation.md) オブジェクト 必須: はい ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) ** 実行する解析のタイプのリスト。TABLES をリストに追加して、入力ドキュメントで検出されたテーブルに関する情報を返します。FORMS を追加して、検出されたフォームデータを返します。両方のタイプの分析を実行するには、TABLES と FORMS を`FeatureTypes`。ドキュメント内で検出されたすべての行と単語が応答に含まれます（次の値に関連しないテキストを含む）`FeatureTypes`). Type: 文字列の配列 有効な値: ` TABLES | FORMS` 必須: はい ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) ** Amazon SNS トピックに対して発行される完了通知に含まれる、指定する識別子。例えば、次を使用できます。`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `[a-zA-Z0-9_.\-:]+` 必須: いいえ ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) ** 推論結果の暗号化に使用される KMS キー。これは、キー ID 形式またはキーエイリアス形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。 パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` 必須: いいえ ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) ** Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。 型: [NotificationChannel](API_NotificationChannel.md) オブジェクト 必須: いいえ ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) ** 出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は内部的に結果を保存し、GetDocumentAnalysis s オペレーションによってアクセスされます。 型: [OutputConfig](API_OutputConfig.md) オブジェクト 必須: いいえ ## レスポンスの構文 ``` { "JobId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) ** ドキュメントテキスト検出ジョブの識別子。を使用する`JobId`以降の呼び出しでジョブを識別するには`GetDocumentAnalysis`。ある`JobId`値は 7 日間だけ有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。同期オペレーションの最大ドキュメントサイズ 10 MB。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** IdempotentParameterMismatchException ** ある`ClientRequestToken`入力パラメータがオペレーションに再利用されましたが、他の入力パラメータの少なくとも 1 つが、オペレーションに対する前回の呼び出しとは異なります。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、を参照してください。[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** LimitExceededException ** Amazon Textract サービスの制限を超えました。たとえば、同時起動する非同期ジョブが多すぎると、オペレーションの開始を呼び出します (`StartDocumentTextDetection`たとえば、) 同時に実行されるジョブの数が Amazon Textract のサービスの制限を下回るまで、limitExceptionException の例外 (HTTP ステータスコード:400) を受け取ります。 HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この上限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentAnalysis) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis) # StartDocumentTextDetection ドキュメント内のテキストの非同期検出を開始します。Amazon Textract では、テキスト行とテキスト行を構成する単語を検出できます。 `StartDocumentTextDetection`では、JPEG、PNG、TIFF、および PDF 形式のドキュメント内のテキストを分析できます。ドキュメントは Amazon S3 バケットに格納されます。を使用する[DocumentLocation](API_DocumentLocation.md)を選択して、ドキュメントのバケット名とファイル名を指定します。 `StartTextDetection`ジョブ識別子を返します (`JobId`) を使用して、オペレーションの結果を取得します。テキストの検出が完了すると、Amazon Textract は、で指定した Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスを発行します。`NotificationChannel`。テキスト検出操作の結果を取得するには、まず Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください[GetDocumentTextDetection](API_GetDocumentTextDetection.md)をクリックし、ジョブ識別子を渡します (`JobId`) の最初の呼び出しから`StartDocumentTextDetection`。 詳細については、「」を参照してください。[ドキュメントのテキストの検出](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html)。 ## リクエストの構文 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) ** 開始リクエストを識別するために使用されるべき等トークン。複数で同じトークンを使用する場合`StartDocumentTextDetection`リクエスト、同じ`JobId`が返されました。を使用する`ClientRequestToken`同じジョブが誤って複数回開始されないようにする。詳細については、「」を参照してください。[Amazon Textract 非同期オペレーションを呼び出す](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` 必須: いいえ ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) ** 処理されるドキュメントの場所。 型: [DocumentLocation](API_DocumentLocation.md) オブジェクト 必須: はい ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) ** Amazon SNS トピックに対して発行される完了通知に含まれる、指定した ID。例えば、`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `[a-zA-Z0-9_.\-:]+` 必須: いいえ ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) ** 推論結果の暗号化に使用される KMS キーです。これは、キー ID またはキーエイリアスの形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。 パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` 必須: いいえ ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) ** Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。 型: [NotificationChannel](API_NotificationChannel.md) オブジェクト 必須: いいえ ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) ** 出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は、GetDocumentTextDetection オペレーションでアクセスするために内部的に結果を保存します。 型: [OutputConfig](API_OutputConfig.md) オブジェクト 必須: いいえ ## レスポンスの構文 ``` { "JobId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) ** ドキュメントのテキスト検出ジョブの識別子。を使用する`JobId`以降の呼び出しでジョブを識別するには`GetDocumentTextDetection`。ある`JobId`値は 7 日間有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。同期オペレーションの最大ドキュメントサイズは 10 MB です。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** IdempotentParameterMismatchException ** ある`ClientRequestToken`入力パラメータがオペレーションで再利用されましたが、他の入力パラメータの少なくとも 1 つが、オペレーションに対する前回の呼び出しとは異なります。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。詳細については、[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** LimitExceededException ** Amazon Textract のサービスの制限を超えました。たとえば、同時起動する非同期ジョブが多すぎると、オペレーションの開始を呼び出します (`StartDocumentTextDetection`たとえば、LimitExceededException の例外 (HTTP ステータスコード:400) を受け取ります。同時に実行されるジョブの数が Amazon Textract のサービスの制限を下回るまで、limitException の例外 (HTTP ステータスコード:400) を受け取ります。 HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この制限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartDocumentTextDetection) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection) # StartExpenseAnalysis 連絡先情報、購入品目、仕入先名などのデータの請求書または領収書の非同期分析を開始します。 `StartExpenseAnalysis`では、JPEG、PNG、および PDF 形式のドキュメント内のテキストを分析できます。ドキュメントは Amazon S3 バケットに格納する必要があります。を使用する[DocumentLocation](API_DocumentLocation.md)パラメータを使用して、S3 バケットの名前と、バケット内のドキュメントの名前を指定します。 `StartExpenseAnalysis`ジョブ識別子を返します (`JobId`) に提供すること`GetExpenseAnalysis`を選択して、オペレーションの結果を取得します。入力請求書/領収書の分析が完了すると、Amazon Textract は、指定した Amazon Simple Notification Service (Amazon SNS) トピックに完了ステータスを発行します。`NotificationChannel`。請求書および領収書の分析操作の結果を取得するには、Amazon SNS トピックに発行されたステータス値が`SUCCEEDED`。もしそうなら、電話してください[GetExpenseAnalysis](API_GetExpenseAnalysis.md)をクリックし、ジョブ識別子を渡します (`JobId`) への呼び出しによって返された`StartExpenseAnalysis`。 詳細については、「」を参照してください。[請求書と領収書の分析](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html)。 ## リクエストの構文 ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## リクエストパラメータ リクエストは以下の JSON 形式のデータを受け入れます。 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) ** 開始リクエストを識別するために使用されるべき等トークン。同じトークンを複数で使用する場合`StartDocumentTextDetection`リクエスト、同じ`JobId`が返されます。を使用する`ClientRequestToken`同じジョブが誤って複数回開始されないようにするためです。詳細については、「」を参照してください。[Amazon Textract 非同期オペレーションを呼び出す](https://docs.aws.amazon.com/textract/latest/dg/api-async.html) Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` 必須: いいえ ** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) ** 処理されるドキュメントの場所。 型: [DocumentLocation](API_DocumentLocation.md) オブジェクト 必須: はい ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) ** Amazon SNS トピックに対して発行される完了通知に含まれる、指定した ID。たとえば、を使用できます。`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `[a-zA-Z0-9_.\-:]+` 必須: いいえ ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) ** 推論結果の暗号化に使用される KMS キー。これは、キー ID またはキーエイリアスの形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。 パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` 必須: いいえ ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) ** Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。 型: [NotificationChannel](API_NotificationChannel.md) オブジェクト 必須: いいえ ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) ** 出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は内部的に結果を保存し、`GetExpenseAnalysis`オペレーション. 型: [OutputConfig](API_OutputConfig.md) オブジェクト 必須: いいえ ## レスポンスの構文 ``` { "JobId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) ** テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartExpenseAnalysis`。ある`JobId`値は 7 日間有効です。 Type: 文字列 長さの制約: 最小長は 1 です｡ 最大長は 64 です。 パターン: `^[a-zA-Z0-9-_]+$` ## エラー ** AccessDeniedException ** そのアクションを実行する権限がありません。そのオペレーションを実行するには、承認されたユーザーまたは IAM ロールの Amazon リソースネーム (ARN) を使用します。 HTTP ステータスコード: 400 ** BadDocumentException ** Amazon Textract はドキュメントを読み取ることができません。Amazon Textract のドキュメント制限の詳細については、「」を参照してください。[Amazon Textract のハード制限](limits.md)。 HTTP ステータスコード: 400 ** DocumentTooLargeException ** 文書が大きすぎるため処理できません。同期オペレーションの最大ドキュメントサイズ 10 MB。非同期操作の最大ドキュメントサイズは、PDF ファイルの場合 500 MB です。 HTTP ステータスコード: 400 ** IdempotentParameterMismatchException ** ある`ClientRequestToken`入力パラメータがオペレーションで再利用されましたが、他の入力パラメータの少なくとも 1 つが、オペレーションに対する前回の呼び出しとは異なります。 HTTP ステータスコード: 400 ** InternalServerError ** Amazon Textract でサービスの問題が発生しました。もう一度やり直してください。 HTTP ステータスコード: 500 ** InvalidKMSKeyException ** KMS キーが入力された状態で復号化権限がないか、KMS キーが誤って入力されたことを示します。 HTTP ステータスコード: 400 ** InvalidParameterException ** 入力パラメータが制約に違反しています。たとえば、同期操作では、`InvalidParameterException`例外が発生するのは、どちらも`S3Object`または`Bytes`値は、`Document`リクエストパラメータ。API オペレーションを再度呼び出す前にパラメータを検証します。 HTTP ステータスコード: 400 ** InvalidS3ObjectException ** Amazon Textract は、リクエストで指定された S3 オブジェクトにアクセスできません。[Amazon S3 へのアクセスの設定](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)トラブルシューティング情報については、「」を参照してください。[Amazon S3 トラブルシューティング](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP ステータスコード: 400 ** LimitExceededException ** Amazon Textract サービスの制限を超えました。たとえば、同時起動する非同期ジョブが多すぎると、オペレーションの開始を呼び出します (`StartDocumentTextDetection`たとえば、) 同時に実行されるジョブの数が Amazon Textract のサービスの制限を下回るまで、limitExceptedException の例外 (HTTP ステータスコード:400) を受け取ります。 HTTP ステータスコード: 400 ** ProvisionedThroughputExceededException ** お客様のスループット制限を超えたリクエストの数。この制限を引き上げる場合は、Amazon Textract までお問い合わせください。 HTTP ステータスコード: 400 ** ThrottlingException ** Amazon Textract は一時的にリクエストを処理できませんでした。もう一度やり直してください。 HTTP ステータスコード: 500 ** UnsupportedDocumentException ** 入力ドキュメントの形式はサポートされていません。操作用のドキュメントは、PNG、JPEG、PDF、または TIFF 形式にすることができます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください： + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/StartExpenseAnalysis) + [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)