

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

# API リファレンス
<a name="API_Reference"></a>

 このセクションでは、Amazon Textract API オペレーションについて説明します。

**Topics**
+ [アクション](API_Operations.md)
+ [データ型](API_Types.md)

# アクション
<a name="API_Operations"></a>

以下のアクションがサポートされています:
+  [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
<a name="API_AnalyzeDocument"></a>

入力ドキュメントで検出されたアイテム間の関係を分析します。

返される情報のタイプは次のとおりです。
+ フォームデータ (キーと値のペア)。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)。

## リクエストの構文
<a name="API_AnalyzeDocument_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "HumanLoopConfig": { 
      "DataAttributes": { 
         "ContentClassifiers": [ "string" ]
      },
      "FlowDefinitionArn": "string",
      "HumanLoopName": "string"
   }
}
```

## リクエストパラメータ
<a name="API_AnalyzeDocument_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
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) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
実行する解析のタイプのリスト。TABLES をリストに追加して、入力ドキュメントで検出されたテーブルに関する情報を返します。FORMS を追加して、検出されたフォームデータを返します。両方のタイプの分析を実行するには、TABLES と FORMS を`FeatureTypes`。ドキュメント内で検出されたすべての行と単語が応答に含まれます（次の値に関連しないテキストを含む）。`FeatureTypes`).  
Type: 文字列の配列  
有効な値: ` TABLES | FORMS`   
: 必須 はい

 ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
ドキュメントを分析するためのループワークフローで、人間の構成を設定します。  
型: [HumanLoopConfig](API_HumanLoopConfig.md) オブジェクト  
: 必須 いいえ

## レスポンスの構文
<a name="API_AnalyzeDocument_ResponseSyntax"></a>

```
{
   "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"
   }
}
```

## レスポンス要素
<a name="API_AnalyzeDocument_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
ドキュメントの分析に使用されたモデルのバージョン。  
Type: 文字列

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
によって検出および分析される項目`AnalyzeDocument`。  
Type: の配列[Block](API_Block.md)オブジェクト

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
分析されたドキュメントに関するメタデータ。一例はページ数です。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
ループ評価で人間の結果を表示します。  
型: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) オブジェクト

## エラー
<a name="API_AnalyzeDocument_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_AnalyzeDocument_SeeAlso"></a>

言語固有の 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
<a name="API_AnalyzeExpense"></a>

 `AnalyzeExpense`テキスト間の財政的関連関係について、入力ドキュメントを同期的に分析します。

情報は次のように返されます。`ExpenseDocuments`とし、以下のように分離した。
+  `LineItemGroups`-を含むデータセット`LineItems`購入したアイテムや領収書の価格など、テキスト行に関する情報を格納する場所。
+  `SummaryFields`-ヘッダー情報や仕入先名など、領収書のその他のすべての情報が含まれます。

## リクエストの構文
<a name="API_AnalyzeExpense_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## リクエストパラメータ
<a name="API_AnalyzeExpense_RequestParameters"></a>

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

 ** [Document](#API_AnalyzeExpense_RequestSyntax) **   <a name="Textract-AnalyzeExpense-request-Document"></a>
バイトまたは 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) オブジェクト  
必須 はい

## レスポンスの構文
<a name="API_AnalyzeExpense_ResponseSyntax"></a>

```
{
   "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"
               }
            }
         ]
      }
   ]
}
```

## レスポンス要素
<a name="API_AnalyzeExpense_ResponseElements"></a>

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

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

 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-DocumentMetadata"></a>
入力ドキュメントに関する情報。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-ExpenseDocuments"></a>
Amazon Textract によって検出された経費。  
Type: 配列の[ExpenseDocument](API_ExpenseDocument.md)オブジェクト

## エラー
<a name="API_AnalyzeExpense_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_AnalyzeExpense_SeeAlso"></a>

言語固有の 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
<a name="API_AnalyzeID"></a>

アイデンティティドキュメントを分析し、関連情報を確認します。この情報は抽出され、次のように返されます。`IdentityDocumentFields`。抽出されたテキストの正規化されたフィールドと値の両方を記録します。他の Amazon Textract オペレーションとは異なり、`AnalyzeID`は Geometry データを返しません。

## リクエストの構文
<a name="API_AnalyzeID_RequestSyntax"></a>

```
{
   "DocumentPages": [ 
      { 
         "Bytes": blob,
         "S3Object": { 
            "Bucket": "string",
            "Name": "string",
            "Version": "string"
         }
      }
   ]
}
```

## リクエストパラメータ
<a name="API_AnalyzeID_RequestParameters"></a>

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

 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) **   <a name="Textract-AnalyzeID-request-DocumentPages"></a>
AnalyzeID に渡されるドキュメント。  
Type: 配列の[Document](API_Document.md)オブジェクト  
配列メンバー: 最小数は 1 項目です。最大数は 2 項目です。  
必須 はい

## レスポンスの構文
<a name="API_AnalyzeID_ResponseSyntax"></a>

```
{
   "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"
               }
            }
         ]
      }
   ]
}
```

## レスポンス要素
<a name="API_AnalyzeID_ResponseElements"></a>

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

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

 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-AnalyzeIDModelVersion"></a>
ドキュメントの処理に使用されている AnalyzeIdentity API のバージョン。  
Type: 文字列

 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-DocumentMetadata"></a>
入力ドキュメントに関する情報。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-IdentityDocuments"></a>
AnalyzeID によって処理されるドキュメントのリスト。リスト内での位置を示す数字と、ドキュメントの応答構造が含まれます。  
Type: 配列の[IdentityDocument](API_IdentityDocument.md)オブジェクト

## エラー
<a name="API_AnalyzeID_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_AnalyzeID_SeeAlso"></a>

言語固有の 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
<a name="API_DetectDocumentText"></a>

入力ドキュメント内のテキストを検出します。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)。

## リクエストの構文
<a name="API_DetectDocumentText_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## リクエストパラメータ
<a name="API_DetectDocumentText_RequestParameters"></a>

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

 ** [Document](#API_DetectDocumentText_RequestSyntax) **   <a name="Textract-DetectDocumentText-request-Document"></a>
base64 でエンコードされたバイトまたは Amazon S3 オブジェクトとしての入力ドキュメント。AWS CLI を使用して Amazon Textract オペレーションを呼び出す場合、イメージバイトを渡すことはできません。ドキュメントは、JPEG または PNG 形式であることが必要です。  
AWS SDK を使用して Amazon Textract を呼び出す場合は、を使用して渡されるイメージバイトを base64 エンコードする必要がない場合があります。`Bytes`フィールド。  
型: [Document](API_Document.md) オブジェクト  
: 必須 はい

## レスポンスの構文
<a name="API_DetectDocumentText_ResponseSyntax"></a>

```
{
   "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
   }
}
```

## レスポンス要素
<a name="API_DetectDocumentText_ResponseElements"></a>

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

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

 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-Blocks"></a>
の配列`Block`文書内で検出されたテキストを含むオブジェクト。  
Type: の配列[Block](API_Block.md)オブジェクト

 ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DetectDocumentTextModelVersion"></a>
  
Type: 文字列

 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DocumentMetadata"></a>
ドキュメントに関するメタデータ。ドキュメント内で検出されたページ数が含まれます。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

## エラー
<a name="API_DetectDocumentText_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_DetectDocumentText_SeeAlso"></a>

言語固有の 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
<a name="API_GetDocumentAnalysis"></a>

ドキュメント内のテキストを分析する 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)。

## リクエストの構文
<a name="API_GetDocumentAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメータ
<a name="API_GetDocumentAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-JobId"></a>
テキスト検出ジョブの一意の識別子。-`JobId`から返されました`StartDocumentAnalysis`。ある`JobId`値は 7 日間だけ有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$`   
必須: はい

 ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-MaxResults"></a>
