Kom igång med Knowledge Base Python-demon

Kör, granska och anpassa en fungerande Python-implementering av vanliga Knowledge Base API-arbetsflöden.

Python-demon ger en funktionell startpunkt för apputveckling.Använd det fullständiga arbetsflödet för att se hur skapande av samlingar, dokumentbearbetning och AI-slutledning fungerar tillsammans, och utforska sedan enskilda skript för specifika samlings- och slutledningsoperationer.

Innan du börjar

Se till att du har:

• Åtkomst till Knowledge Base API:et.
• Autentiseringsuppgifterna som krävs för att autentisera din applikation.
• Python 3.7 eller senare. Python 3.11 eller senare rekommenderas.
• En PDF som du kan använda för det fullständiga demoarbetsflödet.

Om du inte har konfigurerat API-åtkomst, se Konfigurera Knowledge Base API-åtkomst.

Hämta och konfigurera Python-demon

Demon använder requests, pyyaml och tqdm. Autentiseringsuppgifter lagras i config.yaml, och autentiseringstoken hanteras automatiskt.

Checka inte in config.yaml eller genererade .token-filer i källkontroll.

Kör hela arbetsflödet

Kör:

python knowledgebase.py

För att använda en specifik PDF:

python knowledgebase.py --document=<väg-till-pdf>

Demon:

1. Autentiserar med API:et.
2. Skapar en samling med namnet demo-collection.
3. Laddar upp en PDF.
4. Övervakar dokumentet tills indexering är klar.
5. Kör en inferensbegäran mot det bearbetade dokumentet.

Uppladdning och indexering är skilda delar av dokumentinmatning.Indexering extraherar dokumentinnehållet och gör det tillgängligt för AI-operationer.

Om du inte anger en PDF väljer demon en från paketets documents-katalog.Dokumentbearbetning får timeout efter fem minuter om den inte når ett slutfört tillstånd.

Utforska samlingsoperationer

Efter att ha kört hela arbetsflödet använder du enskilda skript för att utforska specifika API-operationer.

Skapa en samling

python collection.py --action create --name <collection-name>

Samlingsnamn kan innehålla upp till 255 tecken.

Lista samlingar

python collection.py --action list

Välj om du vill lista samlingar skapade av dig, delade av dig eller delade av andra när du tillfrågas.

Dela en samling

python collection.py --action share --collection-id <collection-id>

Ange e-postadresserna som ska få läs- eller skrivåtkomst när du uppmanas.

Ladda upp dokument

python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>

Skriptet kan ladda upp en enda fil eller dokument från en angiven katalog.

Lista dokument i en samling

python collection.py --action get_documents --collection-id <collection-id>

Kontrollera bearbetningsstatus för dokument

python collection.py --action get_status --document-id <document-id>

Demon tillhandahåller dessa operationer som fristående exempel som du kan inspektera och anpassa oberoende av det fullständiga arbetsflödet. 

Utforska inferensoperationer

Inferensexemplen kräver ett samlings-ID och ett dokument-ID.Använd samlingsskripten för att identifiera dem:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>

Frågor och svar

Lista dina samlingar och dokument, kör sedan Q&A-exemplet:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer

Ange samlings-ID, dokument-ID och fråga när du uppmanas.

Dokumentsammanfattning

Identifiera samlingen och dokumentet, kör sedan sammanfattningsexemplet:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize

Ange samlings-ID och dokument-ID när du uppmanas.

Kontextsökning

Identifiera samlingen och dokumentet, kör sedan kontextsökningsexemplet:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search

Ange samlings-ID, dokument-ID och söktext när du uppmanas.

Egenskapsextraktion

Identifiera samlingen och dokumentet, kör sedan extraheringsexemplet:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract

Ange samlings-ID, dokument-ID, egenskapsnamn, extraheringsprompt, datatyp och valfri beskrivning när du uppmanas. 

Fortsätt bygga med API:et

Python-demot tillhandahåller fungerande implementeringsmönster snarare än fullständig API-dokumentation.

Använd Kom igång med Knowledge Base API för att förstå API-resursmodellen, dokumentlivscykeln, slutledningsbeteende och svarshantering.

Använd Knowledge Base API-referensen när du behöver aktuella slutpunktsvägar, parametrar, begäran- och svarsscheman samt statusinformation.

Felsökning

Demon skriver detaljerad diagnostisk information till:

logs/knowledgebase-demo.log

Loggfilen registrerar DEBUG-nivåinformation, medan konsolen visar WARNING-nivåmeddelanden och uppåt.

Om en operation misslyckas:

• Granska logs/kinowledgebase-demo.log för information om begäran och autentisering.
• Kontrollera inställningarna i config.yaml.
• Bekräfta att PDF:en du använder finns och är tillgänglig.
• Bekräfta att programmet använder lämplig tjänstslutpunkt för din organisation. 
• Bekräfta att den autentiserade identiteten har åtkomst till den begärda resursen.
• För API-misslyckanden, behåll X-Request-ID som returneras i svarshuvudena när det är tillgängligt. Support kan använda denna identifierare för att spåra begäran. 

Implementeringsöverväganden

• Det kompletta arbetsflödet accepterar PDF-filer.
• Demon hanterar autentiseringstoken efter att API-åtkomst har konfigurerats.
• API-operationer använder de behörigheter som är tillgängliga för den autentiserade identiteten.
• Källpaketet inkluderar funktionalitet för regional slutpunktsupptäckt, men produktionsslutpunkter bör hämtas från den aktuella Knowledge Base API-dokumentationen snarare än de äldre värden som ingår i demon.