In diesem Dokument wird beschrieben, wie Sie die Dokumentschemas in Document AI Warehouse verwalten, einschließlich der Vorgänge zum Erstellen, Abrufen, Auflisten, Aktualisieren und Löschen.
Was sind Dokumentschemas?
Jedes Dokument hat einen bestimmten Dokumenttyp und wird durch ein Schema angegeben.
Ein Dokumentschema definiert die Struktur für einen Dokumenttyp (z. B. Rechnung oder Gehaltsabrechnung) in Document AI Warehouse. Dort können Administratoren Properties verschiedener Datentypen (Text | Numerisch | Datum | Aufzählung) angeben.
Properties werden verwendet, um die extrahierten Daten, Klassifizierungstags oder andere Geschäftstags darzustellen, die von KI oder menschlichen Nutzern an Dokumente angehängt werden, z. B. Invoice_Amount (numerisch), Due_Date (Datum) oder Supplier_Name (Text).
Property-Attribute : Jede Property kann als Folgendes deklariert werden:
Filterbar: Kann zum Filtern von Suchergebnissen verwendet werden
Durchsuchbar: Indexiert, damit sie in Suchanfragen gefunden werden kann
Erforderlich:
requiredwird verwendet, um sicherzustellen, dass die Property in dem Dokument vorhanden ist. Wir empfehlen, die meisten Properties alsrequired = falsezu speichern, es sei denn, die Property ist erforderlich.
Erweiterbares Schema:In einigen Fällen müssen Endnutzer mit Bearbeitungszugriff neue Schema-Properties zu Dokumenten hinzufügen oder daraus löschen. Dies wird durch eine „MAP-Property“ unterstützt, die eine Liste von Schlüssel/Wert-Paaren ist.
Jedes Schlüssel/Wert-Paar in einer MAP-Property kann einen Datentyp von (Text | Numerisch | Datum | Aufzählung) haben.
Eine Rechnung kann beispielsweise eine MAP-Property „Invoice_Entities“ mit den folgenden Schlüssel/Wert-Paaren enthalten:
Invoice_Amount (numerisch) 1000
Due_Date (Datum) 24.12.2021
Supplier_Name (Text) ABC Corp
Unveränderlichkeit des Schemas:Schemas oder Schema-Properties können hinzugefügt, aber derzeit nicht bearbeitet oder gelöscht werden. Definieren Sie das Schema daher sorgfältig.
Hinweis
Bevor Sie beginnen, müssen Sie die Schnellstart Seite abgeschlossen haben.
Schema erstellen
Erstellen Sie ein Dokumentschema.
REST
curl --location --request POST --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--data '{
"display_name": "Test Doc Schema",
"property_definitions": [
{
"name": "plaintiff",
"display_name": "Plaintiff",
"is_searchable": true,
"is_repeatable": true,
"text_type_options": {}
}
]
}'Python
Weitere Informationen finden Sie in der Document AI Warehouse Python API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Document AI Warehouse Java API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Weitere Informationen finden Sie in der Document AI Warehouse Node.js API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Schema abrufen
Rufen Sie Details zu einem Dokumentschema ab.
REST
curl --request GET --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Weitere Informationen finden Sie in der Document AI Warehouse Python API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Document AI Warehouse Java API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Weitere Informationen finden Sie in der Document AI Warehouse Node.js API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Schemas auflisten
Listen Sie Dokumentschemas auf.
REST
curl --request GET --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Weitere Informationen finden Sie in der Document AI Warehouse Python API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Document AI Warehouse Java API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Schema löschen
Löschen Sie ein Dokumentschema.
REST
curl --request DELETE --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Weitere Informationen finden Sie in der Document AI Warehouse Python API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Document AI Warehouse Java API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Weitere Informationen finden Sie in der Document AI Warehouse Node.js API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Schema aktualisieren
Aktualisieren Sie ein Dokumentschema. Derzeit unterstützt die Aktualisierungslogik nur das Hinzufügen neuer Property-Definitionen. Das neue Dokumentschema sollte alle Property-Definitionen enthalten, die im vorhandenen Schema vorhanden sind.
Unterstützt:
- Bei vorhandenen Properties können Nutzer die folgenden Metadateneinstellungen ändern:
is_repeatable,is_metadata,is_required. - Bei vorhandenen ENUM-Properties können Nutzer neue mögliche ENUM-Werte hinzufügen oder vorhandene mögliche ENUM-Werte löschen. Sie können das Flag
EnumTypeOptions.validation_check_disabledaktualisieren, um die Validierungsprüfung zu deaktivieren. Mit der Validierungsprüfung wird sichergestellt, dass die in den Dokumenten angegebenen ENUM-Werte im Bereich der möglichen ENUM-Werte liegen, die in der Property-Definition definiert sind, wenn dieCreateDocumentAPI aufgerufen wird. - Das Hinzufügen neuer Property-Definitionen wird unterstützt.
- Bei vorhandenen Properties können Nutzer die folgenden Metadateneinstellungen ändern:
Nicht unterstützt:
- Bei vorhandenen Schemas sind Aktualisierungen von
display_nameunddocument_is_foldernicht zulässig. - Bei vorhandenen Properties sind Aktualisierungen von
name,display_nameundvalue_type_optionsnicht zulässig.
- Bei vorhandenen Schemas sind Aktualisierungen von
REST
curl --request PATCH --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8" \
--data '{
"document_schema": {
"display_name": "Test Doc Schema",
"property_definitions": [
{
"name": "plaintiff",
"display_name": "Plaintiff",
"is_repeatable": true,
"text_type_options": {}
}
]
}
}'Python
Weitere Informationen finden Sie in der Document AI Warehouse Python API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Document AI Warehouse Java API Referenzdokumentation.
Richten Sie zur Authentifizierung bei Document AI Warehouse die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Nächste Schritte
- Unter Dokumente verwalten erfahren Sie, wie Sie Dokumente verwalten.