ページ割りコールごとに返す結果の最大数。指定できる最大値は 1,000 です。1,000 より大きい値を指定した場合、最大 1,000 件の結果が返されます。デフォルト値は 1,000 です。  
Type: 整数  
有効範囲: 最小値は 1 です。  
必須: いいえ

 ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-NextToken"></a>
前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*`   
必須: いいえ

## レスポンスの構文
<a name="API_GetDocumentAnalysis_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## レスポンス要素
<a name="API_GetDocumentAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-AnalyzeDocumentModelVersion"></a>
  
Type: 文字列

 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Blocks"></a>
テキスト分析操作の結果。  
Type: の配列[Block](API_Block.md)オブジェクト

 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-DocumentMetadata"></a>
Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract ビデオオペレーションからページ分割されたレスポンスの各ページに返されます。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-JobStatus"></a>
テキスト検出ジョブの現在のステータス。  
Type: 文字列  
有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-NextToken"></a>
レスポンスが切り捨てられた場合、Amazon Textract はこのトークンを返します。次のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-StatusMessage"></a>
検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。  
Type: 文字列

 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Warnings"></a>
ドキュメント分析操作中に発生した警告のリスト。  
Type: の配列[Warning](API_Warning.md)オブジェクト

## エラー
<a name="API_GetDocumentAnalysis_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_GetDocumentAnalysis_SeeAlso"></a>

言語固有の 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
<a name="API_GetDocumentTextDetection"></a>

ドキュメント内のテキストを検出する 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)。

## リクエストの構文
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメータ
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

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

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartDocumentTextDetection`。ある`JobId`値は 7 日間だけ有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$`   
: 必須 はい

 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
ページ割りコールごとに返す結果の最大数。指定できる最大値は 1,000 です。1,000 より大きい値を指定した場合、最大 1,000 件の結果が返されます。デフォルト値は 1,000 です。  
Type: 整数  
有効範囲: 最小値は 1 です。  
: 必須 いいえ

 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*`   
: 必須 いいえ

## レスポンスの構文
<a name="API_GetDocumentTextDetection_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## レスポンス要素
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

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

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

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
テキスト検出操作の結果。  
Type: の配列[Block](API_Block.md)オブジェクト

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
Type: 文字列

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract ビデオオペレーションからページ分割されたレスポンスの各ページに返されます。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
テキスト検出ジョブの現在のステータス。  
Type: 文字列  
有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
レスポンスが切り捨てられると、Amazon Textract はこのトークンを返します。後続のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。  
Type: 文字列

 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
ドキュメントのテキスト検出操作中に発生した警告のリスト。  
Type: の配列[Warning](API_Warning.md)オブジェクト

## エラー
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

言語固有の 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
<a name="API_GetExpenseAnalysis"></a>

請求書と領収書を分析する 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)。

## リクエストの構文
<a name="API_GetExpenseAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## リクエストパラメータ
<a name="API_GetExpenseAnalysis_RequestParameters"></a>

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

 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-JobId"></a>
テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartExpenseAnalysis`。ある`JobId`値は 7 日間だけ有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$`   
必須: はい

 ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-MaxResults"></a>
ページ割りコールごとに返す結果の最大数。指定できる最大値は 20 です。20 より大きい値を指定した場合、最大 20 件の結果が返されます。デフォルト値は 20 です。  
Type: 整数  
有効範囲: 最小値は 1 です。  
必須: いいえ

 ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-NextToken"></a>
前のレスポンスが不完全だった場合 (取得するブロックが多いため)、Amazon Textract はレスポンスでページ割りトークンを返します。このページ割りトークンを使用して、次のブロックのセットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*`   
必須: いいえ

## レスポンスの構文
<a name="API_GetExpenseAnalysis_ResponseSyntax"></a>

```
{
   "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 ]
      }
   ]
}
```

## レスポンス要素
<a name="API_GetExpenseAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-AnalyzeExpenseModelVersion"></a>
AnalyzeExpense の現在のモデルバージョンです。  
Type: 文字列

 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-DocumentMetadata"></a>
Amazon Textract が処理したドキュメントに関する情報。`DocumentMetadata`は、Amazon Textract オペレーションからページ分割されたレスポンスの各ページに返されます。  
型: [DocumentMetadata](API_DocumentMetadata.md) オブジェクト

 ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-ExpenseDocuments"></a>
Amazon Textract によって検出された経費。  
Type: 配列の[ExpenseDocument](API_ExpenseDocument.md)オブジェクト

 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-JobStatus"></a>
テキスト検出ジョブの現在のステータス。  
Type: 文字列  
有効な値: ` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-NextToken"></a>
レスポンスが切り捨てられると、Amazon Textract はこのトークンを返します。後続のリクエストでこのトークンを使用して、次のテキスト検出結果セットを取得できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 255 です。  
パターン: `.*\S.*` 

 ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-StatusMessage"></a>
検出ジョブを完了できなかった場合に返します。発生したエラーの説明が含まれています。  
Type: 文字列

 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-Warnings"></a>
ドキュメントのテキスト検出操作中に発生した警告のリスト。  
Type: 配列の[Warning](API_Warning.md)オブジェクト

## エラー
<a name="API_GetExpenseAnalysis_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_GetExpenseAnalysis_SeeAlso"></a>

言語固有の 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
<a name="API_StartDocumentAnalysis"></a>

キーと値のペア、表、選択要素など、検出された項目間のリレーションシップについて、入力ドキュメントの非同期分析を開始します。

 `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)。

## リクエストの構文
<a name="API_StartDocumentAnalysis_RequestSyntax"></a>

```
{
   "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"
   }
}
```

## リクエストパラメータ
<a name="API_StartDocumentAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-ClientRequestToken"></a>
開始リクエストを識別するために使用するべき等トークン。同じトークンを複数で使用する場合`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) **   <a name="Textract-StartDocumentAnalysis-request-DocumentLocation"></a>
処理されるドキュメントの場所。  
型: [DocumentLocation](API_DocumentLocation.md) オブジェクト  
必須: はい

 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-FeatureTypes"></a>
