Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Tindakan
<a name="API_Operations"></a>

Tindakan berikut didukung:
+  [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>

Menganalisis dokumen masukan untuk hubungan antara item yang terdeteksi. 

Jenis informasi yang dikembalikan adalah sebagai berikut: 
+ Data formulir (pasangan nilai kunci). Informasi terkait dikembalikan dalam dua[Block](API_Block.md)objek, masing-masing jenis`KEY_VALUE_SET`: KUNCI`Block`objek dan NILAI`Block`objek. Misalnya,*Nama: Ana Silva*berisi kunci dan nilai. *Nama:*adalah kuncinya. *Ana Silva*adalah nilai.
+ Tabel dan data sel tabel. TABEL`Block`objek berisi informasi tentang tabel terdeteksi. SEL`Block`objek dikembalikan untuk setiap sel dalam tabel.
+ Garis dan kata-kata teks. GARIS`Block`objek berisi satu atau lebih WORD`Block`objek. Semua baris dan kata-kata yang terdeteksi dalam dokumen dikembalikan (termasuk teks yang tidak memiliki hubungan dengan nilai`FeatureTypes`). 

Elemen seleksi seperti kotak centang dan tombol opsi (tombol radio) dapat dideteksi dalam data formulir dan dalam tabel. SELECTION\$1ELEMENT`Block`objek berisi informasi tentang elemen seleksi, termasuk status seleksi.

Anda dapat memilih jenis analisis yang akan dilakukan dengan menentukan`FeatureTypes`daftar. 

Output dikembalikan dalam daftar`Block`objek.

 `AnalyzeDocument` adalah operasi tersinkron. Untuk menganalisis dokumen secara asinkron, gunakan[StartDocumentAnalysis](API_StartDocumentAnalysis.md).

Untuk informasi selengkapnya, lihat[Analisis Teks Dokumen](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Sintaksis Permintaan
<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"
   }
}
```

## Parameter Permintaan
<a name="API_AnalyzeDocument_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
Dokumen input sebagai byte yang dikodekan base64 atau objek Amazon S3. Jika Anda menggunakan AWS CLI untuk memanggil operasi Amazon Textract, Anda tidak dapat meneruskan byte citra. Dokumen harus berupa gambar dalam format JPEG, PNG, PDF, atau TIFF.  
Jika Anda menggunakan AWS SDK untuk memanggil Amazon Textract, Anda mungkin tidak perlu byte citra yang dikodekan base64 yang diteruskan menggunakan`Bytes`bidang.   
Tipe: Objek [Document](API_Document.md)  
Diperlukan: Ya

 ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
Daftar jenis analisis untuk melakukan. Tambahkan TABEL ke daftar untuk mengembalikan informasi tentang tabel yang terdeteksi dalam dokumen input. Tambahkan FORMS untuk mengembalikan data formulir yang terdeteksi. Untuk melakukan kedua jenis analisis, tambahkan TABEL dan FORM ke`FeatureTypes`. Semua baris dan kata yang terdeteksi dalam dokumen disertakan dalam respons (termasuk teks yang tidak terkait dengan nilai`FeatureTypes`).   
Jenis: Array string  
Nilai Valid:` TABLES | FORMS`   
Diperlukan: Ya

 ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
Menetapkan konfigurasi untuk manusia dalam alur kerja loop untuk menganalisis dokumen.  
Tipe: Objek [HumanLoopConfig](API_HumanLoopConfig.md)  
Diperlukan: Tidak

## Sintaksis Respons
<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"
   }
}
```

## Elemen Respons
<a name="API_AnalyzeDocument_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
Versi model yang digunakan untuk menganalisis dokumen.  
Jenis: String

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
Item yang terdeteksi dan dianalisis oleh`AnalyzeDocument`.  
Jenis: Array[Block](API_Block.md)objek

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
Metadata tentang dokumen yang dianalisis. Contohnya adalah jumlah halaman.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
Menunjukkan hasil yang menunjukkan manusia dalam evaluasi loop.  
Tipe: Objek [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md)

## Kesalahan
<a name="API_AnalyzeDocument_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** HumanLoopQuotaExceededException **   
Menunjukkan bahwa Anda telah melebihi jumlah maksimum manusia aktif dalam alur kerja loop yang tersedia  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron, sebuah`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract Texact tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Konfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract Texact untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_AnalyzeDocument_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu bahasa khususAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument) 

# AnalyzeExpense
<a name="API_AnalyzeExpense"></a>

 `AnalyzeExpense`serentak menganalisis dokumen masukan untuk hubungan finansial terkait antara teks.

Informasi dikembalikan sebagai`ExpenseDocuments`dan terpisah sebagai berikut.
+  `LineItemGroups`- Sebuah set data yang berisi`LineItems`yang menyimpan informasi tentang baris teks, seperti barang yang dibeli dan harganya pada tanda terima.
+  `SummaryFields`- Berisi semua informasi lain tanda terima, seperti informasi header atau nama vendor.

## Sintaksis Permintaan
<a name="API_AnalyzeExpense_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_AnalyzeExpense_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [Document](#API_AnalyzeExpense_RequestSyntax) **   <a name="Textract-AnalyzeExpense-request-Document"></a>
Dokumen input, baik sebagai byte atau sebagai objek S3.  
Anda meneruskan bit citra ke operasi API Amazon Textract dengan menggunakan bit`Bytes`properti. Misalnya, Anda akan menggunakan`Bytes`properti untuk lulus dokumen yang dimuat dari sistem file lokal. Gambar byte dilewatkan dengan menggunakan`Bytes`properti harus dikodekan dengan base64. Kode Anda mungkin tidak perlu mengodekan byte file dokumen jika Anda menggunakan AWS SDK untuk memanggil operasi API Amazon Textract.   
Anda meneruskan citra yang disimpan dalam bucket S3 ke operasi API Amazon Textract dengan menggunakan bucket S3 dengan menggunakan bucket S3 ke operasi API Amazon T`S3Object`properti. Dokumen yang disimpan dalam bucket S3 tidak perlu dikodekan dengan base64.  
Wilayah AWS untuk bucket S3 yang berisi objek S3 harus sesuai dengan Wilayah AWS yang Anda gunakan untuk operasi Amazon Textract.  
Jika Anda menggunakan AWS CLI untuk memanggil operasi Amazon Textract, meneruskan bit citra menggunakan properti Bit tidak didukung. Anda harus mengunggah dokumen terlebih dahulu ke bucket Amazon S3, lalu memanggil operasi menggunakan properti S3Object.  
Agar Amazon Textract memproses objek S3, pengguna harus memiliki izin untuk mengakses objek S3.   
Tipe: Objek [Document](API_Document.md)  
Diperlukan: Ya

## Sintaksis Respons
<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"
               }
            }
         ]
      }
   ]
}
```

