Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Menganalisis dokumen dengan model dokumen.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir layanan Inteligensi Dokumen.
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 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").
outputContentFormat	query		ContentFormat	Format hasil analisis konten tingkat atas.
pages	query		string	Daftar nomor halaman berbasis 1 untuk dianalisis. Mis. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Daftar bidang tambahan yang akan diekstrak. Mis. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metode yang digunakan untuk menghitung offset dan panjang string.

Isi Permintaan

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 telah diterima untuk diproses, tetapi pemrosesan belum selesai. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Contoh

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

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

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

Sample Response

Status code:

202

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

Definisi

Nama	Deskripsi
AnalyzeDocumentRequest	Parameter analisis dokumen.
ContentFormat	Format konten dalam hasil yang dianalisis.
DocumentAnalysisFeature	Daftar fitur analisis opsional.
Error	Objek kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.
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.

ContentFormat

Format konten dalam hasil yang dianalisis.

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

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 cetakan halus.
queryFields	string	Aktifkan ekstraksi bidang tambahan melalui parameter kueri queryFields.
styleFont	string	Aktifkan pengenalan berbagai gaya font.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerError	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.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.

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

StringIndexType

Metode yang digunakan untuk menghitung offset dan panjang string.

Nama	Jenis	Deskripsi
textElements	string	Karakter tampilan yang dirasakan pengguna, atau kluster grafik, 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.