実行する解析のタイプのリスト。TABLES をリストに追加して、入力ドキュメントで検出されたテーブルに関する情報を返します。FORMS を追加して、検出されたフォームデータを返します。両方のタイプの分析を実行するには、TABLES と FORMS を`FeatureTypes`。ドキュメント内で検出されたすべての行と単語が応答に含まれます（次の値に関連しないテキストを含む）`FeatureTypes`).  
Type: 文字列の配列  
有効な値: ` TABLES | FORMS`   
必須: はい

 ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-JobTag"></a>
Amazon SNS トピックに対して発行される完了通知に含まれる、指定する識別子。例えば、次を使用できます。`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `[a-zA-Z0-9_.\-:]+`   
必須: いいえ

 ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-KMSKeyId"></a>
推論結果の暗号化に使用される KMS キー。これは、キー ID 形式またはキーエイリアス形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。  
パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
必須: いいえ

 ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-NotificationChannel"></a>
Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。  
型: [NotificationChannel](API_NotificationChannel.md) オブジェクト  
必須: いいえ

 ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-OutputConfig"></a>
出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は内部的に結果を保存し、GetDocumentAnalysis s オペレーションによってアクセスされます。  
型: [OutputConfig](API_OutputConfig.md) オブジェクト  
必須: いいえ

## レスポンスの構文
<a name="API_StartDocumentAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## レスポンス要素
<a name="API_StartDocumentAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) **   <a name="Textract-StartDocumentAnalysis-response-JobId"></a>
ドキュメントテキスト検出ジョブの識別子。を使用する`JobId`以降の呼び出しでジョブを識別するには`GetDocumentAnalysis`。ある`JobId`値は 7 日間だけ有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$` 

## エラー
<a name="API_StartDocumentAnalysis_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_StartDocumentAnalysis_SeeAlso"></a>

言語固有の 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
<a name="API_StartDocumentTextDetection"></a>

ドキュメント内のテキストの非同期検出を開始します。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)。

## リクエストの構文
<a name="API_StartDocumentTextDetection_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## リクエストパラメータ
<a name="API_StartDocumentTextDetection_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-ClientRequestToken"></a>
開始リクエストを識別するために使用されるべき等トークン。複数で同じトークンを使用する場合`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) **   <a name="Textract-StartDocumentTextDetection-request-DocumentLocation"></a>
処理されるドキュメントの場所。  
型: [DocumentLocation](API_DocumentLocation.md) オブジェクト  
必須: はい

 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-JobTag"></a>
Amazon SNS トピックに対して発行される完了通知に含まれる、指定した ID。例えば、`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `[a-zA-Z0-9_.\-:]+`   
必須: いいえ

 ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-KMSKeyId"></a>
推論結果の暗号化に使用される KMS キーです。これは、キー ID またはキーエイリアスの形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。  
パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
必須: いいえ

 ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-NotificationChannel"></a>
Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。  
型: [NotificationChannel](API_NotificationChannel.md) オブジェクト  
必須: いいえ

 ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-OutputConfig"></a>
出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は、GetDocumentTextDetection オペレーションでアクセスするために内部的に結果を保存します。  
型: [OutputConfig](API_OutputConfig.md) オブジェクト  
必須: いいえ

## レスポンスの構文
<a name="API_StartDocumentTextDetection_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## レスポンス要素
<a name="API_StartDocumentTextDetection_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) **   <a name="Textract-StartDocumentTextDetection-response-JobId"></a>
ドキュメントのテキスト検出ジョブの識別子。を使用する`JobId`以降の呼び出しでジョブを識別するには`GetDocumentTextDetection`。ある`JobId`値は 7 日間有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$` 

## エラー
<a name="API_StartDocumentTextDetection_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_StartDocumentTextDetection_SeeAlso"></a>

言語固有の 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
<a name="API_StartExpenseAnalysis"></a>

連絡先情報、購入品目、仕入先名などのデータの請求書または領収書の非同期分析を開始します。

 `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)。

## リクエストの構文
<a name="API_StartExpenseAnalysis_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## リクエストパラメータ
<a name="API_StartExpenseAnalysis_RequestParameters"></a>

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

 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-ClientRequestToken"></a>