## Elemen Respons
<a name="API_AnalyzeExpense_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-DocumentMetadata"></a>
Informasi tentang dokumen masukan.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-ExpenseDocuments"></a>
Biaya terdeteksi oleh Amazon Textract.  
Jenis: Array[ExpenseDocument](API_ExpenseDocument.md)objek

## Kesalahan
<a name="API_AnalyzeExpense_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron, sebuah`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Mengonfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_AnalyzeExpense_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa yang spesifikAWSSDK, lihat berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense) 

# AnalyzeID
<a name="API_AnalyzeID"></a>

Menganalisis dokumen identitas untuk informasi yang relevan. Informasi ini diekstraksi dan dikembalikan sebagai`IdentityDocumentFields`, yang mencatat bidang normal dan nilai teks yang diekstraksi.Tidak seperti operasi Amazon Textract Texact lainnya,`AnalyzeID`tidak mengembalikan data Geometry.

## Sintaksis Permintaan
<a name="API_AnalyzeID_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_AnalyzeID_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) **   <a name="Textract-AnalyzeID-request-DocumentPages"></a>
Dokumen yang diteruskan ke AnalyzeID.  
Jenis: Array[Document](API_Document.md)objek  
Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 2 item.  
Diperlukan: Ya

## Sintaksis Respons
<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"
               }
            }
         ]
      }
   ]
}
```

## Elemen Respons
<a name="API_AnalyzeID_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-AnalyzeIDModelVersion"></a>
Versi AnalyzeIdentity API yang digunakan untuk memproses dokumen.  
Jenis: String

 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-DocumentMetadata"></a>
Informasi tentang dokumen masukan.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-IdentityDocuments"></a>
Daftar dokumen yang diproses oleh AnalyzeID. Termasuk nomor yang menunjukkan tempat mereka dalam daftar dan struktur respon untuk dokumen.  
Jenis: Array[IdentityDocument](API_IdentityDocument.md)objek

## Kesalahan
<a name="API_AnalyzeID_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron, sebuah`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract Texact tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Mengonfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_AnalyzeID_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu bahasa khusus bahasaAWSSDK, lihat berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID) 

# DetectDocumentText
<a name="API_DetectDocumentText"></a>

Mendeteksi teks dalam dokumen input. Amazon Textract dapat mendeteksi baris teks dan kata-kata yang membentuk baris teks. Dokumen input harus berupa gambar dalam format JPEG, PNG, PDF, atau TIFF.`DetectDocumentText`mengembalikan teks terdeteksi dalam array[Block](API_Block.md)objek. 

Setiap halaman dokumen memiliki sebagai terkait`Block`jenis HALAMAN. Setiap HALAMAN`Block`objek adalah induk dari LINE`Block`objek yang mewakili baris teks terdeteksi pada halaman. GARIS`Block`objek adalah orang tua untuk setiap kata yang membentuk baris. Kata-kata diwakili oleh`Block`objek tipe WORD.

 `DetectDocumentText` adalah operasi tersinkron. Untuk menganalisis dokumen secara asinkron, gunakan[StartDocumentTextDetection](API_StartDocumentTextDetection.md).

Untuk informasi selengkapnya, lihat[Pendeteksi Teks Dokumen](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Sintaksis Permintaan
<a name="API_DetectDocumentText_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_DetectDocumentText_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [Document](#API_DetectDocumentText_RequestSyntax) **   <a name="Textract-DetectDocumentText-request-Document"></a>
Dokumen input sebagai byte yang dikodekan base64 atau objek Amazon S3. Jika Anda menggunakan AWS CLI untuk memanggil operasi Amazon Textract, Anda tidak dapat meneruskan byte citra. Dokumen harus berupa gambar dalam format JPEG atau PNG.  
Jika Anda menggunakan AWS SDK untuk memanggil Amazon Textract, Anda mungkin tidak perlu byte citra yang dikodekan base64 yang diteruskan menggunakan`Bytes`Bidang.   
Tipe: Objek [Document](API_Document.md)  
Diperlukan: Ya

## Sintaksis Respons
<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
   }
}
```

## Elemen Respons
<a name="API_DetectDocumentText_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-Blocks"></a>
Susunan rangkaian`Block`objek yang berisi teks yang terdeteksi dalam dokumen.  
Jenis: Array[Block](API_Block.md)objek

 ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DetectDocumentTextModelVersion"></a>
  
Jenis: String

 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DocumentMetadata"></a>
Metadata tentang dokumen. Ini berisi jumlah halaman yang terdeteksi dalam dokumen.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

## Kesalahan
<a name="API_DetectDocumentText_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron,`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract Texact tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Konfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract Texact untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_DetectDocumentText_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu spesifik bahasaAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText) 

