Belgeyi Ayrıştır
Çıkarmak → Belgeyi Ayrıştır
O Belgeyi Ayrıştır API yapılandırılmış verileri bir kaynaktan çıkarır. PDF oluşturduğunuz bir şablonu kullanarak PDF4me Kontrol paneli. Siz gönderiyorsunuz. docContent (isteğe bağlı; atlanırsa belge şu şekilde alınır: docName), docName, TemplateId (GUID) veya TemplateName, ParseId (GUID), ve isteğe bağlı olarak async. O API iadeler JSON Ayrıştırılmış verilerle (belge türü, sayfa sayısı, çıkarılan alanlar). Denemek için aşağıdaki test aracını kullanın; daha fazla ayrıntı sonraki bölümlerde yer almaktadır.
Belgeyi ayrıştırmayı deneyin. API
:::not Hızlı referans
Uç nokta: POST /api/v2/ParseDocument · Gerekli: api-key, docName, TemplateId (veya TemplateName), ParseId
:::
:::bilgi Canlı olarak deneyin Aşağıdaki formu kullanarak gönderin API anahtar, PDF (Base64 veya tarafından referans gösterilen docName), şablon kimliği veya adı ve ayrıştırma kimliği. Yanıt şudur: JSON Ayrıştırılmış belge verileriyle. Kod gerekmez, alanları doldurun ve tıklayın. İstek gönder.
:::
Genel Bakış, Parametreler ve Kullanım Örnekleri
- Overview
- Parameters
- Use cases
Parse Document nedir?
Bu uç nokta, yapılandırılmış verileri bir kaynaktan çıkarır. PDF kullanarak şablonu ayrıştır siz oluşturuyorsunuz PDF4me Kontrol paneli. Siz sağlıyorsunuz. PDF (docContent İsteğe bağlı, belirtilmezse belge şu şekilde alınır: docName), docName, TemplateId (GUID) veya TemplateName, Ve ParseId (GUID). API iadeler JSON Şablonunuzun yakalama alanlarına ve anahtarlarına bağlı olarak belge türü, sayfa sayısı ve çıkarılan alanlarla birlikte.
Başlıca özellikler
- Şablon tabanlıKontrol panelinde bir şablon oluşturun: örnek yükleyin PDFYakalama alanlarını çizin, anahtarları ve düzenli ifadeleri yapılandırın.
- TemplateId veya TemplateNameŞablonun özelliklerini kullanın. GUID veya gösterge panelinden adınızı seçin.
- ParseId: Eşsiz GUID ayrıştırma işlemi başına (istemci tarafında oluşturun veya kullanın) API-tedarik edilen).
- Yapılandırılmış çıktı: JSON Belge türü, sayfa sayısı ve çıkarılan yapılandırılmış verilerle birlikte.
Şablon ve Ayrıştırma Kimliklerini Alma
- Erişim PDF4me Kontrol Paneli: Şuraya gidin belgeyi ayrıştırmak sayfa.
- Şablon Oluştur"Ekle"ye tıklayın, bir şablon adı girin ve kaydedin.
- Şablonu YapılandırŞablon yükle PDFYakalama alanlarını çizin, anahtarları ve düzenli ifadeleri yapılandırın, ayrıştırmayı test edin ve kaydedin.
- Şablon Kimliğini AlBenzersiz olanı kopyala GUID şablonunuz için (veya kullanın) TemplateName).
- Ayrıştırma Kimliği Oluştur: Eşsiz bir şey yaratın GUID Her ayrıştırma işlemi için (istemci tarafında veya bir araç aracılığıyla).
:::ipucu En iyi kullanım alanı: Tekrarlayan belge türleriniz (faturalar, formlar) olduğunda ve yapılandırılmış veri çıkarma işlemine ihtiyaç duyduğunuzda kullanın. Şunlarla birlikte kullanın: Sınıflandırılmış Belge Türüne göre yönlendirme yapın, ardından doğru şablonla ayrıştırın.
:::
API parametreler
| Parametre | Tip | Gerekli | Tanım |
|---|---|---|---|
| api-key | sicim | Evet | Senin PDF4me API anahtar, Base64 Kodlanmış. Şuradan alın: gösterge paneli. |
| docContent | base64 | HAYIR | PDF dosya içeriği (Base64). Belirtilmezse, belge şu şekilde alınır: docName. |
| docName | sicim | Evet | PDF .pdf uzantılı dosya adı. |
| TemplateId | sicim | Evet* | Eşsiz GUID (Kontrol panelinden) ayrıştırma şablonu için. *Kullanıma bakın TemplateId veya TemplateName. |
| TemplateName | sicim | HAYIR | Şablon adı (alternatif olarak) TemplateId). |
| ParseId | sicim | Evet | Eşsiz GUID Bu ayrıştırma işlemi için. |
| async | mantıksal | HAYIR | Asenkron işlemeyi etkinleştirin. |
Parse Document ne zaman kullanılır?
- Faturalar ve formlar: Yinelenen belge türlerinden yapılandırılmış alanları (miktar, tarih, tedarikçi) çıkarın.
- Belge otomasyonuBenzer kaynaklardan veri çekmek için şablonları kullanın. PDFs içine CRM, ERPveya veritabanları.
- UyumlulukStandartlaştırılmış belgelerden saklama veya denetim için önemli alanları ayıklayın.
:::bilgi Tamamına ihtiyaç var API?
İstek/yanıt şemaları ve kod örnekleri için bakınız: Belgeyi Ayrıştır içinde PDF4me API belgeler.
:::
Önkoşullar
Bu uç noktayı kullanmadan önce şunlara sahip olduğunuzdan emin olun:
- Geçerli bir PDF4me API anahtar (Alın API Anahtar)
- A PDF belgede Base64 format veya halka açık URL bir PDF dosya
- A Şablonu Ayrıştır sizin tarafınızdan oluşturuldu PDF4me gösterge paneli (Ayrıştırma Şablonu Oluştur)
- İhtiyacınız var Şablon Kimliği (GUID) veya Şablon Adı ayrıştırma şablonunuzdan
- A Ayrıştırma Kimliği (GUID(ayrıştırma işlemi için)
Yanıt Formatı
O API bir döndürür JSON Yanıt, belge türü, sayfa sayısı ve çıkarılan yapılandırılmış bilgiler de dahil olmak üzere ayrıştırılmış belge verilerini içerir.