開始リクエストを識別するために使用されるべき等トークン。同じトークンを複数で使用する場合`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) **   <a name="Textract-StartExpenseAnalysis-request-DocumentLocation"></a>
処理されるドキュメントの場所。  
型: [DocumentLocation](API_DocumentLocation.md) オブジェクト  
必須: はい

 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-JobTag"></a>
Amazon SNS トピックに対して発行される完了通知に含まれる、指定した ID。たとえば、を使用できます。`JobTag`完了通知が対応する文書のタイプ（納税フォームや領収書など）を識別します。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `[a-zA-Z0-9_.\-:]+`   
必須: いいえ

 ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-KMSKeyId"></a>
推論結果の暗号化に使用される KMS キー。これは、キー ID またはキーエイリアスの形式のいずれかになります。KMS キーが提供されると、KMS キーは、カスタマーバケット内のオブジェクトのサーバー側の暗号化に使用されます。このパラメータが有効でない場合、結果は SSE-S3 を使用してサーバー側で暗号化されます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。  
パターン: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
必須: いいえ

 ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-NotificationChannel"></a>
Amazon Textract でオペレーションの完了ステータスを公開する Amazon SNS トピック ARN。  
型: [NotificationChannel](API_NotificationChannel.md) オブジェクト  
必須: いいえ

 ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-OutputConfig"></a>
出力が顧客定義のバケットに送られるかどうかを設定します。デフォルトでは、Amazon Textract は内部的に結果を保存し、`GetExpenseAnalysis`オペレーション.  
型: [OutputConfig](API_OutputConfig.md) オブジェクト  
必須: いいえ

## レスポンスの構文
<a name="API_StartExpenseAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## レスポンス要素
<a name="API_StartExpenseAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) **   <a name="Textract-StartExpenseAnalysis-response-JobId"></a>
テキスト検出ジョブの一意の識別子。-`JobId`から返される`StartExpenseAnalysis`。ある`JobId`値は 7 日間有効です。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 64 です。  
パターン: `^[a-zA-Z0-9-_]+$` 

## エラー
<a name="API_StartExpenseAnalysis_Errors"></a>

 ** 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

## 以下の資料も参照してください。
<a name="API_StartExpenseAnalysis_SeeAlso"></a>

言語固有の 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) 

# データ型
<a name="API_Types"></a>

以下のデータ型がサポートされています。
+  [AnalyzeIDDetections](API_AnalyzeIDDetections.md) 
+  [Block](API_Block.md) 
+  [BoundingBox](API_BoundingBox.md) 
+  [Document](API_Document.md) 
+  [DocumentLocation](API_DocumentLocation.md) 
+  [DocumentMetadata](API_DocumentMetadata.md) 
+  [ExpenseDetection](API_ExpenseDetection.md) 
+  [ExpenseDocument](API_ExpenseDocument.md) 
+  [ExpenseField](API_ExpenseField.md) 
+  [ExpenseType](API_ExpenseType.md) 
+  [Geometry](API_Geometry.md) 
+  [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 
+  [HumanLoopConfig](API_HumanLoopConfig.md) 
+  [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 
+  [IdentityDocument](API_IdentityDocument.md) 
+  [IdentityDocumentField](API_IdentityDocumentField.md) 
+  [LineItemFields](API_LineItemFields.md) 
+  [LineItemGroup](API_LineItemGroup.md) 
+  [NormalizedValue](API_NormalizedValue.md) 
+  [NotificationChannel](API_NotificationChannel.md) 
+  [OutputConfig](API_OutputConfig.md) 
+  [Point](API_Point.md) 
+  [Relationship](API_Relationship.md) 
+  [S3Object](API_S3Object.md) 
+  [Warning](API_Warning.md) 

# AnalyzeIDDetections
<a name="API_AnalyzeIDDetections"></a>

AnalyzeID 操作で検出された情報を格納するために使用します。

## 内容
<a name="API_AnalyzeIDDetections_Contents"></a>

 ** Confidence **   <a name="Textract-Type-AnalyzeIDDetections-Confidence"></a>
検出されたテキストの信頼スコア。  
Type: 浮動小数点  
値の範囲: 最小値は 0 です。最大値は 100 です。  
: 必須 いいえ

 ** NormalizedValue **   <a name="Textract-Type-AnalyzeIDDetections-NormalizedValue"></a>
日付に対してのみ返され、検出された値のタイプと、より機械で読みやすい方法で書かれた日付を返します。  
型: [NormalizedValue](API_NormalizedValue.md) オブジェクト  
: 必須 いいえ

 ** Text **   <a name="Textract-Type-AnalyzeIDDetections-Text"></a>
正規化されたフィールドまたはそれに関連付けられた値のテキスト。  
Type: 文字列  
: 必須 はい

## 以下の資料も参照してください。
<a name="API_AnalyzeIDDetections_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeIDDetections) 

# Block
<a name="API_Block"></a>

ある`Block`は、互いに近いピクセルのグループ内で文書内で認識される項目を表します。で返された情報`Block`オブジェクトは、操作のタイプに応じて異なります。ドキュメントのテキスト検出 (例:[DetectDocumentText](API_DetectDocumentText.md)) をクリックすると、検出された単語とテキスト行に関する情報が取得されます。テキスト分析（例：[AnalyzeDocument](API_AnalyzeDocument.md)) では、ドキュメント内で検出されたフィールド、テーブル、および選択要素に関する情報を取得することもできます。

の配列`Block`オブジェクトは、同期操作と非同期操作の両方によって返されます。同期操作では、[DetectDocumentText](API_DetectDocumentText.md)の配列`Block`オブジェクトは、結果のセット全体です。非同期操作では、[GetDocumentAnalysis](API_GetDocumentAnalysis.md)の場合、配列は 1 つ以上の応答に対して返されます。

詳細については、「」を参照してください。[Amazon Textract 仕組み](https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html)。

## 内容
<a name="API_Block_Contents"></a>

 ** BlockType **   <a name="Textract-Type-Block-BlockType"></a>
認識されるテキスト項目のタイプ。テキスト検出の操作では、次のタイプが返されます。  
+  *ページ*-LINEのリストが含まれます。`Block`ドキュメントページで検出されたオブジェクト。
+  *単語*-文書ページで検出された単語。単語とは、スペースで区切られていない、1 個以上の ISO 基本ラテンアルファベットです。
+  *ライン*-文書ページで検出された、タブ区切りの連続した単語の文字列。
テキスト分析操作では、次のタイプが返されます。  
+  *ページ*-子のリストが含まれます。`Block`ドキュメントページで検出されたオブジェクト。
+  *KEY\$1VALUE\$1SET*-キーと値を格納する`Block`ドキュメントページで検出されたリンクされたテキストのオブジェクト。を使用する`EntityType`フィールドを使用して、KEY\$1VALUE\$1SET オブジェクトがキーかどうかを判別します。`Block`オブジェクトまたは VALUE`Block`オブジェクト。
+  *単語*-文書ページで検出された単語。単語とは、スペースで区切られていない、1 個以上の ISO 基本ラテンアルファベットです。
+  *ライン*-文書ページで検出された、タブ区切りの連続した単語の文字列。
+  *テーブル*-ドキュメントページで検出されたテーブル。テーブルは、2 つ以上の行または列を持つグリッドベースの情報で、セル範囲はそれぞれ 1 行と 1 列です。
+  *細胞*-検出されたテーブル内のセル。セルは、セル内のテキストを含むブロックの親です。
+  *ELEMENT*-ドキュメントページで検出されるオプションボタン (ラジオボタン) やチェックボックスなどの選択要素。の値を使う`SelectionStatus`選択要素のステータスを確認することができます。
Type: 文字列  
有効な値: ` KEY_VALUE_SET | PAGE | LINE | WORD | TABLE | CELL | SELECTION_ELEMENT`   
: 必須 いいえ

 ** ColumnIndex **   <a name="Textract-Type-Block-ColumnIndex"></a>
表のセルが表示される列です。最初の列の位置は 1 です。`ColumnIndex`が返されません`DetectDocumentText`そして`GetDocumentTextDetection`。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** ColumnSpan **   <a name="Textract-Type-Block-ColumnSpan"></a>
表のセルがまたがる列の数。現在、この値は、スパンされる列数が 1 より大きい場合でも、常に 1 です。`ColumnSpan`が返されません`DetectDocumentText`そして`GetDocumentTextDetection`。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** Confidence **   <a name="Textract-Type-Block-Confidence"></a>
Amazon Textract の信頼スコアは、認識されたテキストの精度と、認識されたテキストの周囲にあるジオメトリの精度を示します。  
Type: 浮動小数点  
有効範囲: 最小値は 0 です。最大値は 100 です。  
: 必須 いいえ

 ** EntityTypes **   <a name="Textract-Type-Block-EntityTypes"></a>
エンティティのタイプ。次のものが返されます。  
+  *キー*-ドキュメント上のフィールドの識別子。
+  *値*-フィールドテキスト。
 `EntityTypes`が返されません`DetectDocumentText`そして`GetDocumentTextDetection`。  
Type: 文字列の配列  
有効な値: ` KEY | VALUE`   
: 必須 いいえ

 ** Geometry **   <a name="Textract-Type-Block-Geometry"></a>
イメージ上の認識されたテキストの位置。これには、テキストを囲む軸揃えの粗い境界ボックスと、より正確な空間情報を得るための、細かい粒度のポリゴンが含まれています。  
型: [Geometry](API_Geometry.md) オブジェクト  
: 必須 いいえ

 ** Id **   <a name="Textract-Type-Block-Id"></a>
認識されたテキストの識別子。この識別子は、1 つの操作に対してのみ一意です。  
Type: 文字列  
パターン: `.*\S.*`   
: 必須 いいえ

 ** Page **   <a name="Textract-Type-Block-Page"></a>
ブロックが検出されたページ。`Page`非同期操作によって返されます。1 より大きいページ値は、PDF または TIFF 形式の複数ページのドキュメントに対してのみ返されます。スキャンした画像（JPEG/PNG）は、複数のドキュメントページを含む場合でも、単一ページのドキュメントと見なされます。の価値`Page`は常に1です。同期操作は返されない`Page`なぜなら、すべての入力ドキュメントは単一ページのドキュメントと見なされるからです。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** Relationships **   <a name="Textract-Type-Block-Relationships"></a>
現在のブロックの子ブロックのリスト。たとえば、LINE オブジェクトには、テキスト行の一部である各 WORD ブロックの子ブロックがあります。現在のブロックに子ブロックがない場合など、存在しないリレーションシップについては、リストに Relationship オブジェクトがありません。リストのサイズは、次のようになります。  
+ 0-ブロックには子ブロックがありません。
+ 1-ブロックに子ブロックがあります。
Type: の配列[Relationship](API_Relationship.md)オブジェクト  
: 必須 いいえ

 ** RowIndex **   <a name="Textract-Type-Block-RowIndex"></a>
表のセルが配置されている行。最初の行の位置は 1 です。`RowIndex`が返されません`DetectDocumentText`そして`GetDocumentTextDetection`。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** RowSpan **   <a name="Textract-Type-Block-RowSpan"></a>
テーブルのセルがまたがる行数。現在、この値は、スパンされる行数が 1 より大きい場合でも、常に 1 です。`RowSpan`が返されません`DetectDocumentText`そして`GetDocumentTextDetection`。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** SelectionStatus **   <a name="Textract-Type-Block-SelectionStatus"></a>
オプションボタンやチェックボックスなど、選択要素の選択ステータス。  
Type: 文字列  
有効な値: ` SELECTED | NOT_SELECTED`   
: 必須 いいえ

 ** Text **   <a name="Textract-Type-Block-Text"></a>
Amazon Textract で認識される単語またはテキスト行。  
Type: 文字列  
: 必須 いいえ

 ** TextType **   <a name="Textract-Type-Block-TextType"></a>
Amazon Textract が検出したテキストの種類です。手書きのテキストと印刷されたテキストをチェックできます。  
Type: 文字列  
有効な値: ` HANDWRITING | PRINTED`   
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_Block_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Block) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Block) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Block) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Block) 

# BoundingBox
<a name="API_BoundingBox"></a>

文書ページ上で検出されたページ、テキスト、キーと値のペア、表、表のセル、または選択要素の周囲の境界ボックス。-`left`(X 座標) と`top`(y 座標) は、境界ボックスの上端と左端を表す座標。画像の左上隅が原点 (0,0) であることに注意してください。

-`top`そして`left`返される値は、ドキュメント全体のページサイズの比率です。たとえば、入力イメージが 700 x 200 ピクセルの場合、境界ボックスの左上の座標は 350 x 50 ピクセルで、API は `left` 値 0.5 (350/700) および `top` 値 0.25 (50/200) を返します。

-`width`そして`height`値は、文書ページ全体の大きさの比率としての境界ボックスの大きさを表します。たとえば、ドキュメントのページサイズが 700 x 200 ピクセルで、境界ボックスの幅が 70 ピクセルの場合、返される幅は 0.1 になります。

## 内容
<a name="API_BoundingBox_Contents"></a>

 ** Height **   <a name="Textract-Type-BoundingBox-Height"></a>
境界ボックスの高さ。  
Type: 浮動小数点  
必須 いいえ

 ** Left **   <a name="Textract-Type-BoundingBox-Left"></a>
Left ドキュメント全体の幅の比率としての境界ボックスの左座標。  
Type: 浮動小数点  
必須 いいえ

 ** Top **   <a name="Textract-Type-BoundingBox-Top"></a>
Top 文書ページ全体の高さの比率としての境界ボックスの上端座標。  
Type: 浮動小数点  
必須 いいえ

 ** Width **   <a name="Textract-Type-BoundingBox-Width"></a>
境界ボックスの幅。文書ページ全体の幅の比率としての境界ボックスの幅。  
Type: 浮動小数点  
必須 いいえ

## 以下の資料も参照してください。
<a name="API_BoundingBox_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/BoundingBox) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/BoundingBox) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/BoundingBox) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/BoundingBox) 

# Document
<a name="API_Document"></a>

バイトまたは 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 オブジェクトにアクセスするためのアクセス許可が必要です。

## 内容
<a name="API_Document_Contents"></a>

 ** Bytes **   <a name="Textract-Type-Document-Bytes"></a>
base64 でエンコードされたドキュメントバイトの BLOB。BLOB バイトで提供されるドキュメントの最大サイズは 5 MB です。ドキュメントバイトは PNG または JPEG 形式である必要があります。  
AWS SDK を使用して Amazon Textract を呼び出す場合は、を使用して渡されたイメージバイトを base64 エンコードする必要がない場合があります。`Bytes`フィールド。  
Type: Base64 でエンコードされたバイナリデータオブジェクト  
長さの制約: 最小長は 1 です｡ 最大長は 10485760 です。  
必須: いいえ

 ** S3Object **   <a name="Textract-Type-Document-S3Object"></a>
S3 オブジェクトをドキュメントソースとして識別します。S3 バケットに保存されたドキュメントの最大サイズは 5 MB です。  
型: [S3Object](API_S3Object.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Document_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Document) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Document) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Document) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Document) 

# DocumentLocation
<a name="API_DocumentLocation"></a>

処理するドキュメントが含まれる Amazon S3 バケット。これは、次のような非同期操作で使用されます。[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。

入力ドキュメントは、JPEG または PNG 形式の画像ファイルになります。また、PDF 形式のファイルにすることもできます。

## 内容
<a name="API_DocumentLocation_Contents"></a>

 ** S3Object **   <a name="Textract-Type-DocumentLocation-S3Object"></a>
入力ドキュメントが含まれる Amazon S3 バケット。  
型: [S3Object](API_S3Object.md) オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_DocumentLocation_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentLocation) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentLocation) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentLocation) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentLocation) 

# DocumentMetadata
<a name="API_DocumentMetadata"></a>

入力ドキュメントに関する情報。

## 内容
<a name="API_DocumentMetadata_Contents"></a>

 ** Pages **   <a name="Textract-Type-DocumentMetadata-Pages"></a>
ドキュメント内で検出されたページ数。  
Type: 整数  
有効範囲: 最小値は 0 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DocumentMetadata_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentMetadata) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/DocumentMetadata) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentMetadata) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentMetadata) 

# ExpenseDetection
<a name="API_ExpenseDetection"></a>

Amazon Textract によって検出された値またはラベルに関する情報を格納するために使用されるオブジェクトです。

## 内容
<a name="API_ExpenseDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseDetection-Confidence"></a>
検出の信頼度 (パーセンテージ)  
Type: 浮動小数点  
有効範囲: 最小値は 0 です。最大値は 100 です。  
: 必須 いいえ

 ** Geometry **   <a name="Textract-Type-ExpenseDetection-Geometry"></a>
検出ページ、テキスト、キーと値のペア、表、表のセル、選択要素です。  
型: [Geometry](API_Geometry.md) オブジェクト  
: 必須 いいえ

 ** Text **   <a name="Textract-Type-ExpenseDetection-Text"></a>
Amazon Textract で認識される単語またはテキスト行  
Type: 文字列  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_ExpenseDetection_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDetection) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDetection) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDetection) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDetection) 

# ExpenseDocument
<a name="API_ExpenseDocument"></a>

AnalyzeExpense によって返されるすべての情報を保持する構造体

## 内容
<a name="API_ExpenseDocument_Contents"></a>

 ** ExpenseIndex **   <a name="Textract-Type-ExpenseDocument-ExpenseIndex"></a>
情報の取得元が文書内のどの請求書または領収書かを示します。最初のドキュメントは 1、2 番目のドキュメントは 2 番目のドキュメントです。  
Type: 整数  
有効範囲: 最小値は 0 です。  
: 必須 いいえ

 ** LineItemGroups **   <a name="Textract-Type-ExpenseDocument-LineItemGroups"></a>
ドキュメントの各テーブルで検出された情報。`LineItems`。  
Type: の配列[LineItemGroup](API_LineItemGroup.md)オブジェクト  
: 必須 いいえ

 ** SummaryFields **   <a name="Textract-Type-ExpenseDocument-SummaryFields"></a>
Amazon Textract のテーブル外で見つかった情報。  
Type: の配列[ExpenseField](API_ExpenseField.md)オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_ExpenseDocument_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDocument) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseDocument) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDocument) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDocument) 

# ExpenseField
<a name="API_ExpenseField"></a>

タイプ、ラベル検出、および値検出のカテゴリに分類された、検出された情報の内訳

## 内容
<a name="API_ExpenseField_Contents"></a>

 ** LabelDetection **   <a name="Textract-Type-ExpenseField-LabelDetection"></a>
検出された要素の明示的に記述されたラベル。  
型: [ExpenseDetection](API_ExpenseDetection.md) オブジェクト  
: 必須 いいえ

 ** PageNumber **   <a name="Textract-Type-ExpenseField-PageNumber"></a>
値が検出されたページ番号。  
Type: 整数  
値の範囲: 最小値は 0 です。  
: 必須 いいえ

 ** Type **   <a name="Textract-Type-ExpenseField-Type"></a>
検出された要素の暗黙のラベル。明示的な要素については labelDetection と一緒に提示します。  
型: [ExpenseType](API_ExpenseType.md) オブジェクト  
: 必須 いいえ

 ** ValueDetection **   <a name="Textract-Type-ExpenseField-ValueDetection"></a>
検出された要素の値。明示的要素と暗黙的な要素に存在する。  
型: [ExpenseDetection](API_ExpenseDetection.md) オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_ExpenseField_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseField) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseField) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseField) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseField) 

# ExpenseType
<a name="API_ExpenseType"></a>

Amazon Textract によって検出されたタイプに関する情報を格納するために使用されるオブジェクトです。

## 内容
<a name="API_ExpenseType_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseType-Confidence"></a>
精度の信頼度 (パーセンテージ)。  
Type: 浮動小数点  
有効範囲: 最小値は 0 です。最大値は 100 です。  
: 必須 いいえ

 ** Text **   <a name="Textract-Type-ExpenseType-Text"></a>
Amazon Textract によって検出された単語またはテキスト行。  
Type: 文字列  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_ExpenseType_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseType) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/ExpenseType) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseType) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseType) 

# Geometry
<a name="API_Geometry"></a>

検出ページ、テキスト、キーと値のペア、表、表のセル、選択要素など、ドキュメントページ上の項目についてドキュメントページ上の位置に関する情報。

## 内容
<a name="API_Geometry_Contents"></a>

 ** BoundingBox **   <a name="Textract-Type-Geometry-BoundingBox"></a>
ドキュメントページ上の認識されたアイテムの位置を表す軸揃えの粗い表現。  
型: [BoundingBox](API_BoundingBox.md) オブジェクト  
: 必須 いいえ

 ** Polygon **   <a name="Textract-Type-Geometry-Polygon"></a>
バウンディングボックス内では、認識されたアイテムの周囲をきめ細かなポリゴン。  
Type: 配列配列[Point](API_Point.md)オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_Geometry_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Geometry) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Geometry) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Geometry) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Geometry) 

# HumanLoopActivationOutput
<a name="API_HumanLoopActivationOutput"></a>

ループ評価で人間の結果を表示します。HumanLooParn がない場合、入力はヒューマンレビューをトリガーしませんでした。

## 内容
<a name="API_HumanLoopActivationOutput_Contents"></a>

 ** HumanLoopActivationConditionsEvaluationResults **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationConditionsEvaluationResults"></a>
人間のレビューを活性化した条件を含む、状態評価の結果を表示します。  
Type: 文字列  
長さの制約: 最大長は 10240 です。  
必須: いいえ

 ** HumanLoopActivationReasons **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationReasons"></a>
人間のレビューが必要だったかどうか、そして理由を示します。  
Type: 文字列の配列  
配列メンバー: 最小数は 1 項目です。  
必須: いいえ

 ** HumanLoopArn **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopArn"></a>
新たに作成された HumanLoop の Amazon リソースネーム (ARN)。  
Type: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HumanLoopActivationOutput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopActivationOutput) 

# HumanLoopConfig
<a name="API_HumanLoopConfig"></a>

いずれかの条件が満たされた場合にドキュメントが送信されるヒューマンレビューワークフローを設定します。レビューの前に画像の特定の属性を設定することもできます。

## 内容
<a name="API_HumanLoopConfig_Contents"></a>

 ** DataAttributes **   <a name="Textract-Type-HumanLoopConfig-DataAttributes"></a>
入力データの属性を設定します。  
型: [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) オブジェクト  
必須 いいえ

 ** FlowDefinitionArn **   <a name="Textract-Type-HumanLoopConfig-FlowDefinitionArn"></a>
フロー定義の Amazon リソースネーム (ARN)。  
Type: 文字列  
長さの制約: 最大長は 256 です。  
必須 はい

 ** HumanLoopName **   <a name="Textract-Type-HumanLoopConfig-HumanLoopName"></a>
このイメージに使用されるヒューマンワークフローの名前。これは、リージョン内で一意である必要があります。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 63 です。  
Pattern: `^[a-z0-9](-*[a-z0-9])*`   
必須 はい

## 以下の資料も参照してください。
<a name="API_HumanLoopConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopConfig) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopConfig) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopConfig) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopConfig) 

# HumanLoopDataAttributes
<a name="API_HumanLoopDataAttributes"></a>

イメージの属性を設定できます。現在、個人を特定できる情報やアダルトコンテンツを含まない画像を宣言できます。

## 内容
<a name="API_HumanLoopDataAttributes_Contents"></a>

 ** ContentClassifiers **   <a name="Textract-Type-HumanLoopDataAttributes-ContentClassifiers"></a>
入力イメージに個人を特定できる情報やアダルトコンテンツが含まれているかどうかを設定します。  
Type: 文字列の配列  
配列メンバ: 最大数は 256 項目です。  
有効な値: ` FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HumanLoopDataAttributes_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopDataAttributes) 