# GetDocumentAnalysis
<a name="API_GetDocumentAnalysis"></a>

Mendapat hasil untuk operasi asinkron Amazon Texact yang menganalisis teks dalam dokumen.

Anda memulai analisis teks asinkron dengan menelepon[StartDocumentAnalysis](API_StartDocumentAnalysis.md), yang mengembalikan pengenal pekerjaan (`JobId`). Ketika operasi analisis teks selesai, Amazon Textract menerbitkan status selesai untuk topik Amazon Simple Notification Service (Amazon SNS) yang terdaftar dalam panggilan awal untuk`StartDocumentAnalysis`. Untuk mendapatkan hasil operasi deteksi teks, periksa terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi`GetDocumentAnalysis`, dan lulus pengenal pekerjaan (`JobId`) dari panggilan awal ke`StartDocumentAnalysis`.

 `GetDocumentAnalysis`mengembalikan array[Block](API_Block.md)objek. Jenis informasi berikut ini dikembalikan: 
+ Data formulir (pasangan nilai kunci). Informasi terkait dikembalikan dua[Block](API_Block.md)objek, masing-masing jenis`KEY_VALUE_SET`: KUNCI`Block`objek dan NILAI`Block`objek. Misalnya,*Nama: Ana Silva*berisi kunci dan nilai. *Nama:*adalah kuncinya. *Ana Silva*adalah nilai.
+ Tabel dan data sel tabel. TABEL`Block`objek berisi informasi tentang tabel terdeteksi. SEL`Block`objek dikembalikan untuk setiap sel dalam tabel.
+ Garis dan kata-kata teks. GARIS`Block`objek berisi satu atau lebih WORD`Block`objek. Semua baris dan kata-kata yang terdeteksi dalam dokumen dikembalikan (termasuk teks yang tidak memiliki hubungan dengan nilai`StartDocumentAnalysis` `FeatureTypes`parameter masukan). 

Elemen seleksi seperti kotak centang dan tombol opsi (tombol radio) dapat dideteksi dalam data formulir dan dalam tabel. SELECTION\$1ELEMENT`Block`objek berisi informasi tentang elemen seleksi, termasuk status seleksi.

Gunakan`MaxResults`parameter untuk membatasi jumlah blok yang dikembalikan. Jika hasil yang didapatkan lebih banyak daripada yang ditentukan dalam `MaxResults`, nilai `NextToken` dalam respons operasi berisi token pemberian nomor halaman untuk mendapatkan serangkaian hasil berikutnya. Untuk mendapatkan halaman hasil berikutnya, hubungi`GetDocumentAnalysis`, dan mengisi`NextToken`parameter permintaan dengan nilai token yang dikembalikan dari panggilan sebelumnya ke`GetDocumentAnalysis`.

