Download og udpak Python-demopakken.
Pakken indeholder scripts og konfiguration, der bruges til at demonstrere samlingsadministration, dokumentbehandling, inferens og relaterede API-operationer.
Sidst opdateret den
29. sep. 2026
Kør, inspicér og tilpas en fungerende Python-implementering af almindelige Knowledge Base API-arbejdsforløb.
Python-demoen giver et funktionelt udgangspunkt for appudvikling. Brug det komplette arbejdsforløb til at se samlingsoprettelse, dokumentbehandling og AI-inferens fungere sammen, og udforsk derefter individuelle Scripts for specifikke samlings- og inferensoperationer.
Inden du går i gang
Sørg for, at du har:
- Adgang til Knowledge Base API'en.
- De nødvendige legitimationsoplysninger til at godkende din app.
- Python 3.7 eller nyere. Python 3.11 eller nyere anbefales.
- En PDF, som du kan bruge til det komplette demoarbejdsforløb.
Hvis du ikke har konfigureret API-adgang, se Konfigurér Knowledge Base API-adgang.
download og konfigurér Python-demoen
Opret et virtuelt miljø:
python3 -m venv venv
Aktivér miljøet:
- På macOS eller Linux:
source venv/bin/activate - På Windows:
venv\Scripts\activate
Installér afhængighederne:
pip install --upgrade pip
pip install -e .
Tilføj de nødvendige API-legitimationsoplysninger og tjenestekonfiguration til config.yaml.
Skift til python undermappen, før du kører eksempelscriptsene.
Demoen bruger requests, pyyaml og tqdm. Legitimationsoplysninger gemmes i config.yaml, og godkendelsestokens administreres automatisk.
Commit ikke config.yaml eller genererede .token filer til kildekontrol.
Kør hele arbejdsforløbet
Kør:
python knowledgebase.py
For at bruge en bestemt PDF:
python knowledgebase.py --document=<sti-til-pdf>
Demoen:
- Godkender sin identitet over for API'et.
- Opretter en samling med navnet demo-collection.
- Uploader en PDF.
- Overvåger dokumentet, indtil indeksering er færdig.
- Kører en inferensanmodning mod det behandlede dokument.
Upload og indeksering er adskilte dele af dokumentindlæsning.Indeksering udtrækker dokumentindholdet og gør det tilgængeligt for AI-operationer.
Hvis du ikke angiver en PDF, vælger demoen en fra pakkens documents mappe. Dokumentbehandling får timeout efter fem minutter, hvis den ikke når en færdig tilstand.
Note
Det fulde arbejdsforløb opretter en samling med navnet demo-collection og uploader en PDF til den. Demoen sletter ikke samlingen eller det uploadede dokument, når arbejdsforløbet er færdigt.
Udforsk samlingshandlinger
Efter at have kørt det fulde arbejdsforløb skal du bruge individuelle scripts til at udforske specifikke API-operationer.
Opret en samling
python collection.py --action create --name <collection-name>
Samlingsnavne kan indeholde op til 255 tegn.
Vis samlinger
python collection.py --action list
Vælg om du vil vise samlinger oprettet af dig, delt af dig eller delt af andre, når du bliver bedt om det.
Del en samling
python collection.py --action share --collection-id <collection-id>
Indtast de e-mailadresser, der skal have læse- eller skriveadgang, når du bliver bedt om det.
Upload dokumenter
python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>
Scriptet kan uploade en enkelt fil eller dokumenter fra en angivet mappe.
Vis dokumenter i en samling
python collection.py --action get_documents --collection-id <collection-id>
Tjek status for dokumentbehandling
python collection.py --action get_status --document-id <document-id>
Demoen indeholder disse operationer som selvstændige eksempler, som du kan undersøge og tilpasse uafhængigt af det komplette arbejdsforløb.
Udforsk inferenshandlinger
Slutningseksemplerne kræver et samlings-id og dokument-id.Brug samlingsskriptene til at identificere dem:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Besvarelse af spørgsmål
Vis dine samlinger og dokumenter, og kør derefter Q&A-eksemplet:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Indtast samlings-id, dokument-id og spørgsmål, når du bliver bedt om det.
Dokumentopsummering
Identificer samlingen og dokumentet, og kør derefter opsummeringseksemplet:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Indtast samlings-id og dokument-id, når du bliver bedt om det.
Kontekstsøgning
Identificer samlingen og dokumentet, og kør derefter kontekstsøgningseksemplet:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Indtast samlings-id'et, dokument-id'et og søgeteksten, når du bliver bedt om det.
Egenskabsudtrækning
Identificer samlingen og dokumentet, og kør derefter udtrækningseksemplet:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Indtast samlings-id'et, dokument-id'et, egenskabsnavnet, udtræknings-prompten, datatypen og den valgfrie beskrivelse når du bliver promptet.
Fortsæt med at bygge med API'en
Python Demo'en leverer fungerende implementeringsmønstre i stedet for komplet API-dokumentation.
Brug Kom godt i gang med Knowledge Base API'en for at forstå API-ressourcemodellen, dokumentets livscyklus, inferens-adfærd og respons-håndtering.
Brug Knowledge Base API-referencen når du har brug for aktuelle endpoint-stier, parametre, request- og response-skemaer og statusinformation.
Fejlfinding
Demo'en skriver detaljerede diagnostiske oplysninger til:
logs/knowledgebase-demo.log
Logfilen registrerer oplysninger på DEBUG-niveau, mens konsollen viser beskeder på ADVARSEL-niveau og derover.
Hvis en operation fejler:
- Gennemgå logs/kinowledgebase-demo.log for request- og godkendelsesoplysninger.
- Kontrollér indstillingerne i config.yaml.
- Bekræft at den PDF, du bruger, eksisterer og er tilgængelig.
- Bekræft, at appen bruger det passende tjenesteendepunkt for din organisation.
- Bekræft at den godkendte identitet har adgang til den ønskede ressource.
- Ved API-fejl skal du beholde det X-Request-ID, der returneres i svarheaderne, når det er tilgængeligt.Supporten kan bruge denne identifikator til at spore forespørgslen.
Implementeringsovervejelser
- Det komplette arbejdsforløb accepterer PDF-filer.
- Demo'en håndterer godkendelsestokens efter API-adgangen er konfigureret.
- API-operationer bruger de tilladelser, der er tilgængelige for den godkendte identitet.
- Kildepakken inkluderer regional endpoint-opdagelse funktionalitet, men produktions-endpoint Værdier bør komme fra den aktuelle Knowledge Base API-dokumentation i stedet for ældre Værdier, der er inkluderet med demo'en.