# IdentityDocument
<a name="API_IdentityDocument"></a>

AnalyzeID 操作で処理された各ドキュメントをリストする構造体。

## 内容
<a name="API_IdentityDocument_Contents"></a>

 ** DocumentIndex **   <a name="Textract-Type-IdentityDocument-DocumentIndex"></a>
IdentityDocument リスト内のドキュメントの配置を示します。最初のドキュメントは 1、2 番目のドキュメントは 2 とマークされます。  
Type: 整数  
値の範囲: 最小値は 0 です。  
必須: いいえ

 ** IdentityDocumentFields **   <a name="Textract-Type-IdentityDocument-IdentityDocumentFields"></a>
アイデンティティドキュメントから抽出された情報を記録するために使用される構造。正規化されたフィールドと抽出されたテキストの値の両方が含まれます。  
Type: 配列の[IdentityDocumentField](API_IdentityDocumentField.md)オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_IdentityDocument_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocument) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocument) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocument) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocument) 

# IdentityDocumentField
<a name="API_IdentityDocumentField"></a>

抽出された情報の正規化されたタイプと、それに関連付けられたテキストの両方を含む構造体。これらはそれぞれ「タイプ」と「値」として抽出されます。

## 内容
<a name="API_IdentityDocumentField_Contents"></a>

 ** Type **   <a name="Textract-Type-IdentityDocumentField-Type"></a>