Untuk informasi selengkapnya, lihat[Analisis Teks Dokumen](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Sintaksis Permintaan
<a name="API_GetDocumentAnalysis_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_GetDocumentAnalysis_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-JobId"></a>
Pengenal unik untuk tugas deteksi teks. `JobId` dikembalikan dari `StartDocumentAnalysis`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Ya

 ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-MaxResults"></a>
Jumlah hasil maksimum untuk mengembalikan per panggilan yang diberi nomor halaman. Nilai terbesar yang dapat Anda tentukan adalah 1.000. Jika Anda menentukan nilai yang lebih besar dari 1.000, maksimum 1.000 hasil dikembalikan. Nilai default adalah 1,000.  
Jenis: Bulat  
Rentang yang Valid: Nilai minimum 1.  
Diperlukan: Tidak

 ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-NextToken"></a>
Jika respons sebelumnya tidak lengkap (karena ada lebih banyak blok untuk diambil), Amazon Textract token pemberian nomor halaman sebagai responsnya. Anda dapat menggunakan token pemberian nomor halaman ini untuk mengambil set blok berikutnya.  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*`   
Diperlukan: Tidak

## Sintaksis Respons
<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 ]
      }
   ]
}
```

## Elemen Respons
<a name="API_GetDocumentAnalysis_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-AnalyzeDocumentModelVersion"></a>
  
Jenis: String

 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Blocks"></a>
Hasil operasi teks-analisis.  
Jenis: Array[Block](API_Block.md)objek

 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-DocumentMetadata"></a>
Informasi tentang dokumen yang diproses Amazon Textract Texact.`DocumentMetadata`dikembalikan di setiap halaman respons pemberian nomor halaman dari operasi Amazon Textract video.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-JobStatus"></a>
Status tugas deteksi teks.  
Jenis: Rangkaian  
Nilai Valid:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-NextToken"></a>
Jika respons terpotong, Amazon Textract mengembalikan token ini. Anda dapat menggunakan token ini dalam permintaan berikutnya untuk mengambil serangkaian hasil deteksi teks berikutnya.  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-StatusMessage"></a>
Pengembalian jika pekerjaan deteksi tidak dapat diselesaikan. Berisi penjelasan tentang kesalahan apa yang terjadi.  
Jenis: String

 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Warnings"></a>
Daftar peringatan yang terjadi selama operasi dokumen-analisis.  
Jenis: Array[Warning](API_Warning.md)objek

## Kesalahan
<a name="API_GetDocumentAnalysis_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidJobIdException **   
Pengenal pekerjaan yang tidak valid diteruskan ke[GetDocumentAnalysis](#API_GetDocumentAnalysis)atau untuk[GetDocumentAnalysis](#API_GetDocumentAnalysis).  
Kode Status HTTP: 400

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron,`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract Texact tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Mengkonfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract Texact untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

## Lihat Juga
<a name="API_GetDocumentAnalysis_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khususAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis) 

# GetDocumentTextDetection
<a name="API_GetDocumentTextDetection"></a>

Mendapat hasil untuk operasi asinkron Amazon Texact yang mendeteksi teks dalam dokumen. Amazon Textract dapat mendeteksi baris teks dan kata-kata yang membentuk baris teks.

Anda memulai deteksi teks asinkron dengan menelepon[StartDocumentTextDetection](API_StartDocumentTextDetection.md), yang mengembalikan pengenal pekerjaan (`JobId`). Ketika operasi deteksi teks selesai, Amazon Textract menerbitkan status penyelesaian ke topik Amazon Simple Notification Service (Amazon SNS) yang terdaftar dalam panggilan awal.`StartDocumentTextDetection`. Untuk mendapatkan hasil operasi deteksi teks, periksa terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi`GetDocumentTextDetection`, dan lulus pengenal pekerjaan (`JobId`) dari panggilan awal ke`StartDocumentTextDetection`.

 `GetDocumentTextDetection`mengembalikan array[Block](API_Block.md)benda. 

Setiap halaman dokumen memiliki sebagai terkait`Block`jenis HALAMAN. Setiap HALAMAN`Block`objek adalah induk dari LINE`Block`objek yang mewakili baris teks terdeteksi pada halaman. GARIS`Block`objek adalah orang tua untuk setiap kata yang membentuk baris. Kata-kata diwakili oleh`Block`objek tipe WORD.

Gunakan parameter MaxResults untuk membatasi jumlah blok yang dikembalikan. Jika hasil yang didapatkan lebih banyak daripada yang ditentukan dalam `MaxResults`, nilai `NextToken` dalam respons operasi berisi token pemberian nomor halaman untuk mendapatkan serangkaian hasil berikutnya. Untuk mendapatkan halaman hasil berikutnya, hubungi`GetDocumentTextDetection`, dan mengisi`NextToken`parameter permintaan dengan nilai token yang dikembalikan dari panggilan sebelumnya ke`GetDocumentTextDetection`.

Untuk informasi selengkapnya, lihat[Pendeteksi Teks](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Sintaksis Permintaan
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
Pengidentifikasi unik untuk tugas deteksi teks. `JobId` dikembalikan dari `StartDocumentTextDetection`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Ya

 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
Jumlah hasil maksimum untuk mengembalikan per panggilan yang diberi nomor halaman. Nilai terbesar yang dapat Anda tentukan adalah 1.000. Jika Anda menentukan nilai yang lebih besar dari 1.000, maksimum hasil dikembalikan adalah 1.000. Nilai default adalah 1,000.  
Jenis: Bulat  
Rentang yang Valid: Nilai minimum 1.  
Diperlukan: Tidak

 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
Jika respons sebelumnya tidak lengkap (karena ada lebih banyak blok untuk diambil), Amazon Textract mengembalikan token pemberian nomor halaman sebagai responsnya. Anda dapat menggunakan token pemberian nomor halaman ini untuk mengambil set blok berikutnya.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*`   
Diperlukan: Tidak

## Sintaksis Respons
<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 ]
      }
   ]
}
```

## Elemen Respons
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
Hasil operasi deteksi teks.  
Jenis: Array[Block](API_Block.md)objek

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
Jenis: String

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
Informasi tentang dokumen yang diproses Amazon Textract Texact.`DocumentMetadata`dikembalikan di setiap halaman respons yang diberi nomor halaman dari operasi video Amazon Textract.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
Status terkini tugas deteksi teks.  
Jenis: Rangkaian  
Nilai Valid:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
Jika respons terpotong, Amazon Textract mengembalikan token ini. Anda dapat menggunakan token ini dalam permintaan berikutnya untuk mengambil set hasil deteksi teks berikutnya.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
Pengembalian jika pekerjaan deteksi tidak dapat diselesaikan. Berisi penjelasan tentang kesalahan apa yang terjadi.   
Jenis: String

 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
Daftar peringatan yang terjadi selama operasi deteksi teks untuk dokumen.  
Jenis: Array[Warning](API_Warning.md)objek

## Kesalahan
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidJobIdException **   
Pengenal pekerjaan yang tidak valid diteruskan ke[GetDocumentAnalysis](API_GetDocumentAnalysis.md)atau untuk[GetDocumentAnalysis](API_GetDocumentAnalysis.md).  
Kode Status HTTP: 400

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron,`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Konfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract Texact untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

## Lihat Juga
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu spesifik bahasaAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) 

# GetExpenseAnalysis
<a name="API_GetExpenseAnalysis"></a>

Mendapat hasil untuk operasi asinkron Amazon Texact yang menganalisis faktur dan tanda terima. Amazon Textract menemukan informasi kontak, item yang dibeli, dan nama vendor, dari faktur masukan dan tanda terima.

Anda memulai analisis faktur asinkron/tanda terima dengan menelepon[StartExpenseAnalysis](API_StartExpenseAnalysis.md), yang mengembalikan pengenal pekerjaan (`JobId`). Setelah menyelesaikan analisis faktur, Amazon Texact menerbitkan status penyelesaian ke topik Amazon Simple Notification Service (Amazon SNS). Topik ini harus didaftarkan dalam panggilan awal`StartExpenseAnalysis`. Untuk mendapatkan hasil operasi analisis faktur, pastikan terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi`GetExpenseAnalysis`, dan lulus pengenal pekerjaan (`JobId`) dari panggilan awal ke`StartExpenseAnalysis`.

