Kom i gang med Knowledge Base Python-demo

Kjør, inspiser og tilpass en fungerende Python-implementering av vanlige Knowledge Base-API-arbeidsflyter.

Python-demoen gir et funksjonelt utgangspunkt for apputvikling. Bruk hele arbeidsflyten til å se opprettelse av samling, dokumentbehandling og kunstig intelligens-slutning fungere sammen, deretter utforsk individuelle skript for spesifikke samlinger og slutningsoperasjoner.

Før du begynner

Sørg for at du har:

• Tilgang til Knowledge Base-API-et.
• Legitimasjonen som kreves for å autentisere appen din.
• Python 3.7 eller senere. Python 3.11 eller senere anbefales.
• En PDF som du kan bruke for den komplette demo-arbeidsflyten.

Hvis du ikke har konfigurert API-tilgang, se Konfigurer Knowledge Base-API-tilgang.

Last ned og konfigurer Python-demoen

Demoen bruker requests, pyyaml og tqdm. Legitimasjon lagres i config.yaml, og autentiseringstokene administreres automatisk.

Ikke commit config.yaml eller genererte .token-filer til kildekontroll.

Kjør hele arbeidsflyten

Kjør:

python knowledgebase.py

Slik bruker du en bestemt PDF:

python knowledgebase.py --document=<bane-til-pdf>

Demoen:

1. Autentiserer med API-et.
2. Oppretter en samling med navnet demo-collection.
3. Laster opp en PDF.
4. Overvåker dokumentet til indeksering er fullført.
5. Kjører en inferensforespørsel mot det behandlede dokumentet.

Opplasting og indeksering er separate deler av dokumentinnlesing.Indeksering trekker ut dokumentinnholdet og gjør det tilgjengelig for KI-operasjoner.

Hvis du ikke spesifiserer en PDF, velger demoen en fra pakkens documents katalog.Dokumentbehandling får tidsavbrudd etter fem minutter hvis den ikke når en fullført tilstand.

Utforsk samlingsoperasjoner

Etter å ha kjørt den fullstendige arbeidsflyten kan du bruke individuelle skript til å utforske spesifikke API-operasjoner.

Opprett en samling

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

Samlingsnavn kan inneholde opptil 255 tegn.

Vis samlinger

python collection.py --action list

Velg om du vil liste samlinger opprettet av deg, delt av deg eller delt av andre når du blir spurt.

Del en samling

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

Skriv inn e-postadressene som skal motta lese- eller skrivetilgang når du blir bedt om det.

Last opp dokumenter

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

Skriptet kan laste opp en enkelt fil eller dokumenter fra en angitt mappe.

Vis dokumenter i en samling

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

Kontroller dokumentbehandlingsstatus

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

Demoen gir disse operasjonene som frittstående eksempler som du kan undersøke og tilpasse uavhengig av hele arbeidsflyten. 

Utforsk inferensoperasjoner

Inferenseksemplene krever en samlings-ID og dokument-ID.Bruk samlingsskript for å identifisere dem:

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

Spørsmålsbesvarelse

Vis samlingene og dokumentene dine, og kjør deretter Q&A-eksemplet:

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

Skriv inn samlings-ID, dokument-ID og spørsmål når du blir bedt om det.

Dokumentsammendrag

Identifiser samlingen og dokumentet, og kjør deretter sammendragseksemplet:

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

Skriv inn samlings-ID og dokument-ID når du blir bedt om det.

Kontekstsøk

Identifiser samlingen og dokumentet, og kjør deretter eksempelet på kontekstsøk:

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

Skriv inn samlings-ID, dokument-ID og søketekst når du blir bedt om det.

Egenskapsutvinning

Identifiser samlingen og dokumentet, og kjør deretter utvinninseksemplet:

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

Skriv inn samlings-ID, dokument-ID, egenskapsnavn, utvinningstekst, datatype og valgfri beskrivelse når du blir bedt om det. 

Fortsett å bygge med API-en

Python-demoen gir fungerende implementeringsmønstre i stedet for fullstendig API-dokumentasjon.

Bruk Kom i gang med Knowledge Base API for å forstå API-ressursmodellen, dokumentets livssyklus, slutningsatferd og responsbehandling.

Bruk Knowledge Base API-referansen når du trenger gjeldende endepunktstier, parametere, forespørsels- og responsskjemaer, og statusinformasjon.

Feilsøking

Demoen skriver detaljert diagnostisk informasjon til:

logs/knowledgebase-demo.log

Loggfilen registrerer opplysninger på DEBUG-utjevning, mens konsollen viser meldinger på WARNING-utjevning og oppover.

Hvis en operasjon mislykkes:

• Gå gjennom logs/kinowledgebase-demo.log for forespørsels- og autentiseringsdetaljer.
• Kontroller innstillingene i config.yaml.
• Bekreft at PDF-en du bruker eksisterer og er tilgjengelig.
• Bekreft at applikasjonen bruker det riktige tjenesteendepunktet for organisasjonen din. 
• Bekreft at den autentiserte identiteten har tilgang til den ønskede ressursen.
• Ved API-feil beholder du X-Request-ID som returneres i responsoverskriftene når den er tilgjengelig. Kundestøtte kan bruke denne identifikatoren til å spore forespørselen. 

Implementeringsoverveielser

• Den fullstendige arbeidsflyten godtar PDF-filer.
• Demoen administrerer autentiseringstokener etter at API-tilgang er konfigurert.
• API-operasjoner bruker tillatelsene som er tilgjengelige for den autentiserte identiteten.
• Kildepakken inkluderer funksjonalitet for regional endepunktoppdagelse, men produksjonsendepunktverdier bør komme fra gjeldende Knowledge Base API-dokumentasjon i stedet for eldre verdier som følger med demoen.