Analyzer - Analyze Id Document

Layanan:

Azure AI Services

Versi API:

2.1

Ekstrak teks bidang dan nilai semantik dari dokumen ID tertentu. Dokumen input harus dari salah satu jenis konten yang didukung - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' atau 'image/bmp'. Atau, gunakan jenis 'application/json' untuk menentukan lokasi (Uri) dokumen yang akan dianalisis.

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

Dengan parameter opsional:

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze?includeTextDetails={includeTextDetails}&pages={pages}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Sertakan baris teks dan referensi elemen dalam hasilnya.
pages	query		string[]	Nomor halaman kustom untuk dokumen multi-halaman (PDF/TIFF), masukkan jumlah halaman yang ingin Anda dapatkan hasil OCR. Untuk rentang halaman, gunakan tanda hubung. Pisahkan setiap halaman atau rentang dengan koma.

Header Permintaan

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Isi Permintaan

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nama	Jenis	Deskripsi
source	string minLength: 0 maxLength: 2048	Jalur sumber file.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan berhasil diantrekan. Header Operation-Location: string
Other Status Codes	ErrorResponse	Entitas respons yang menyertai respons yang tidak berhasil berisi detail tambahan tentang kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

Analyze ID

Permintaan sampel

HTTP

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

Respon sampel

Kode status:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definisi

Nama	Deskripsi
ErrorInformation
ErrorResponse
SourcePath	Uri atau jalur lokal ke data sumber.

ErrorInformation

Objek

Nama	Jenis	Deskripsi
code	string
message	string

ErrorResponse

Objek

Nama	Jenis	Deskripsi
error	ErrorInformation

SourcePath

Objek

Uri atau jalur lokal ke data sumber.

Nama	Jenis	Deskripsi
source	string minLength: 0 maxLength: 2048	Jalur sumber file.