Lataa ja pura Python-esittelypaketti.
Paketti sisältää komentosarjat ja määritykset, joita käytetään kokoelman hallinnan, asiakirjojen käsittelyn, päättelyn ja niihin liittyvien API-toimintojen esittelyyn.
Päivitetty viimeksi
6. lokakuuta 2026
Suorita, tarkasta ja mukauta toimivaa Python-toteutusta yleisille Knowledge Base -sovellusliittymän työnkuluille.
Python-esittely tarjoaa toimivan lähtökohdan sovelluskehitykselle. Käytä täydellistä työnkulkua nähdäksesi kokoelman luonnin, asiakirjojen käsittelyn ja tekoälyn päättelyn toimivan yhdessä. Tutustu sitten yksittäisiin komentosarjoihin tiettyjen kokoelma- ja päättelytoimintojen suorittamiseksi.
Ennen aloittamista
Varmista, että sinulla on seuraavat:
- Pääsy Knowledge Base -sovellusliittymään.
- Tunnistetiedot, joita tarvitaan sovelluksesi todentamiseen.
- Python 3.7 tai uudempi. Python 3.11 tai uudempi on suositeltava.
- PDF, jota voit käyttää esittelyn täydellisessä työnkulussa.
Jos et ole määrittänyt sovellusliittymän käyttöoikeutta, katso Knowledge Base -sovellusliittymän käyttöoikeuden määrittäminen.
Lataa ja asenna Python-esittely
Luo virtuaaliympäristö:
python3 -m venv venv
Aktivoi ympäristö:
- macOS:ssä tai Linuxissa:
source venv/bin/activate - Windowsissa:
venv\Scripts\activate
Asenna riippuvuudet:
pip install --upgrade pip
pip install -e .
Lisää tarvittavat sovellusliittymän tunnistetiedot ja palvelun määritykset tiedostoon config.yaml.
Siirry python-alikansioon ennen näytekomentosarjojen suorittamista.
Esittely käyttää requests-, pyyaml- ja tqdm-kirjastoja. Tunnistetiedot tallennetaan tiedostoon config.yaml, ja todennustunnuksia hallitaan automaattisesti.
Älä tallenna config.yaml- tai generoituja .token-tiedostoja lähdekoodinhallintaan.
Suorita koko työnkulku
Suorita:
python knowledgebase.py
Käytä tiettyä PDF:ää:
python knowledgebase.py --document=<path-to-pdf>
Esittely:
- Todentaa API:n kautta.
- Luo kokoelman nimeltä demo-collection.
- Lataa PDF:n palvelimeen.
- Seuraa asiakirjaa, kunnes indeksointi on valmis.
- Suorittaa päättelypyynnön käsitellyn asiakirjan perusteella.
Lataus ja indeksointi ovat erillisiä osia asiakirjan käsittelyssä. Indeksointi poimii asiakirjan sisällön ja tuo sen tekoälytoimintojen saataville.
Jos et määritä PDF:ää, demo valitsee yhden PDF:n paketin documents-hakemistosta. Asiakirjan käsittely aikakatkaistaan viiden minuutin kuluttua, jos se ei saavuta valmista tilaa.
Muistiinpano
Täydellinen työnkulku luo kokoelman nimeltä demo-collection ja lataa siihen PDF:n. Esittely ei poista kokoelmaa tai ladattua asiakirjaa työnkulun päättyessä.
Tutki kokoelman toimintoja
Koko työnkulun suorittamisen jälkeen käytä yksittäisiä komentosarjoja ja tutustu erillisiin API-toimintoihin.
Luo kokoelma
python collection.py --action create --name <collection-name>
Kokoelmien nimet voivat sisältää enintään 255 merkkiä.
Listaa kokoelmat
python collection.py --action list
Valitse kehotteessa, haluatko listata itse luomasi, itse jakamasi vai muiden jakamat kokoelmat.
Jaa kokoelma
python collection.py --action share --collection-id <collection-id>
Kirjoita kehotteessa sähköpostiosoitteet, joiden tulisi saada luku- tai kirjoitusoikeus.
Dokumenttien lataus
python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>
Skripti voi ladata yhden tiedoston tai asiakirjat määritetystä hakemistosta.
Luettele kokoelman asiakirjat
python collection.py --action get_documents --collection-id <collection-id>
Tarkista asiakirjan käsittelyn tila
python collection.py --action get_status --document-id <document-id>
Esittely tarjoaa nämä toiminnot itsenäisinä esimerkkeinä, joita voit tarkastella ja mukauttaa erillään kokonaisvaltaisesta työnkulusta.
Tutki päättelytoimintoja
Päättelyesimerkit vaativat kokoelman tunnisteen ja asiakirjan tunnisteen. Käytä kokoelman skriptejä niiden tunnistamiseen:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Kysymyksiin vastaaminen
Luettele kokoelmasi ja asiakirjasi, sitten suorita kysymys-vastaus-esimerkki:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Anna pyydettäessä kokoelman tunniste, asiakirjan tunniste ja kysymys.
Asiakirjojen yhteenvedot
Tunnista kokoelma ja asiakirja, sitten suorita yhteenvetoesimerkki:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Anna kokoelman tunniste ja asiakirjan tunniste pyydettäessä.
Kontekstihaku
Tunnista kokoelma ja asiakirja, sitten suorita kontekstihakuesimerkki:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Anna kokoelman tunniste, asiakirjan tunniste ja hakuteksti pyydettäessä.
Ominaisuuksien poiminta
Tunnista kokoelma ja asiakirja, sitten suorita poimimisesimerkki:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Anna pyydettäessä kokoelman tunniste, asiakirjan tunniste, ominaisuuden nimi, poimintakehote, tietotyyppi ja valinnainen kuvaus.
Jatka kehittämistä API:n avulla
Python-esittely tarjoaa toimivia toteutusmalleja täydellisen API-dokumentaation sijaan.
Katso Aloita Knowledge Base API:n käyttö ymmärtääksesi API-resurssimallia, asiakirjan elinkaarta, päättelykäyttäytymistä ja vastauksen käsittelyä.
Käytä Knowledge Base API -viitettä, kun tarvitset nykyisiä päätepisteiden polkuja, parametreja, pyynnön ja vastauksen skeemoja sekä tilatietoja.
Vianetsintä
Esittely kirjoittaa yksityiskohtaiset diagnostiikkatiedot kohteeseen:
logs/knowledgebase-demo.log
Lokitiedosto tallentaa DEBUG-tasoista tietoa, kun taas konsoli näyttää WARNING-tasoisia ja sitä korkeamman prioriteetin viestejä.
Jos toiminto epäonnistuu:
- Tarkista logs/kinowledgebase-demo.log-tiedostosta pyynnön ja tunnistautumisen tiedot.
- Varmista asetukset config.yaml-tiedostossa.
- Varmista, että käyttämäsi PDF on olemassa ja käytettävissä.
- Varmista, että sovellus käyttää organisaatiollesi soveltuvaa palvelupäätepistettä.
- Varmista, että tunnistetulla identiteetillä on käyttöoikeus pyydettyyn resurssiin.
- API-virheissä säilytä X-Request-ID, joka palautetaan vastauksen otsikoissa, kun se on saatavilla. Tukipalvelu voi käyttää tätä tunnistetta pyynnön jäljittämiseen.
Toteutuksessa huomioitavaa
- Tämä kattava työnkulku hyväksyy PDF-tiedostoja.
- Esittely hallinnoi todennustunnuksia API-käyttöoikeuden määrittämisen jälkeen.
- API-toiminnot käyttävät todennetun identiteetin käytettävissä olevia käyttöoikeuksia.
- Lähdepaketti sisältää alueellisen päätepisteen löytötoiminnallisuuden, mutta tuotantoympäristön päätepisteen arvot tulee ottaa nykyisestä Knowledge Base API -dokumentaatiosta, ei esimerkin mukana toimitetuista vanhoista arvoista.