Gunakan parameter MaxResults untuk membatasi jumlah blok yang dikembalikan. Jika hasil yang didapatkan lebih banyak daripada yang ditentukan dalam `MaxResults`, nilai `NextToken` dalam respons operasi berisi token pemberian nomor halaman untuk mendapatkan serangkaian hasil berikutnya. Untuk mendapatkan halaman hasil berikutnya, hubungi`GetExpenseAnalysis`, dan mengisi`NextToken`parameter permintaan dengan nilai token yang dikembalikan dari panggilan sebelumnya ke`GetExpenseAnalysis`.

Untuk informasi selengkapnya, lihat[Menganalisis Faktur dan Penerimaan](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html).

## Sintaksis Permintaan
<a name="API_GetExpenseAnalysis_RequestSyntax"></a>

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

## Parameter Permintaan
<a name="API_GetExpenseAnalysis_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-JobId"></a>
Penidentifikasi unik untuk tugas deteksi teks. `JobId` dikembalikan dari `StartExpenseAnalysis`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Ya

 ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-MaxResults"></a>
Jumlah hasil maksimum untuk mengembalikan per panggilan yang diberi nomor halaman. Nilai terbesar yang dapat Anda tentukan adalah 20. Jika Anda menentukan nilai yang lebih besar dari 20, maksimum hasil dikembalikan adalah 20. Nilai default adalah 20.  
Jenis: Bulat  
Rentang yang Valid: Nilai minimum 1.  
Diperlukan: Tidak

 ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-NextToken"></a>
Jika respons sebelumnya tidak lengkap (karena ada lebih banyak blok untuk diambil), Amazon Textract mengembalikan token pemberian nomor halaman sebagai responsnya. Anda dapat menggunakan token pemberian nomor halaman ini untuk mengambil set blok berikutnya.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*`   
Diperlukan: Tidak

## Sintaksis Respons
<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 ]
      }
   ]
}
```

## Elemen Respons
<a name="API_GetExpenseAnalysis_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-AnalyzeExpenseModelVersion"></a>
Versi model saat AnalyzeExpense.  
Jenis: String

 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-DocumentMetadata"></a>
Informasi tentang dokumen yang diproses Amazon Textract Texact.`DocumentMetadata`dikembalikan di setiap halaman respons pemberian nomor halaman dari operasi Amazon Textract.  
Tipe: Objek [DocumentMetadata](API_DocumentMetadata.md)

 ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-ExpenseDocuments"></a>
Biaya yang terdeteksi oleh Amazon Textract.  
Jenis: Array[ExpenseDocument](API_ExpenseDocument.md)objek

 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-JobStatus"></a>
Status terkini tugas deteksi teks.  
Jenis: Rangkaian  
Nilai Valid:` IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-NextToken"></a>
Jika respons terpotong, Amazon Textract mengembalikan token ini. Anda dapat menggunakan token ini dalam permintaan berikutnya untuk mengambil serangkaian hasil deteksi teks berikutnya.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.  
Pola: `.*\S.*` 

 ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-StatusMessage"></a>
Pengembalian jika pekerjaan deteksi tidak dapat diselesaikan. Berisi penjelasan tentang kesalahan apa yang terjadi.   
Jenis: String

 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-Warnings"></a>
Daftar peringatan yang terjadi selama operasi deteksi teks untuk dokumen.  
Jenis: Array[Warning](API_Warning.md)objek

## Kesalahan
<a name="API_GetExpenseAnalysis_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract Texact mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidJobIdException **   
Pengenal pekerjaan yang tidak valid diteruskan ke[GetDocumentAnalysis](API_GetDocumentAnalysis.md)atau untuk[GetDocumentAnalysis](API_GetDocumentAnalysis.md).  
Kode Status HTTP: 400

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron,`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract Texact tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Konfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract Texact untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

## Lihat Juga
<a name="API_GetExpenseAnalysis_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu spesifik bahasaAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis) 

# StartDocumentAnalysis
<a name="API_StartDocumentAnalysis"></a>

Mulai analisis asinkron dari dokumen masukan untuk hubungan antara item terdeteksi seperti pasangan kunci-nilai, tabel, dan elemen seleksi.

 `StartDocumentAnalysis`dapat menganalisis teks dalam dokumen yang ada dalam format JPEG, PNG, TIFF, dan PDF. Dokumen-dokumen tersebut disimpan di bucket Amazon S3. Gunakan[DocumentLocation](API_DocumentLocation.md)untuk menentukan nama bucket dan nama file dokumen. 

 `StartDocumentAnalysis`mengembalikan pengenal pekerjaan (`JobId`) yang Anda gunakan untuk mendapatkan hasil operasi. Ketika analisis teks selesai, Amazon Textract menerbitkan status selesai untuk topik Amazon Simple Notification Service (Amazon SNS) yang Anda tentukan di`NotificationChannel`. Untuk mendapatkan hasil operasi analisis teks, periksa terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi[GetDocumentAnalysis](API_GetDocumentAnalysis.md), dan lulus pengenal pekerjaan (`JobId`) dari panggilan awal ke`StartDocumentAnalysis`.

