Uraikan Dokumen
Ekstrak → Uraikan Dokumen
Yang Uraikan Dokumen API mengekstrak data terstruktur dari sebuah PDF menggunakan templat yang Anda buat di PDF4me Dasbor. Anda mengirim docContent (opsional; jika dihilangkan, dokumen akan diambil oleh docName), docName, TemplateId (GUID) atau TemplateName, ParseId (GUID), dan opsional async. Itu API pengembalian JSON dengan data yang telah diurai (tipe dokumen, jumlah halaman, bidang yang diekstrak). Gunakan penguji di bawah ini untuk mencobanya; detail selengkapnya ada di bagian selanjutnya.
Coba Uraikan Dokumen API
:::catatan Referensi cepat
Titik akhir: POST /api/v2/ParseDocument · Diperlukan: api-key, docName, TemplateId (atau TemplateName), ParseId
:::
Gunakan formulir di bawah ini untuk mengirimkan API kunci, PDF (Base64 atau dirujuk oleh docName), ID atau nama templat, dan ID parse. Responsnya adalah JSON dengan data dokumen yang telah diurai. Tidak perlu kode, isi kolom dan klik. Kirim permintaan.
Gambaran umum, parameter, dan kasus penggunaan.
- Overview
- Parameters
- Use cases
Apa itu Parse Document?
Endpoint ini mengekstrak data terstruktur dari sebuah PDF menggunakan mengurai templat Anda membuat di dalam PDF4me Dasbor. Anda menyediakan PDF (docContent Opsional, jika dihilangkan dokumen akan diambil oleh docName), docName, TemplateId (GUID) atau TemplateName, Dan ParseId (GUID). Yang API pengembalian JSON dengan tipe dokumen, jumlah halaman, dan bidang yang diekstrak berdasarkan area dan kunci pengambilan data pada templat Anda.
Fitur utama
- Berbasis templatBuat templat di dasbor: unggah contoh PDF, menggambar area tangkapan, mengkonfigurasi kunci dan regex.
- TemplateId atau TemplateNameGunakan templatnya GUID atau nama dari dasbor.
- ParseId: Unik GUID per operasi parsing (dihasilkan di sisi klien atau digunakan) API-asalkan).
- Keluaran terstruktur: JSON dengan tipe dokumen, jumlah halaman, dan data terstruktur yang diekstrak.
Mendapatkan ID Template dan Parse
- Akses PDF4me Dasbor: Pergi ke mengurai dokumen halaman.
- Buat TemplatKlik "Tambah" dan masukkan nama templat, lalu simpan.
- Konfigurasi TemplatUnggah templat PDF, menggambar area tangkapan, mengkonfigurasi kunci dan ekspresi reguler, menguji penguraian, dan menyimpan.
- Dapatkan ID TemplatSalin yang unik GUID untuk templat Anda (atau gunakan TemplateName).
- Hasilkan ID ParseBuat sesuatu yang unik GUID untuk setiap operasi penguraian (sisi klien atau melalui sebuah alat).
Gunakan saat Anda memiliki jenis dokumen berulang (faktur, formulir) dan memerlukan ekstraksi terstruktur. Kombinasikan dengan Klasifikasikan Dokumen untuk mengarahkan berdasarkan tipe, lalu menguraikan dengan templat yang tepat.
API parameter
| Parameter | Jenis | Diperlukan | Keterangan |
|---|---|---|---|
| api-key | rangkaian | Ya | Milikmu PDF4me API kunci, Base64 dikodekan. Dapatkan dari dasbor. |
| docContent | base64 | TIDAK | PDF isi berkas (Base64). Jika dihilangkan, dokumen diambil oleh docName. |
| docName | rangkaian | Ya | PDF nama file dengan ekstensi .pdf. |
| TemplateId | rangkaian | Ya* | Unik GUID untuk templat parse (dari dasbor). *Gunakan TemplateId atau TemplateName. |
| TemplateName | rangkaian | TIDAK | Nama templat (alternatif untuk) TemplateId). |
| ParseId | rangkaian | Ya | Unik GUID untuk operasi penguraian ini. |
| async | boolean | TIDAK | Aktifkan pemrosesan asinkron. |
Kapan menggunakan Parse Document?
- Faktur dan formulirEkstrak bidang terstruktur (jumlah, tanggal, vendor) dari jenis dokumen berulang.
- Otomatisasi dokumenGunakan templat untuk mengambil data dari yang serupa. PDFs ke dalam CRM, ERPatau basis data.
- KepatuhanEkstrak bidang-bidang penting untuk keperluan penyimpanan atau audit dari dokumen standar.
Untuk skema permintaan/respons dan contoh kode, lihat Uraikan Dokumen di dalam PDF4me API dokumen.
Prasyarat
Sebelum menggunakan endpoint ini, pastikan Anda telah:
- Sebuah valid PDF4me API kunci (Dapatkan milikmu API Kunci)
- A PDF dokumen di Base64 format atau publik URL ke sebuah PDF berkas
- A Mengurai Templat dibuat di Anda PDF4me dasbor (Buat Templat Parse)
- Anda membutuhkan ID Templat (GUID) atau Nama Templat dari templat parse Anda
- A ID Parse (GUID) untuk operasi penguraian
Format Respons
Yang API mengembalikan JSON Respons yang berisi data dokumen yang telah diuraikan, termasuk jenis dokumen, jumlah halaman, dan informasi terstruktur yang diekstrak.