Lade das Python-Demo-Paket herunter und entpacke es.
Das Paket enthält die Skripte und Konfiguration, die zur Demonstration von Sammlungsverwaltung, Dokumentverarbeitung, Inferenz und verwandten API-Vorgängen verwendet werden.
Zuletzt aktualisiert am
21. Oktober 2026
Führe eine funktionierende Python-Implementierung gängiger Knowledgebase-API-Workflows aus, prüfe und passe sie an.
Die Python-Demo bietet einen funktionalen Startpunkt für die Anwendungsentwicklung. Verwende den vollständigen Workflow, um zu sehen, wie Sammlungserstellung, Dokumentenverarbeitung und KI-Inferenz zusammenarbeiten, und erkunde dann individuelle Skripte für spezifische Operationen an Sammlungen und zur Inferenz.
Vorbereitungsmaßnahmen
Stelle sicher, dass du Folgendes hast:
- Zugriff auf die Knowledgebase-API.
- Die Anmeldedaten, die zur Authentifizierung deiner Anwendung erforderlich sind.
- Python 3.7 oder später. Python 3.11 oder später wird empfohlen.
- Ein PDF, das du für den vollständigen Demo-Workflow verwenden kannst.
Falls du noch keinen API-Zugriff konfiguriert hast, siehe Richte Knowledgebase-API-Zugriff ein.
Lade die Python-Demo herunter und richte sie ein
Erstelle eine virtuelle Umgebung:
python3 -m venv venv
Aktiviere die Umgebung:
- Auf macOS oder Linux:
source venv/bin/activate - Auf Windows:
venv\Scripts\activate
Installiere die Abhängigkeiten:
pip install --upgrade pip
pip install -e .
Füge die erforderlichen API-Anmeldedaten und Servicekonfiguration zu config.yaml hinzu.
Wechsele in den python-Unterordner, bevor du die Beispielskripte ausführst.
Die Demo verwendet requests, pyyaml und tqdm. Anmeldedaten werden in config.yaml gespeichert, und Authentifizierungs-Token werden automatisch verwaltet.
Committe config.yaml oder generierte .token-Dateien nicht in die Quellcodeverwaltung.
Vollständigen Workflow ausführen
Führe Folgendes aus:
python knowledgebase.py
Um ein bestimmtes PDF zu verwenden:
python knowledgebase.py --document=<Pfad-zur-PDF>
Die Demo:
- Authentifiziert mit der API.
- Erstellt eine Sammlung namens demo-collection.
- Lädt ein PDF hoch.
- Überwacht das Dokument, bis die Indizierung abgeschlossen ist.
- Führt eine Inferenzanfrage über das verarbeitete Dokument aus.
Hochladen und Indizierung sind unterschiedliche Teile der Dokumentenaufnahme. Die Indizierung extrahiert den Dokumenteninhalt und stellt ihn für KI-Operationen zur Verfügung.
Wenn du kein PDF angibst, wählt die Demo eines aus dem documents-Verzeichnis des Pakets aus. Die Dokumentenverarbeitung bricht nach fünf Minuten ab, wenn kein vollständiger Status erreicht wird.
Anmerkung
Der vollständige Workflow erstellt eine Sammlung namens demo-collection und lädt ein PDF dorthin hoch. Die Demo löscht die Sammlung oder das hochgeladene Dokument nicht, wenn der Workflow abgeschlossen ist.
Sammlungsoperationen erkunden
Nach dem Ausführen des vollständigen Workflows verwendest du einzelne Skripts, um spezifische API-Operationen zu erkunden.
Sammlung erstellen
python collection.py --action create --name <sammlungs-name>
Sammlungsnamen können bis zu 255 Zeichen enthalten.
Sammlungen auflisten
python collection.py --action list
Wähle auf Nachfrage aus, ob du von dir erstellte, von dir freigegebene oder von anderen freigegebene Sammlungen auflisten möchtest.
Sammlung freigeben
python collection.py --action share --collection-id <sammlungs-id>
Gib auf Nachfrage die E-Mail-Adressen ein, die Lese- oder Schreibzugriff erhalten sollen.
Dokumente hochladen
python collection.py --action upload --collection-id <sammlungs-id> --path=<Pfad-zu-datei-oder-verzeichnis>
Das Skript kann eine einzelne Datei oder Dokumente aus einem bestimmten Verzeichnis hochladen.
Dokumente in einer Sammlung auflisten
python collection.py --action get_documents --collection-id <collection-id>
Status der Dokumentenverarbeitung prüfen
python collection.py --action get_status --document-id <document-id>
Die Demo bietet diese Vorgänge als eigenständige Beispiele, die du unabhängig vom kompletten Workflow überprüfen und anpassen kannst.
Inference-Vorgänge erkunden
Die Inference-Beispiele benötigen eine Sammlungs-ID und eine Dokument-ID. Verwende die Sammlungsskripte, um sie zu identifizieren:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Fragen beantworten
Liste deine Sammlungen und Dokumente auf und führe dann das Q&A-Beispiel aus:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Gib die Sammlungs-ID, Dokument-ID und Frage ein, wenn du dazu aufgefordert wirst.
Dokumentenzusammenfassung
Identifiziere die Sammlung und das Dokument und führe dann das Zusammenfassungsbeispiel aus:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Gib die Sammlungs-ID und Dokument-ID ein, wenn du dazu aufgefordert wirst.
Kontext-Suche
Identifiziere die Sammlung und das Dokument und führe dann das Beispiel zur Kontextsuche aus:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Gib die Sammlungs-ID, Dokument-ID und den Suchtext ein, wenn du dazu aufgefordert wirst.
Eigenschaftsextraktion
Identifiziere die Sammlung und das Dokument und führe dann das Extraktionsbeispiel aus:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Gib die Sammlungs-ID, Dokument-ID, Eigenschaftsname, Extraktions-Prompt, Datentyp und eine optionale Beschreibung ein, wenn du dazu aufgefordert wirst.
Weitere Entwicklung mit der API
Die Python-Demo bietet funktionierende Implementierungsmuster statt einer vollständigen API-Dokumentation.
Verwende Erste Schritte mit der Knowledgebase API, um das API-Ressourcenmodell, den Dokumentenlebenszyklus, das Inferenzverhalten und die Antwortbehandlung zu verstehen.
Verwende die Knowledgebase API-Referenz, wenn du aktuelle Endpunkt-Pfade, Parameter, Anfrage- und Antwort-Schemata sowie Statusinformationen benötigst.
Fehlerbehebung
Die Demo schreibt ausführliche Diagnoseinformationen in:
logs/knowledgebase-demo.log
Die Protokolldatei zeichnet DEBUG-Informationen auf, während die Konsole WARNING-Meldungen und höher anzeigt.
Wenn ein Vorgang fehlschlägt:
- Details zu Anfragen und Authentifizierung findest du unter logs/knowledgebase-demo.log.
- Überprüfe die Einstellungen in config.yaml.
- Bestätige, dass die verwendete PDF existiert und zugänglich ist.
- Bestätige, dass die Anwendung den geeigneten Service-Endpunkt für deine Organisation verwendet.
- Bestätige, dass die authentifizierte Identität Zugriff auf die angeforderte Ressource hat.
- Bei API-Fehlern behalte die X-Request-ID, die in den Antwort-Headern zurückgegeben wird, wenn verfügbar. Der Support kann diese Kennung verwenden, um die Anfrage zu verfolgen.
Hinweise zur Implementierung
- Der vollständige Workflow akzeptiert PDF-Dateien.
- Die Demo verwaltet Authentifizierungs-Token, nachdem der API-Zugriff konfiguriert ist.
- API-Operationen verwenden die Berechtigungen, die der authentifizierten Identität zur Verfügung stehen.
- Das Quellpaket enthält eine Funktion zur regionalen Endpunkt-Erkennung, aber Produktions-Endpunktwerte sollten aus der aktuellen API-Dokumentation der Knowledgebase stammen und nicht aus veralteten Werten, die in der Demo enthalten sind.