Untuk informasi selengkapnya, lihat[Analisis Teks Dokumen](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Sintaksis Permintaan
<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"
   }
}
```

## Parameter Permintaan
<a name="API_StartDocumentAnalysis_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-ClientRequestToken"></a>
Token idempotensi yang Anda gunakan untuk mengidentifikasi permintaan mulai. Jika Anda menggunakan token yang sama dengan beberapa permintaan `StartDocumentAnalysis`, `JobId` yang sama dikembalikan. Gunakan`ClientRequestToken`untuk mencegah agar tidak ada tugas yang sama yang dimulai secara tidak sengaja lebih dari sekali. Untuk informasi selengkapnya, lihat[Memanggil Operasi Asinkron Amazon Texact](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Tidak

 ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-DocumentLocation"></a>
Lokasi dokumen yang akan diproses.  
Tipe: Objek [DocumentLocation](API_DocumentLocation.md)  
Diperlukan: Ya

 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-FeatureTypes"></a>
Daftar jenis analisis untuk melakukan. Tambahkan TABEL ke daftar untuk mengembalikan informasi tentang tabel yang terdeteksi dalam dokumen input. Tambahkan FORMS untuk mengembalikan data formulir yang terdeteksi. Untuk melakukan kedua jenis analisis, tambahkan TABEL dan BENTUK ke`FeatureTypes`. Semua baris dan kata yang terdeteksi dalam dokumen disertakan dalam respons (termasuk teks yang tidak terkait dengan nilai`FeatureTypes`).   
Jenis: Array string  
Nilai Valid:` TABLES | FORMS`   
Diperlukan: Ya

 ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-JobTag"></a>
Pengenal yang Anda tetapkan yang disertakan dalam notifikasi penyelesaian yang dipublikasikan ke topik Amazon SNS. Misalnya, Anda dapat menggunakan`JobTag`untuk mengidentifikasi jenis dokumen yang sesuai dengan pemberitahuan penyelesaian (seperti formulir pajak atau tanda terima).  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `[a-zA-Z0-9_.\-:]+`   
Diperlukan: Tidak

 ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-KMSKeyId"></a>
Kunci KMS yang digunakan untuk mengenkripsi hasil kesimpulan. Hal ini dapat baik dalam Key ID atau Key Alias format. Ketika kunci KMS disediakan, kunci KMS akan digunakan untuk enkripsi sisi server dari objek dalam ember pelanggan. Ketika parameter ini tidak diaktifkan, hasilnya akan dienkripsi sisi server, menggunakan SSE-S3.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.  
Pola: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Diperlukan: Tidak

 ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-NotificationChannel"></a>
ARN topik Amazon SNS yang Anda inginkan agar Amazon Textract mempublikasikan status penyelesaian operasi.   
Tipe: Objek [NotificationChannel](API_NotificationChannel.md)  
Diperlukan: Tidak

 ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-OutputConfig"></a>
Set jika output akan pergi ke ember pelanggan didefinisikan. Secara default, Amazon Textract akan menyimpan hasil secara internal untuk diakses oleh operasi GetDocumentAnalysis.  
Tipe: Objek [OutputConfig](API_OutputConfig.md)  
Diperlukan: Tidak

## Sintaksis Respons
<a name="API_StartDocumentAnalysis_ResponseSyntax"></a>

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

## Elemen Respons
<a name="API_StartDocumentAnalysis_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) **   <a name="Textract-StartDocumentAnalysis-response-JobId"></a>
Pengidentifikasi untuk tugas deteksi teks dokumen. Gunakan `JobId` untuk mengidentifikasi tugas dalam panggilan berikutnya ke `GetDocumentAnalysis`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$` 

## Kesalahan
<a name="API_StartDocumentAnalysis_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** IdempotentParameterMismatchException **   
Parameter input `ClientRequestToken` digunakan kembali dengan suatu operasi, tapi setidaknya salah satu parameter input lainnya berbeda dari panggilan ke operasi sebelumnya.   
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron,`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Mengkonfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** LimitExceededException **   
Batas layanan Amazon Textract terlampaui. Misalnya, jika Anda memulai terlalu banyak pekerjaan asinkron secara bersamaan, panggilan untuk memulai operasi (`StartDocumentTextDetection`Misalnya) menaikkan pengecualian LimitExceededException (kode status HTTP: 400) hingga jumlah tugas yang berjalan bersamaan di bawah batas layanan Amazon Textract TExceededException.   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_StartDocumentAnalysis_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa yang spesifikAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis) 

# StartDocumentTextDetection
<a name="API_StartDocumentTextDetection"></a>

Mulai deteksi tidak sinkron terhadap teks dalam dokumen. Amazon Textract dapat mendeteksi baris teks dan kata-kata yang membentuk baris teks.

 `StartDocumentTextDetection`dapat menganalisis teks dalam dokumen yang ada dalam format JPEG, PNG, TIFF, dan PDF. Dokumen-dokumen tersebut disimpan di bucket Amazon S3. Gunakan[DocumentLocation](API_DocumentLocation.md)untuk menentukan nama bucket dan nama file dokumen. 

 `StartTextDetection`mengembalikan pengenal pekerjaan (`JobId`) yang Anda gunakan untuk mendapatkan hasil operasi. Ketika deteksi teks selesai, Amazon Textract menerbitkan status selesai untuk topik Amazon Simple Notification Service (Amazon SNS) yang Anda tentukan di`NotificationChannel`. Untuk mendapatkan hasil operasi deteksi teks, periksa terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi[GetDocumentTextDetection](API_GetDocumentTextDetection.md), dan lulus pengenal pekerjaan (`JobId`) dari panggilan awal ke`StartDocumentTextDetection`.

Untuk informasi selengkapnya, lihat[Pendeteksi Teks Dokumen](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Sintaksis Permintaan
<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"
   }
}
```

