Download en pak het Python-demopakket uit.
Het pakket bevat de scripts en configuratie die worden gebruikt om verzamelingsbeheer, documentverwerking, inferentie en gerelateerde API-bewerkingen te demonstreren.
Laatst bijgewerkt op
29 sep. 2026
Voer een werkende Python-implementatie van gangbare Knowledge Base-API-workflows uit, inspecteer en pas deze aan.
De Python-demo biedt een functioneel startpunt voor applicatieontwikkeling.Gebruik de complete workflow om te zien hoe het aanmaken van verzamelingen, documentverwerking en AI-inferentie samenwerken, en verken vervolgens individuele scripts voor specifieke verzamelings- en inferentiebewerkingen.
Voordat u begint
Zorg ervoor dat je het volgende hebt:
- Toegang tot de Knowledge Base-API.
- De aanmeldingsgegevens die vereist zijn om je applicatie te authenticeren.
- Python 3.7 of hoger.Python 3.11 of hoger wordt aanbevolen.
- Een PDF die je kunt gebruiken voor de complete demoworkflow.
Als je nog geen API-toegang hebt geconfigureerd, zie Stel Knowledge Base-API-toegang in.
Download en stel de Python-demo in
Maak een virtuele omgeving aan:
python3 -m venv venv
Activeer de omgeving:
- Op macOS of Linux:
source venv/bin/activate - Op Windows:
venv\Scripts\activate
Installeer de afhankelijkheden:
pip install --upgrade pip
pip install -e .
Voeg de vereiste API-aanmeldingsgegevens en serviceconfiguratie toe aan config.yaml.
Ga naar de python-submap voordat je de voorbeeldscripts uitvoert.
De demo gebruikt requests, pyyaml en tqdm.Aanmeldingsgegevens worden opgeslagen in config.yaml en authenticatietokens worden automatisch beheerd.
Commit config.yaml of gegenereerde .token-bestanden niet naar broncodebeheer.
Voer de volledige workflow uit
Uitvoeren:
python knowledgebase.py
Om een specifieke PDF te gebruiken:
python knowledgebase.py --document=<pad-naar-pdf>
De demo:
- Authenticeert met de API.
- Maakt een verzameling aan met de naam demo-collection.
- Uploadt een PDF.
- Controleert het document totdat indexering is voltooid.
- Voert een gevolgtrekkingsverzoek uit tegen het verwerkte document.
Uploaden en indexering zijn verschillende onderdelen van documentopname.Indexering extraheert de documentinhoud en maakt deze beschikbaar voor AI-bewerkingen.
Als je geen PDF opgeeft, selecteert de demo er een uit de documents-map van het pakket.Documentverwerking loopt na vijf minuten af als er geen voltooide status wordt bereikt.
Notitie
De volledige workflow maakt een verzameling aan met de naam demo-collection en uploadt er een PDF naar.De demo verwijdert de verzameling of het geüploade document niet wanneer de workflow is voltooid.
Verzamelingsbewerkingen verkennen
Gebruik na het uitvoeren van de volledige workflow losse scripts om specifieke API-bewerkingen te verkennen.
Een verzameling maken
python collection.py --action create --name <collection-name>
Verzamelingsnamen kunnen tot 255 tekens bevatten.
Verzamelingen weergeven
python collection.py --action list
Kies of je verzamelingen wilt weergeven die door jou zijn gemaakt, door jou zijn gedeeld of door anderen zijn gedeeld wanneer daarom wordt gevraagd.
Een verzameling delen
python collection.py --action share --collection-id <collection-id>
Voer de e-mailadressen in die lees- of schrijftoegang moeten krijgen wanneer hierom wordt gevraagd.
Documenten uploaden
python collection.py --action upload --collection-id <collection-id> --path=<pad-naar-bestand-of-map>
Het script kan een enkel bestand of documenten uit een opgegeven map uploaden.
Documenten in een collectie weergeven
python collection.py --action get_documents --collection-id <collection-id>
Document-verwerkingsstatus controleren
python collection.py --action get_status --document-id <document-id>
De demo biedt deze bewerkingen als zelfstandige voorbeelden die je kunt inspecteren en onafhankelijk van de volledige workflow kunt aanpassen.
Inferentiebewerkingen verkennen
De inferentievoorbeelden vereisen een collectie-ID en document-ID.Gebruik de verzamelingsscripts om deze te identificeren:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Vragen beantwoorden
Geef je collecties en documenten weer en voer vervolgens het Q&A-voorbeeld uit:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Voer de collectie-ID, document-ID en vraag in wanneer hierom wordt gevraagd.
Documentsamenvatting
Identificeer de verzameling en het document en voer vervolgens het samenvattingsvoorbeeld uit:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Voer de collectie-ID en document-ID in wanneer hierom wordt gevraagd.
Contextzoekopdracht
Identificeer de verzameling en het document en voer vervolgens het voorbeeld voor contextzoeken uit:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Voer de verzameling-ID, document-ID en zoektekst in wanneer daarom wordt gevraagd.
Eigenschap-extractie
Identificeer de verzameling en het document en voer vervolgens het extractievoorbeeld uit:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Voer de verzameling-ID, document-ID, eigenschapnaam, extractieprompt, gegevenstype en optionele beschrijving in wanneer daarom wordt gevraagd.
Blijf bouwen met de API
De Python-demo biedt werkende implementatiepatronen in plaats van volledige API-documentatie.
Gebruik Aan de slag met de Knowledge Base API om het API-resourcemodel, de documentlevenscyclus, het inferentiegedrag en de reactieafhandeling te begrijpen.
Gebruik de Knowledge Base API-referentie wanneer je actuele eindpuntpaden, parameters, aanvraag- en reactieschema's en statusinformatie nodig hebt.
Problemen oplossen
De demo schrijft gedetailleerde diagnostische informatie naar:
logs/knowledgebase-demo.log
Het logbestand legt DEBUG-niveauinformatie vast, terwijl de console berichten op WARNING-niveau en hoger weergeeft.
Als een bewerking mislukt:
- Controleer logs/kinowledgebase-demo.log voor aanvraag- en authenticatiedetails.
- Verifieer de Instellingen in config.yaml.
- Bevestig dat de PDF die je gebruikt bestaat en toegankelijk is.
- Bevestig dat de applicatie het juiste service-eindpunt voor je organisatie gebruikt.
- Bevestig dat de geauthenticeerde identiteit toegang heeft tot de gevraagde bron.
- Voor API-fouten, behoud de X-Request-ID die wordt geretourneerd in de responskopteksten wanneer beschikbaar.Ondersteuning kan deze identificatie gebruiken om de aanvraag te traceren.
Implementatieoverwegingen
- De volledige workflow accepteert PDF-bestanden.
- De demo beheert authenticatietokens nadat API-toegang is geconfigureerd.
- API-bewerkingen gebruiken de toestemmingen die beschikbaar zijn voor de geauthenticeerde identiteit.
- Het bronpakket bevat regionale eindpunt-detectiefunctionaliteit, maar productie-eindpuntwaarden moeten komen uit de huidige Knowledge Base API-documentatie in plaats van verouderde waarden die bij de demo zijn meegeleverd.
