

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

# 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) 