AnalyzeID 操作で検出された情報を格納するために使用します。  
型: [AnalyzeIDDetections](API_AnalyzeIDDetections.md) オブジェクト  
: 必須 いいえ

 ** ValueDetection **   <a name="Textract-Type-IdentityDocumentField-ValueDetection"></a>
AnalyzeID 操作で検出された情報を格納するために使用します。  
型: [AnalyzeIDDetections](API_AnalyzeIDDetections.md) オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_IdentityDocumentField_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocumentField) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/IdentityDocumentField) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocumentField) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocumentField) 

# LineItemFields
<a name="API_LineItemFields"></a>

ドキュメントのテーブルにあるさまざまな行に関する情報を保持する構造体。

## 内容
<a name="API_LineItemFields_Contents"></a>

 ** LineItemExpenseFields **   <a name="Textract-Type-LineItemFields-LineItemExpenseFields"></a>
ExpenseFields は、テーブル上で検出された行からの情報を表示するために使用します。  
Type: 配列の[ExpenseField](API_ExpenseField.md)オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_LineItemFields_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemFields) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemFields) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemFields) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemFields) 

# LineItemGroup
<a name="API_LineItemGroup"></a>

lineItems を含むテーブルのグループで、各テーブルがテーブルで識別されます。`LineItemGroupIndex`。

