Document Models - Analyze Document
Menganalisis dokumen dengan model dokumen.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&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. |
model
|
path | True |
string |
Nama model dokumen unik. Pola regex: |
api-version
|
query | True |
string |
Versi API yang akan digunakan untuk operasi ini. |
features
|
query |
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 |
Output tambahan untuk dihasilkan selama analisis. |
||
output
|
query |
Format konten tingkat atas hasil analisis. |
||
pages
|
query |
string |
Daftar nomor halaman berbasis 1 untuk dianalisis. Bekas. "1-3,5,7-9" Pola regex: |
|
query
|
query |
string[] |
Daftar bidang tambahan yang akan diekstrak. Bekas. "NumberOfGuests,StoreNumber" |
|
string
|
query |
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. Header
|
|
Other Status Codes |
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
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements
{
"base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}
Respon sampel
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview
Analyze Document from Url
Permintaan sampel
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Respon sampel
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview
Definisi
Nama | Deskripsi |
---|---|
Analyze |
Parameter analisis dokumen. |
Analyze |
Output tambahan untuk dihasilkan selama analisis. |
Content |
Format konten dalam hasil yang dianalisis. |
Document |
Fitur analisis dokumen untuk diaktifkan. |
Error |
Objek kesalahan. |
Error |
Objek respons kesalahan. |
Inner |
Objek yang berisi informasi yang lebih spesifik tentang kesalahan. |
String |
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. |
AnalyzeOutputOption
Output tambahan untuk dihasilkan selama analisis.
Nama | Jenis | Deskripsi |
---|---|---|
figures |
string |
Hasilkan gambar yang dipotong dari gambar yang terdeteksi. |
string |
Hasilkan output PDF yang dapat dicari. |
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
Fitur analisis dokumen untuk diaktifkan.
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 sekumpulan kode kesalahan yang ditentukan server. |
details |
Error[] |
Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini. |
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 |
Info kesalahan. |
InnerError
Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Salah satu sekumpulan kode kesalahan yang ditentukan server. |
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 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. |