Schemas
Schemata definieren die Struktur der Daten, die Sie aus Dokumenten extrahieren möchten. Erstellen Sie wiederverwendbare Schemata, um eine einheitliche Extraktion über mehrere Dokumente hinweg sicherzustellen.
Schema-Objekt
Ein Schema definiert die Felder und ihre Typen für die Extraktion.
{
"id": "sch_abc123",
"name": "invoice",
"description": "Standard invoice extraction schema",
"fields": [
{
"name": "vendor_name",
"type": "string",
"description": "Name of the vendor or supplier"
},
{
"name": "invoice_number",
"type": "string",
"description": "Invoice reference number"
},
{
"name": "date",
"type": "date",
"description": "Invoice date"
},
{
"name": "total",
"type": "number",
"description": "Total amount due"
},
{
"name": "line_items",
"type": "array",
"description": "List of line items",
"items": "object",
"fields": [
{ "name": "description", "type": "string" },
{ "name": "quantity", "type": "number" },
{ "name": "unit_price", "type": "number" },
{ "name": "amount", "type": "number" }
]
}
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}Feldtypen
| Typ | Beschreibung | Beispiel |
|---|---|---|
| string | Textwert | "Acme Corp" |
| number | Numerischer Wert (Ganzzahl oder Gleitkommazahl) | 1500.00 |
| date | Datum im Format ISO 8601 | "2024-01-15" |
| boolean | Wahr oder falsch | true |
| array | Liste von Elementen (erfordert items-Definition) | ["item1", "item2"] |
| object | Verschachteltes Objekt (erfordert fields-Definition) | {"key": "value"} |
POST
/v1/schemas
Erstellen Sie ein neues Extraktionsschema.
Anfrage-Body
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | String | Ja | Eindeutiger Name für das Schema |
| description | String | Nein | Beschreibung dessen, was dieses Schema extrahiert |
| fields | Array | Ja | Array von Felddefinitionen |
Beispiel
curl -X POST https://api-parse.conversiontools.io/v1/schemas \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "invoice",
"description": "Standard invoice schema",
"fields": [
{ "name": "vendor_name", "type": "string", "description": "Vendor name" },
{ "name": "total", "type": "number", "description": "Total amount" },
{ "name": "date", "type": "date", "description": "Invoice date" }
]
}'Antwort
{
"success": true,
"schema": {
"id": "sch_abc123",
"name": "invoice",
"description": "Standard invoice schema",
"fields": [
{ "name": "vendor_name", "type": "string", "description": "Vendor name" },
{ "name": "total", "type": "number", "description": "Total amount" },
{ "name": "date", "type": "date", "description": "Invoice date" }
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}GET
/v1/schemas
Listen Sie alle Schemata Ihres Kontos auf.
Beispiel
curl https://api-parse.conversiontools.io/v1/schemas \
-H "Authorization: Bearer YOUR_API_KEY"Antwort
{
"success": true,
"schemas": [
{
"id": "sch_abc123",
"name": "invoice",
"description": "Standard invoice schema",
"fields": [...],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
}GET
/v1/schemas/:id
Rufen Sie ein einzelnes Schema anhand seiner ID ab.
Beispiel
curl https://api-parse.conversiontools.io/v1/schemas/sch_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"PUT
/v1/schemas/:id
Aktualisieren Sie ein vorhandenes Schema. Alle Felder werden ersetzt.
Beispiel
curl -X PUT https://api-parse.conversiontools.io/v1/schemas/sch_abc123 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "invoice_v2",
"description": "Updated invoice schema",
"fields": [
{ "name": "vendor_name", "type": "string", "description": "Vendor name" },
{ "name": "total", "type": "number", "description": "Total amount" },
{ "name": "date", "type": "date", "description": "Invoice date" },
{ "name": "currency", "type": "string", "description": "Currency code" }
]
}'DELETE
/v1/schemas/:id
Löschen Sie ein Schema. Diese Aktion kann nicht rückgängig gemacht werden.
Beispiel
curl -X DELETE https://api-parse.conversiontools.io/v1/schemas/sch_abc123 \
-H "Authorization: Bearer YOUR_API_KEY"Antwort
{
"success": true,
"message": "Schema deleted"
}