## 内容
<a name="API_LineItemGroup_Contents"></a>

 ** LineItemGroupIndex **   <a name="Textract-Type-LineItemGroup-LineItemGroupIndex"></a>
ドキュメント内の特定の表を識別するために使用される番号。最初に検出されたテーブルには lineItemGroupIndex が 1、2 番目の 2 などになります。  
Type: 整数  
値の範囲: 最小値は 0 です。  
: 必須 いいえ

 ** LineItems **   <a name="Textract-Type-LineItemGroup-LineItems"></a>
テーブルの特定の行に関する情報の内訳。  
Type: 配列の[LineItemFields](API_LineItemFields.md)オブジェクト  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_LineItemGroup_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemGroup) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/LineItemGroup) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemGroup) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemGroup) 

# NormalizedValue
<a name="API_NormalizedValue"></a>

値のタイプや値など、ドキュメント内の日付に関する情報が含まれます。

## 内容
<a name="API_NormalizedValue_Contents"></a>

 ** Value **   <a name="Textract-Type-NormalizedValue-Value"></a>
日付の値で、年-月-日時:分:秒と記述されます。  
Type: 文字列  
: いいえ

 ** ValueType **   <a name="Textract-Type-NormalizedValue-ValueType"></a>
検出された値の正規化されたタイプ。この場合、DATE。  
Type: 文字列  
有効な値: ` DATE`   
: いいえ

## 以下の資料も参照してください。
<a name="API_NormalizedValue_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NormalizedValue) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NormalizedValue) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NormalizedValue) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NormalizedValue) 

# NotificationChannel
<a name="API_NotificationChannel"></a>

Amazon Textract が非同期ドキュメントオペレーションの完了ステータスを発行する先の Amazon Simple Notification Service (Amazon SNS) トピックは次のとおりです。[StartDocumentTextDetection](API_StartDocumentTextDetection.md)。

## 内容
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="Textract-Type-NotificationChannel-RoleArn"></a>
Amazon SNS トピックへの Amazon Textract パブリッシングアクセス権限を付与する、IAM ロールの Amazon リソースネーム (ARN)。  
Type: 文字列  
長さの制約: 最小長は 20 です｡ 最大長は 2,048 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** SNSTopicArn **   <a name="Textract-Type-NotificationChannel-SNSTopicArn"></a>
Amazon Textract が完了ステータスを投稿する Amazon SNS トピック。  
Type: 文字列  
長さの制約: 最小長は 20 です｡ 最大長は 1,024 です。  
Pattern: `(^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)`   
必須: はい

## 以下の資料も参照してください。
<a name="API_NotificationChannel_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NotificationChannel) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/NotificationChannel) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NotificationChannel) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NotificationChannel) 

# OutputConfig
<a name="API_OutputConfig"></a>