## Parameter Permintaan
<a name="API_StartDocumentTextDetection_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-ClientRequestToken"></a>
Token idempotensi yang digunakan untuk mengidentifikasi permintaan mulai. Jika Anda menggunakan token yang sama dengan beberapa permintaan `StartDocumentTextDetection`, `JobId` yang sama dikembalikan. Gunakan`ClientRequestToken`untuk mencegah agar tidak ada tugas yang sama yang dimulai secara tidak sengaja lebih dari sekali. Untuk informasi selengkapnya, lihat[Memanggil Operasi Asinkron Amazon Texact](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Tidak

 ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-DocumentLocation"></a>
Lokasi dokumen yang akan diproses.  
Tipe: Objek [DocumentLocation](API_DocumentLocation.md)  
Diperlukan: Ya

 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-JobTag"></a>
Pengenal yang Anda tetapkan yang disertakan dalam notifikasi penyelesaian yang dipublikasikan ke topik Amazon SNS. Misalnya, Anda dapat menggunakan`JobTag`untuk mengidentifikasi jenis dokumen yang sesuai dengan pemberitahuan penyelesaian (seperti formulir pajak atau tanda terima).  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `[a-zA-Z0-9_.\-:]+`   
Diperlukan: Tidak

 ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-KMSKeyId"></a>
Kunci KMS yang digunakan untuk mengenkripsi hasil inferensi. Hal ini dapat baik dalam Key ID atau Key Alias format. Ketika kunci KMS disediakan, kunci KMS akan digunakan untuk enkripsi sisi server dari objek dalam ember pelanggan. Ketika parameter ini tidak diaktifkan, hasilnya akan dienkripsi sisi server, menggunakan SSE-S3.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.  
Pola: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Diperlukan: Tidak

 ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-NotificationChannel"></a>
ARN topik Amazon SNS yang Anda inginkan agar Amazon Textract mempublikasikan status selesai operasi.   
Tipe: Objek [NotificationChannel](API_NotificationChannel.md)  
Diperlukan: Tidak

 ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-OutputConfig"></a>
Set jika output akan pergi ke ember pelanggan didefinisikan. Secara default Amazon Textract akan menyimpan hasil secara internal untuk diakses dengan operasi GetDocumentTextDetection.  
Tipe: Objek [OutputConfig](API_OutputConfig.md)  
Diperlukan: Tidak

## Sintaksis Respons
<a name="API_StartDocumentTextDetection_ResponseSyntax"></a>

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

## Elemen Respons
<a name="API_StartDocumentTextDetection_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) **   <a name="Textract-StartDocumentTextDetection-response-JobId"></a>
Pengidentifikasi tugas deteksi teks untuk dokumen tersebut. Gunakan `JobId` untuk mengidentifikasi tugas dalam panggilan berikutnya ke `GetDocumentTextDetection`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$` 

## Kesalahan
<a name="API_StartDocumentTextDetection_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** IdempotentParameterMismatchException **   
Parameter input `ClientRequestToken` digunakan kembali dengan suatu operasi, tapi setidaknya salah satu parameter input lainnya berbeda dari panggilan ke operasi sebelumnya.   
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron, sebuah`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Konfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** LimitExceededException **   
Batas layanan Amazon Textract terlampaui. Misalnya, jika Anda memulai terlalu banyak pekerjaan asinkron secara bersamaan, panggilan untuk memulai operasi (`StartDocumentTextDetection`, misalnya) menaikkan pengecualian LimitExceededException (kode status HTTP: 400) hingga jumlah tugas yang berjalan bersamaan di bawah batas layanan Amazon Textract TException.   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_StartDocumentTextDetection_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu bahasa khususAWSSDK, lihat berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection) 

# StartExpenseAnalysis
<a name="API_StartExpenseAnalysis"></a>

Memulai analisis asinkron faktur atau tanda terima untuk data seperti informasi kontak, item yang dibeli, dan nama vendor.

 `StartExpenseAnalysis`dapat menganalisis teks dalam dokumen yang dalam format JPEG, PNG, dan PDF. Dokumen harus disimpan di bucket Amazon S3. Gunakan[DocumentLocation](API_DocumentLocation.md)parameter untuk menentukan nama bucket S3 Anda dan nama dokumen dalam ember itu. 

 `StartExpenseAnalysis`mengembalikan pengenal pekerjaan (`JobId`) yang akan Anda berikan`GetExpenseAnalysis`untuk mengambil hasil operasi. Ketika analisis faktur input/tanda terima selesai, Amazon Textract menerbitkan status penyelesaian ke topik Amazon Simple Notification Service (Amazon SNS) yang Anda berikan kepada`NotificationChannel`. Untuk mendapatkan hasil operasi analisis faktur dan penerimaan, pastikan bahwa nilai status yang diterbitkan ke topik Amazon SNS adalah`SUCCEEDED`. Jika ya, hubungi[GetExpenseAnalysis](API_GetExpenseAnalysis.md), dan lulus pengenal pekerjaan (`JobId`) yang dikembalikan oleh panggilan Anda ke`StartExpenseAnalysis`.

Untuk informasi selengkapnya, lihat[Menganalisis Faktur dan Penerimaan](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html).

## Sintaksis Permintaan
<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"
   }
}
```

## Parameter Permintaan
<a name="API_StartExpenseAnalysis_RequestParameters"></a>

Permintaan menerima data berikut dalam format JSON.

 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-ClientRequestToken"></a>
Token idempotensi yang digunakan untuk mengidentifikasi permintaan mulai. Jika Anda menggunakan token yang sama dengan beberapa permintaan `StartDocumentTextDetection`, `JobId` yang sama dikembalikan. Gunakan`ClientRequestToken`untuk mencegah agar tidak ada tugas yang sama yang dimulai lebih dari sekali. Untuk informasi selengkapnya, lihat[Memanggil Operasi Asinkron Amazon Texact](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)   
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$`   
Diperlukan: Tidak

 ** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-DocumentLocation"></a>
Lokasi dokumen yang akan diproses.  
Tipe: Objek [DocumentLocation](API_DocumentLocation.md)  
Diperlukan: Ya

 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-JobTag"></a>
