Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Menganalisis dokumen dengan model dokumen.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string url	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Nama model dokumen unik. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Versi API yang diminta.
features	query		DocumentAnalysisFeature[]	Daftar fitur analisis opsional.
locale	query		string	Petunjuk lokal untuk pengenalan teks dan analisis dokumen. Nilai hanya boleh berisi kode bahasa (mis. "en", "fr") atau tag bahasa BCP 47 (mis. "en-US").
pages	query		string	Daftar nomor halaman berbasis 1 untuk dianalisis. Mis. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metode yang digunakan untuk menghitung offset dan panjang string.

Header Permintaan

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Kunci rahasia untuk langganan Azure Cognitive Services Anda.

Isi Permintaan

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nama	Jenis	Deskripsi
base64Source	string	Pengodean base64 dokumen untuk dianalisis. UrlSource atau base64Source harus ditentukan.
urlSource	string	URL Dokumen untuk dianalisis. UrlSource atau base64Source harus ditentukan.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan berhasil diantrekan. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Kunci rahasia untuk langganan Azure Cognitive Services Anda.

Type: apiKey
In: header

Contoh

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "urlSource": "http://host.com/doc.pdf"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definisi

Nama	Deskripsi
AnalyzeDocumentRequest	Parameter analisis dokumen.
DocumentAnalysisFeature	Daftar fitur analisis opsional.
Error	Info kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Kesalahan terperinci.
StringIndexType	Metode yang digunakan untuk menghitung offset dan panjang string.

AnalyzeDocumentRequest

Parameter analisis dokumen.

Nama	Jenis	Deskripsi
base64Source	string	Pengodean base64 dokumen untuk dianalisis. UrlSource atau base64Source harus ditentukan.
urlSource	string	URL Dokumen untuk dianalisis. UrlSource atau base64Source harus ditentukan.

DocumentAnalysisFeature

Daftar fitur analisis opsional.

Nama	Jenis	Deskripsi
barcodes	string	Aktifkan deteksi kode batang dalam dokumen.
formulas	string	Aktifkan deteksi ekspresi matematika dalam dokumen.
keyValuePairs	string	Aktifkan deteksi pasangan nilai kunci umum (bidang formulir) dalam dokumen.
languages	string	Aktifkan deteksi bahasa konten teks.
ocrHighResolution	string	Lakukan OCR pada resolusi yang lebih tinggi untuk menangani dokumen dengan cetak halus.
styleFont	string	Aktifkan pengenalan berbagai gaya font.

Error

Info kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	Error[]	Daftar kesalahan terperinci.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.

StringIndexType

Metode yang digunakan untuk menghitung offset dan panjang string.

Nama	Jenis	Deskripsi
textElements	string	Karakter tampilan yang dirasakan pengguna, atau kluster grapheme, seperti yang didefinisikan oleh Unicode 8.0.0.
unicodeCodePoint	string	Unit karakter diwakili oleh satu titik kode unicode. Digunakan oleh Python 3.
utf16CodeUnit	string	Unit karakter diwakili oleh unit kode Unicode 16-bit. Digunakan oleh JavaScript, Java, dan .NET.