ユーザーが作成したバケットに出力を送信するかどうかを設定します。バケットの名前と出力ファイルのプレフィックスを設定するために使用します。

 `OutputConfig`は、出力の配置場所を調整できるオプションのパラメータです。デフォルトでは、Amazon Textract は結果を内部的に保存し、Get API オペレーションによってのみアクセスできます。OutputConfig を有効にすると、出力が送信されるバケットの名前と、結果をダウンロードできる結果のファイルプレフィックスを設定できます。さらに、`KMSKeyID`出力を暗号化するには、のパラメータをカスタマーマスターキー (CMK) に設定します。このパラメータを設定しないと、Amazon Textract は AWS マネージド CMK for Amazon S3 を使用してサーバーサイドを暗号化します。

Amazon Textract によるドキュメントの処理には、カスタマーコンテンツの解読が必要です。お客様のアカウントが AI サービスのオプトアウトポリシーに基づいてオプトアウトされた場合、カスタマーコンテンツがサービスによって処理された後、暗号化されていないすべてのカスタマーコンテンツが即時かつ完全に削除されます。Amazon Textract では、出力のコピーは保持されません。オプトアウトの方法の詳細については、「」を参照してください。[AI サービスのオプトアウトポリシーの管理。](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)

データプライバシーの詳細については、「」を参照してください。[データプライバシーのよくある質問](https://aws.amazon.com/compliance/data-privacy-faq/)。

## 内容
<a name="API_OutputConfig_Contents"></a>

 ** S3Bucket **   <a name="Textract-Type-OutputConfig-S3Bucket"></a>
出力先のバケットの名前。  
Type: 文字列  
長さの制約: 最小長は 3 です。最大長は 255 です。  
パターン: `[0-9A-Za-z\.\-_]*`   
必須 はい

 ** S3Prefix **   <a name="Textract-Type-OutputConfig-S3Prefix"></a>
出力を保存するオブジェクトキーのプレフィックス。有効でない場合、プレフィックスは「texttract\$1output」になります。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 1,024 です。  
Pattern: `.*\S.*`   
必須 いいえ

## 以下の資料も参照してください。
<a name="API_OutputConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/OutputConfig) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/OutputConfig) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/OutputConfig) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/OutputConfig) 

# Point
<a name="API_Point"></a>

ドキュメントページ上のポイントの X 座標と Y 座標。返される X および Y 値は、ドキュメント全体のページサイズの比率です。たとえば、入力ドキュメントが 700 x 200 で、X=0.5 および Y = 0.25 を返す場合、ポイントはドキュメントページの (350,50) ピクセル座標になります。

の配列`Point`オブジェクト、`Polygon`「」の一部として、が返ります[Geometry](API_Geometry.md)で返されるオブジェクト[Block](API_Block.md)オブジェクト。ある`Polygon`オブジェクトは、検出されたテキスト、キーと値のペア、テーブル、テーブルセル、または選択エレメントの周りのきめ細かなポリゴンを表します。

## 内容
<a name="API_Point_Contents"></a>

 ** X **   <a name="Textract-Type-Point-X"></a>
上の点の X 座標の値`Polygon`。  
Type: 浮動小数点  
必須: いいえ

 ** Y **   <a name="Textract-Type-Point-Y"></a>
上の点の Y 座標の値`Polygon`。  
Type: 浮動小数点  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Point_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Point) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Point) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Point) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Point) 

# Relationship
<a name="API_Relationship"></a>

ブロックが互いにどのように関連しているかに関する情報。ある`Block`オブジェクトには、0 個以上が含まれています`Relation`リスト内のオブジェクト、`Relationships`。詳細については、「[Block](API_Block.md)」を参照してください。

-`Type`要素は、すべてのブロックに対する関係の型を提供します。`IDs`配列。

## 内容
<a name="API_Relationship_Contents"></a>

 ** Ids **   <a name="Textract-Type-Relationship-Ids"></a>
関連ブロックの ID の配列。関係のタイプは、`Type`要素。  
Type: 文字列の配列  
パターン: `.*\S.*`   
: 必須 いいえ

 ** Type **   <a name="Textract-Type-Relationship-Type"></a>
IDs 配列のブロックが現在のブロックと持つ関係のタイプ。この関係は`VALUE`または`CHILD`。VALUE 型の関係は、キーと値のペアの KEY に関連付けられている VALUE ブロックの ID を含むリストです。CHILD 型の関係は、行の場合は WORD ブロックを識別する ID のリストです。テーブルの場合は Cell ブロック、選択要素の場合は WORD ブロックを識別します。  
Type: 文字列  
有効な値: ` VALUE | CHILD | COMPLEX_FEATURES`   
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_Relationship_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Relationship) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Relationship) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Relationship) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Relationship) 

# S3Object
<a name="API_S3Object"></a>

ドキュメントを識別する S3 バケット名とファイル名。

ドキュメントを含む S3 バケットの AWS リージョンは、Amazon Textract オペレーションに使用するリージョンと一致する必要があります。

Amazon Textract バケット内のファイルを処理するには、S3 バケットとファイルにアクセスするための許可が必要です。

## 内容
<a name="API_S3Object_Contents"></a>

 ** Bucket **   <a name="Textract-Type-S3Object-Bucket"></a>
S3 バケットの名前。\$1 文字はファイル名には有効ではないことに注意してください。  
Type: 文字列  
長さの制約: 最小長は 3 です。最大長は 255 です。  
パターン: `[0-9A-Za-z\.\-_]*`   
: 必須 いいえ

 ** Name **   <a name="Textract-Type-S3Object-Name"></a>
入力ドキュメントのファイル名。同期操作では、JPEG または PNG 形式のイメージファイルを使用できます。非同期操作は、PDF および TIFF 形式のファイルもサポートします。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 1,024 です。  
Pattern: `.*\S.*`   
: 必須 いいえ

 ** Version **   <a name="Textract-Type-S3Object-Version"></a>
バケットのバージョニングが有効化されている場合には、オブジェクトのバージョンを指定できます。  
Type: 文字列  
長さの制約: 最小長は 1 です｡ 最大長は 1,024 です。  
Pattern: `.*\S.*`   
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_S3Object_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/S3Object) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/S3Object) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/S3Object) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/S3Object) 

# Warning
<a name="API_Warning"></a>

非同期テキスト分析時に発生した問題に関する警告 ([StartDocumentAnalysis](API_StartDocumentAnalysis.md)) または非同期ドキュメントテキスト検出 ([StartDocumentTextDetection](API_StartDocumentTextDetection.md)).

## 内容
<a name="API_Warning_Contents"></a>

 ** ErrorCode **   <a name="Textract-Type-Warning-ErrorCode"></a>
警告のエラーコード。  
Type: 文字列  
: 必須 いいえ

 ** Pages **   <a name="Textract-Type-Warning-Pages"></a>
警告が適用されるページのリスト。  
Type: 整数の配列  
値の範囲: 最小値は 0 です。  
: 必須 いいえ

## 以下の資料も参照してください。
<a name="API_Warning_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください：
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Warning) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/textract-2018-06-27/Warning) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Warning) 
+  [AWS SDK for Ruby v3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Warning) 