Začínáme s ukázkou Python pro databázi znalostí

Naposledy aktualizováno 29. 9. 2026

Spusťte, zkontrolujte a přizpůsobte funkční implementaci Pythonu běžných pracovních postupů rozhraní API Knowledge Base.

Python Demo poskytuje funkční výchozí bod pro vývoj aplikací.Použijte kompletní pracovní postup k zobrazení vytváření kolekce, zpracování dokumentů a inference AI fungující společně, poté prozkoumejte jednotlivé skripty pro konkrétní operace kolekce a inference.

Na úvod

Ujistěte se, že máte:

  • Přístup k rozhraní API Knowledge Base.
  • Pověření požadovaná k ověření vaší aplikace.
  • Python 3.7 nebo novější.Doporučuje se Python 3.11 nebo novější.
  • PDF, které můžete použít pro kompletní ukázkový pracovní postup.

Pokud jste nenakonfigurovali přístup k rozhraní API, viz Nastavení přístupu k rozhraní API Knowledge Base.

Stažení a nastavení Python Demo

Stáhněte a rozbalte balíček Python Demo.

Balíček obsahuje skripty a konfiguraci používané k demonstraci správy kolekcí, zpracování dokumentů, inference a souvisejících operací rozhraní API.

Vytvořte virtuální prostředí:

python3 -m venv venv

Aktivujte prostředí:

  • Na macOS nebo Linuxu:
    source venv/bin/activate
  • Na Windows:
    venv\Scripts\activate

Nainstalujte závislosti:

pip install --upgrade pip
pip install -e .

Přidejte požadovaná pověření rozhraní API a konfiguraci služby do config.yaml.

Před spuštěním vzorových skriptů přejděte do podsložky python.

Demo používá requests, pyyaml a tqdm.Pověření jsou uložena v config.yaml a autentizační tokeny jsou spravovány automaticky.

Nepotvrzujte soubory config.yaml nebo generované soubory .token do správy zdrojů.

Spustit kompletní pracovní postup

Spustit:

python knowledgebase.py

Chcete-li použít konkrétní PDF:

python knowledgebase.py --document=<cesta-k-pdf>

Ukázka:

  1. Ověří se pomocí API.
  2. Vytvoří kolekci s názvem demo-collection.
  3. Nahraje PDF.
  4. Monitoruje dokument, dokud se dokončí indexování.
  5. Spustí požadavek na odvození vůči zpracovanému dokumentu.

Nahrávání a indexování jsou odlišné části zpracování dokumentu.Indexování extrahuje obsah dokumentu a zpřístupní jej operacím AI.

Pokud neuvedete PDF, ukázka vybere jeden z adresáře documents balíčku.Zpracování dokumentu vyprší po pěti minutách, pokud nedosáhne dokončeného stavu.

Poznámka

Kompletní pracovní postup vytvoří kolekci s názvem demo-collection a nahraje do ní PDF.Ukázka po dokončení pracovního postupu kolekci ani nahraný dokument nesmaže.

Prozkoumat operace kolekce

Po spuštění kompletního pracovního postupu použijte jednotlivé skripty k prozkoumání konkrétních operací API.

Vytvořit kolekci

python collection.py --action create --name <název-kolekce>

Názvy kolekcí mohou obsahovat až 255 znaků.

Vypsat kolekce

python collection.py --action list

Když budete vyzváni, vyberte, zda chcete vypsat kolekce vytvořené vámi, sdílené vámi nebo sdílené ostatními.

Sdílet kolekci

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

Zadejte e-mailové adresy, které by měly obdržet oprávnění ke čtení nebo zápisu, když budete vyzváni.

Nahrát dokumenty

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

Skript může nahrát jednotlivý soubor nebo dokumenty ze zadaného adresáře.

Zobrazit dokumenty v kolekci

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

Zkontrolovat stav zpracování dokumentu

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

Demo poskytuje tyto operace jako samostatné příklady, které můžete prozkoumat a upravit nezávisle na kompletním pracovním postupu. 

Prozkoumejte inferenční operace

Příklady inference vyžadují ID kolekce a ID dokumentu. Použijte skripty kolekce k jejich identifikaci:

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

Odpovídání na otázky

Vypište své kolekce a dokumenty, pak spusťte příklad otázek a odpovědí:

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

Zadejte ID kolekce, ID dokumentu a otázku, když budete vyzváni.

Shrnutí dokumentu

Identifikujte kolekci a dokument, pak spusťte příklad shrnutí:

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

Zadejte ID kolekce a ID dokumentu, když budete vyzváni.

Kontextové vyhledávání

Identifikujte kolekci a dokument, pak spusťte příklad kontextového vyhledávání:

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

Po zobrazení výzvy zadejte ID kolekce, ID dokumentu a text hledání.

Extrakce vlastností

Identifikujte kolekci a dokument, poté spusťte příklad extrakce:

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

Po zobrazení výzvy zadejte ID kolekce, ID dokumentu, název vlastnosti, pokyn pro extrakci, typ dat a volitelný popis. 

Pokračujte v sestavování pomocí rozhraní API

Ukázka Pythonu poskytuje funkční implementační vzory spíše než úplnou dokumentaci rozhraní API.

Použijte Začínáme s rozhraním API Knowledge Base k pochopení modelu zdrojů rozhraní API, životního cyklu dokumentu, chování inference a zpracování odpovědí.

Když potřebujete aktuální cesty koncových bodů, parametry, schémata požadavků a odpovědí a informace o stavu, použijte Knowledge Base – referenci rozhraní API.

Odstraňování potíží

Ukázka zapisuje podrobné diagnostické informace do:

logs/knowledgebase-demo.log

Soubor protokolu zaznamenává informace na úrovni DEBUG, zatímco konzola zobrazuje zprávy na úrovni WARNING a vyšší.

Pokud operace selže:

  • Zkontrolujte logs/kinowledgebase-demo.log pro podrobnosti o požadavku a autentizaci.
  • Ověřte nastavení v config.yaml.
  • Potvrďte, že PDF, které používáte, existuje a je přístupné.
  • Potvrďte, že aplikace používá příslušný koncový bod služby pro vaši organizaci. 
  • Potvrďte, že ověřená identita má přístup k požadovanému zdroji.
  • V případě selhání rozhraní API si ponechte X-Request-ID vrácené v hlavičkách odpovědi, pokud je k dispozici. Podpora může tento identifikátor použít ke sledování požadavku. 

Aspekty implementace

  • Kompletní pracovní postup přijímá PDF soubory.
  • Ukázka spravuje autentizační tokeny po konfiguraci přístupu k rozhraní API.
  • Operace rozhraní API používají oprávnění dostupná pro ověřenou identitu.
  • Zdrojový balíček zahrnuje funkci regionálního zjišťování koncových bodů, ale hodnoty koncových bodů pro produkci by měly pocházet z aktuální dokumentace API Knowledge Base a ne ze starších hodnot zahrnutých v ukázce.