Pengidentifikasi yang Anda tentukan yang disertakan dalam notifikasi penyelesaian yang diterbitkan ke topik Amazon SNS. Misalnya, Anda dapat menggunakan`JobTag`untuk mengidentifikasi jenis dokumen yang sesuai dengan pemberitahuan penyelesaian (seperti formulir pajak atau tanda terima).  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `[a-zA-Z0-9_.\-:]+`   
Diperlukan: Tidak

 ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-KMSKeyId"></a>
Kunci KMS yang digunakan untuk mengenkripsi hasil kesimpulan. Hal ini dapat baik dalam Key ID atau Key Alias format. Ketika kunci KMS disediakan, kunci KMS akan digunakan untuk enkripsi sisi server dari objek dalam ember pelanggan. Ketika parameter ini tidak diaktifkan, hasilnya akan dienkripsi sisi server, menggunakan SSE-S3.  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum 2048.  
Pola: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Diperlukan: Tidak

 ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-NotificationChannel"></a>
ARN topik Amazon SNS yang Anda inginkan Amazon Textract mempublikasikan status penyelesaian operasi.   
Tipe: Objek [NotificationChannel](API_NotificationChannel.md)  
Diperlukan: Tidak

 ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-OutputConfig"></a>
Set jika output akan pergi ke ember pelanggan didefinisikan. Secara default, Amazon Textract akan menyimpan hasil secara internal untuk diakses oleh`GetExpenseAnalysis`operasi.  
Tipe: Objek [OutputConfig](API_OutputConfig.md)  
Diperlukan: Tidak

## Sintaksis Respons
<a name="API_StartExpenseAnalysis_ResponseSyntax"></a>

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

## Elemen Respons
<a name="API_StartExpenseAnalysis_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) **   <a name="Textract-StartExpenseAnalysis-response-JobId"></a>
Pengidentifikasi unik untuk tugas deteksi teks. `JobId` dikembalikan dari `StartExpenseAnalysis`. SEBUAH`JobId`Nilai hanya berlaku selama 7 hari.  
Jenis: String  
Batasan: Panjang minimum 1. Panjang maksimum adalah 64.  
Pola: `^[a-zA-Z0-9-_]+$` 

## Kesalahan
<a name="API_StartExpenseAnalysis_Errors"></a>

 ** AccessDeniedException **   
Anda tidak berwenang untuk melakukan tindakan. Gunakan Amazon Resource Name (ARN) dari pengguna resmi atau IAM role untuk melakukan operasi.  
Kode Status HTTP: 400

 ** BadDocumentException **   
Amazon Textract tidak dapat membaca dokumen. Untuk informasi selengkapnya tentang batas dokumen di Amazon Textract, lihat[Batas Keras di Amazon Textract](limits.md).  
Kode Status HTTP: 400

 ** DocumentTooLargeException **   
Dokumen tidak dapat diproses karena terlalu besar. Ukuran dokumen maksimum untuk operasi sinkron 10 MB. Ukuran dokumen maksimum untuk operasi asinkron adalah 500 MB untuk file PDF.  
Kode Status HTTP: 400

 ** IdempotentParameterMismatchException **   
Parameter input `ClientRequestToken` digunakan kembali dengan suatu operasi, tapi setidaknya salah satu parameter input lainnya berbeda dari panggilan ke operasi sebelumnya.   
Kode Status HTTP: 400

 ** InternalServerError **   
Amazon Textract mengalami masalah layanan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** InvalidKMSKeyException **   
 Menunjukkan bahwa Anda tidak memiliki izin mendekripsi dengan kunci KMS yang dimasukkan, atau kunci KMS dimasukkan secara tidak benar.   
Kode Status HTTP: 400

 ** InvalidParameterException **   
Parameter input melanggar batasan. Misalnya, dalam operasi sinkron, sebuah`InvalidParameterException`pengecualian terjadi ketika salah satu`S3Object`atau`Bytes`nilai-nilai yang disediakan dalam`Document`parameter permintaan. Validasi parameter Anda sebelum memanggil operasi API lagi.  
Kode Status HTTP: 400

 ** InvalidS3ObjectException **   
Amazon Textract tidak dapat mengakses objek S3 yang ditentukan dalam permintaan. untuk informasi selengkapnya,[Mengonfigurasi Akses ke Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html)Untuk informasi pemecahan masalah, lihat[Pemecahan Masalah Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
Kode Status HTTP: 400

 ** LimitExceededException **   
Batas layanan Amazon Textract terlampaui. Misalnya, jika Anda memulai terlalu banyak pekerjaan asinkron secara bersamaan, panggilan untuk memulai operasi (`StartDocumentTextDetection`, misalnya) menaikkan pengecualian LimitExceededException (kode status HTTP: 400) hingga jumlah tugas yang berjalan bersamaan di bawah batas layanan Amazon Textract TExceededException.   
Kode Status HTTP: 400

 ** ProvisionedThroughputExceededException **   
Jumlah permintaan melebihi batas throughput Anda. Jika Anda ingin meningkatkan batas ini, hubungi Amazon Textract.  
Kode Status HTTP: 400

 ** ThrottlingException **   
Amazon Textract untuk sementara tidak dapat memproses permintaan. Coba lagi panggilan Anda.  
Kode Status HTTP: 500

 ** UnsupportedDocumentException **   
Format dokumen input tidak didukung. Dokumen untuk operasi dapat dalam format PNG, JPEG, PDF, atau TIFF.  
Kode Status HTTP: 400

## Lihat Juga
<a name="API_StartExpenseAnalysis_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API di salah satu bahasaAWSSDK, lihat yang berikut ini:
+  [AWSAntarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK 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) 
+  [AWSSDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis)