Document Models - Analyze Document

Layanan:

Azure AI Services

Versi API:

2022-08-31

Menganalisis dokumen dengan model dokumen.

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

Dengan parameter opsional:

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

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).
modelId	path	True	string pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}	Nama model dokumen unik.
api-version	query	True	ApiVersion	Versi API yang diminta.
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 pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	Daftar nomor halaman berbasis 1 untuk dianalisis. Bekas. "1-3,5,7-9"
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"

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

Isi Permintaan

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Nama	Jenis	Deskripsi
base64Source	string (byte)	Pengodean base64 dokumen untuk dianalisis
urlSource	string (uri)	URL Dokumen untuk dianalisis

Respons

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

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Permintaan sampel

HTTP

POST {endpoint}/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "base64Source": ""
}

Respon sampel

Kode status:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version=2022-08-31

AnalyzeDocument_Url

Permintaan sampel

HTTP

POST {endpoint}/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

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

Respon sampel

Kode status:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version=2022-08-31

Definisi

Nama	Deskripsi
AnalyzeDocumentRequest	Parameter analisis dokumen.
ApiVersion	Versi API.
Error	Info kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Kesalahan terperinci.
StringIndexType	Metode yang digunakan untuk menghitung offset dan panjang string.

AnalyzeDocumentRequest

Objek

Parameter analisis dokumen.

Nama	Jenis	Deskripsi
base64Source	string (byte)	Pengodean base64 dokumen untuk dianalisis
urlSource	string (uri)	URL Dokumen untuk dianalisis

ApiVersion

Enumerasi

Versi API.

Nilai	Deskripsi
2022-08-31

Error

Objek

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

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Objek

Kesalahan terperinci.

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

StringIndexType

Enumerasi

Metode yang digunakan untuk menghitung offset dan panjang string.

Nilai	Deskripsi
textElements
unicodeCodePoint
utf16CodeUnit