Document Models - Analyze Document

Layanan:

Azure AI Services

Versi API:

2024-11-30

Menganalisis dokumen dengan model dokumen.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

Dengan parameter opsional:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir layanan Kecerdasan Dokumen.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nama model dokumen unik.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.
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").
output	query		AnalyzeOutputOption[]	Output tambahan untuk dihasilkan selama analisis.
outputContentFormat	query		DocumentContentFormat	Format konten tingkat atas hasil analisis.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	Nomor halaman berbasis 1 untuk dianalisis. Bekas. "1-3,5,7-9"
queryFields	query		string[]	Daftar bidang tambahan yang akan diekstrak. Bekas. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metode yang digunakan untuk menghitung offset dan panjang string.

Isi Permintaan

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

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Respons kesalahan tak terduga.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Permintaan sampel

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Respon sampel

Kode status:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Analyze Document from Url

Permintaan sampel

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

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

Respon sampel

Kode status:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definisi

Nama	Deskripsi
AnalyzeDocumentRequest	Parameter analisis dokumen.
AnalyzeOutputOption	Output tambahan untuk dihasilkan selama analisis.
DocumentAnalysisFeature	Fitur analisis dokumen untuk diaktifkan.
DocumentContentFormat	Format konten dalam hasil yang dianalisis.
DocumentIntelligenceError	Objek kesalahan.
DocumentIntelligenceErrorResponse	Objek respons kesalahan.
DocumentIntelligenceInnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
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 atau base64Source harus ditentukan.
urlSource	string (uri)	URL Dokumen untuk dianalisis. UrlSource atau base64Source harus ditentukan.

AnalyzeOutputOption

Enumeration

Output tambahan untuk dihasilkan selama analisis.

Nilai	Deskripsi
figures	Hasilkan gambar yang dipotong dari gambar yang terdeteksi.
pdf	Hasilkan output PDF yang dapat dicari.

DocumentAnalysisFeature

Enumeration

Fitur analisis dokumen untuk diaktifkan.

Nilai	Deskripsi
barcodes	Aktifkan deteksi kode batang dalam dokumen.
formulas	Aktifkan deteksi ekspresi matematika dalam dokumen.
keyValuePairs	Aktifkan deteksi pasangan nilai kunci umum (bidang formulir) dalam dokumen.
languages	Aktifkan deteksi bahasa konten teks.
ocrHighResolution	Lakukan OCR pada resolusi yang lebih tinggi untuk menangani dokumen dengan cetakan halus.
queryFields	Aktifkan ekstraksi bidang tambahan melalui parameter kueri queryFields.
styleFont	Aktifkan pengenalan berbagai gaya font.

DocumentContentFormat

Enumeration

Format konten dalam hasil yang dianalisis.

Nilai	Deskripsi
markdown	Representasi markdown konten dokumen dengan judul bagian, tabel, dll.
text	Representasi teks biasa dari konten dokumen tanpa pemformatan apa pun.

DocumentIntelligenceError

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	DocumentIntelligenceError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	DocumentIntelligenceInnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

DocumentIntelligenceErrorResponse

Objek

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	DocumentIntelligenceError	Info kesalahan.

DocumentIntelligenceInnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	DocumentIntelligenceInnerError	Kesalahan dalam.
message	string	Representasi kesalahan yang dapat dibaca manusia.

StringIndexType

Enumeration

Metode yang digunakan untuk menghitung offset dan panjang string.

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