GetDocumentAnalysis - Amazon Textract
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

GetDocumentAnalysis

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

Anda memulai analisis teks asinkron dengan meneleponStartDocumentAnalysis, 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 untukStartDocumentAnalysis. Untuk mendapatkan hasil operasi deteksi teks, periksa terlebih dahulu bahwa nilai status yang diterbitkan ke topik Amazon SNS adalahSUCCEEDED. Jika ya, hubungiGetDocumentAnalysis, dan lulus pengenal pekerjaan (JobId) dari panggilan awal keStartDocumentAnalysis.

GetDocumentAnalysismengembalikan arrayBlockobjek. Jenis informasi berikut ini dikembalikan:

  • Data formulir (pasangan nilai kunci). Informasi terkait dikembalikan duaBlockobjek, masing-masing jenisKEY_VALUE_SET: KUNCIBlockobjek dan NILAIBlockobjek. Misalnya,Nama: Ana Silvaberisi kunci dan nilai. Nama:adalah kuncinya. Ana Silvaadalah nilai.

  • Tabel dan data sel tabel. TABELBlockobjek berisi informasi tentang tabel terdeteksi. SELBlockobjek dikembalikan untuk setiap sel dalam tabel.

  • Garis dan kata-kata teks. GARISBlockobjek berisi satu atau lebih WORDBlockobjek. Semua baris dan kata-kata yang terdeteksi dalam dokumen dikembalikan (termasuk teks yang tidak memiliki hubungan dengan nilaiStartDocumentAnalysis FeatureTypesparameter masukan).

Elemen seleksi seperti kotak centang dan tombol opsi (tombol radio) dapat dideteksi dalam data formulir dan dalam tabel. SELECTION_ELEMENTBlockobjek berisi informasi tentang elemen seleksi, termasuk status seleksi.

GunakanMaxResultsparameter 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, hubungiGetDocumentAnalysis, dan mengisiNextTokenparameter permintaan dengan nilai token yang dikembalikan dari panggilan sebelumnya keGetDocumentAnalysis.

Untuk informasi selengkapnya, lihatAnalisis Teks Dokumen.

Sintaksis Permintaan

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

Parameter Permintaan

Permintaan menerima data berikut dalam format JSON.

JobId

Pengenal unik untuk tugas deteksi teks. JobId dikembalikan dari StartDocumentAnalysis. SEBUAHJobIdNilai hanya berlaku selama 7 hari.

Jenis: String

Batasan: Panjang minimum 1. Panjang maksimum adalah 64.

Pola: ^[a-zA-Z0-9-_]+$

Diperlukan: Ya

MaxResults

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

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

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

AnalyzeDocumentModelVersion

Jenis: String

Blocks

Hasil operasi teks-analisis.

Jenis: ArrayBlockobjek

DocumentMetadata

Informasi tentang dokumen yang diproses Amazon Textract Texact.DocumentMetadatadikembalikan di setiap halaman respons pemberian nomor halaman dari operasi Amazon Textract video.

Tipe: Objek DocumentMetadata

JobStatus

Status tugas deteksi teks.

Jenis: Rangkaian

Nilai Valid: IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS

NextToken

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

Pengembalian jika pekerjaan deteksi tidak dapat diselesaikan. Berisi penjelasan tentang kesalahan apa yang terjadi.

Jenis: String

Warnings

Daftar peringatan yang terjadi selama operasi dokumen-analisis.

Jenis: ArrayWarningobjek

Kesalahan

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 keGetDocumentAnalysisatau untukGetDocumentAnalysis.

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,InvalidParameterExceptionpengecualian terjadi ketika salah satuS3ObjectatauBytesnilai-nilai yang disediakan dalamDocumentparameter 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 S3Untuk informasi pemecahan masalah, lihatPemecahan Masalah Amazon S3

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

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khususAWSSDK, lihat yang berikut ini: