Pobierz i wypakuj pakiet wersji demonstracyjnej Pythona.
Pakiet zawiera skrypty i konfigurację używane do demonstracji zarządzania kolekcjami, przetwarzania dokumentów, wnioskowania i powiązanych operacji API.
Ostatnia aktualizacja
29 wrz 2026
Uruchom, sprawdź i dostosuj działającą implementację w języku Python typowych procesów API Knowledge Base.
Wersja demonstracyjna Python zapewnia funkcjonalny punkt wyjścia do tworzenia aplikacji.Użyj kompletnego procesu, aby zobaczyć tworzenie kolekcji, przetwarzanie dokumentów i wnioskowanie SI współpracujące ze sobą, a następnie poznaj poszczególne skrypty dla konkretnych operacji kolekcji i wnioskowania.
Zanim zaczniesz
Upewnij się, że masz:
- Dostęp do API Knowledge Base.
- Poświadczenia wymagane do uwierzytelnienia aplikacji.
- Python 3.7 lub nowszy.Zalecany jest Python 3.11 lub nowszy.
- PDF, którego można użyć w kompletnym procesie demonstracyjnym.
Jeśli nie skonfigurowano dostępu do API, zobacz Konfigurowanie dostępu do API Knowledge Base.
Pobierz i skonfiguruj wersję demonstracyjną Python
Utwórz środowisko wirtualne:
python3 -m venv venv
Aktywuj środowisko:
- W systemie macOS lub Linux:
source venv/bin/activate - W systemie Windows:
venv\Scripts\activate
Zainstaluj zależności:
pip install --upgrade pip
pip install -e .
Dodaj wymagane poświadczenia API i konfigurację usługi do config.yaml.
Przejdź do podfolderu python przed uruchomieniem przykładowych skryptów.
Demo używa requests, pyyaml i tqdm.Poświadczenia są przechowywane w config.yaml, a tokeny uwierzytelniania są zarządzane automatycznie.
Nie zatwierdzaj plików config.yaml ani wygenerowanych plików .token do systemu kontroli wersji.
Uruchom pełny obieg pracy
Uruchom:
python knowledgebase.py
Aby użyć określonego pliku PDF:
python knowledgebase.py --document=<ścieżka-do-pdf>
Demo:
- Uwierzytelnia za pomocą interfejsu API.
- Tworzy kolekcję o nazwie demo-collection.
- Przesyła plik PDF.
- Monitoruje dokument, aż indeksowanie zostanie ukończone.
- Uruchamia żądanie wnioskowania względem przetworzonego dokumentu.
Przesyłanie i indeksowanie to odrębne części importowania dokumentu.Indeksowanie wyodrębnia zawartość dokumentu i udostępnia ją operacjom SI.
Jeśli nie określisz pliku PDF, demo wybiera jeden z katalogu documents pakietu.Przetwarzanie dokumentu przekracza limit czasu po pięciu minutach, jeśli nie osiągnie stanu ukończenia.
Spostrzeżenie
Pełny obieg pracy tworzy kolekcję o nazwie demo-collection i przesyła do niej plik PDF.Demo nie usuwa kolekcji ani przesłanego dokumentu po zakończeniu obiegu pracy.
Poznaj operacje na kolekcjach
Po uruchomieniu pełnego obiegu pracy użyj pojedynczych skryptów, aby eksplorować określone operacje API.
Utwórz kolekcję
python collection.py --action create --name <collection-name>
Nazwy kolekcji mogą zawierać do 255 znaków.
Wyświetl kolekcje
python collection.py --action list
Wybierz, czy chcesz wyświetlić kolekcje utworzone przez Ciebie, udostępnione przez Ciebie, czy udostępnione przez innych, gdy zostaniesz o to poproszony.
Udostępnij kolekcję
python collection.py --action share --collection-id <collection-id>
Wprowadź adresy e-mail, które powinny otrzymać dostęp do odczytu lub zapisu po wyświetleniu polecenia.
Prześlij dokumenty
python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>
Skrypt może przekazać pojedynczy plik lub dokumenty z określonego katalogu.
Wyświetl listę dokumentów w kolekcji
python collection.py --action get_documents --collection-id <collection-id>
Sprawdź status przetwarzania dokumentu
python collection.py --action get_status --document-id <document-id>
Wersja demonstracyjna udostępnia te operacje jako niezależne przykłady, które można sprawdzić i dostosować niezależnie od kompletnego obiegu pracy.
Poznaj operacje wnioskowania
Przykłady wnioskowania wymagają identyfikatora kolekcji i identyfikatora dokumentu. Użyj skryptów kolekcji, aby je zidentyfikować:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Odpowiadanie na pytania
Wyświetl listę kolekcji i dokumentów, a następnie uruchom przykład pytań i odpowiedzi:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Wprowadź identyfikator kolekcji, identyfikator dokumentu i pytanie po wyświetleniu monitu.
Podsumowanie dokumentu
Zidentyfikuj kolekcję i dokument, następnie uruchom przykład podsumowania:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Wprowadź identyfikator kolekcji i identyfikator dokumentu po wyświetleniu monitu.
Wyszukiwanie kontekstowe
Zidentyfikuj kolekcję i dokument, następnie uruchom przykład wyszukiwania kontekstowego:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Po wyświetleniu monitu wprowadź identyfikator kolekcji, identyfikator dokumentu i tekst wyszukiwania.
Wyodrębnianie właściwości
Zidentyfikuj kolekcję i dokument, a następnie uruchom przykład wyodrębniania:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Po wyświetleniu polecenia wprowadź identyfikator kolekcji, identyfikator dokumentu, nazwę właściwości, polecenie wyodrębniania, typ danych i opcjonalny opis.
Kontynuuj tworzenie przy użyciu interfejsu API
Demonstracja Python udostępnia działające wzorce implementacji, a nie pełną dokumentację interfejsu API.
Aby poznać model zasobów interfejsu API, cykl życia dokumentu, zachowanie wnioskowania i obsługę odpowiedzi, skorzystaj z artykułu Rozpocznij pracę z interfejsem API Knowledge Base.
Skorzystaj z dokumentacji interfejsu API Knowledge Base, jeśli potrzebujesz bieżących ścieżek punktów końcowych, parametrów, schematów żądań i odpowiedzi oraz informacji o stanie.
Rozwiązywanie problemów
Demonstracja zapisuje szczegółowe informacje diagnostyczne w pliku:
logs/knowledgebase-demo.log
Plik dziennika rejestruje informacje poziomu DEBUG, podczas gdy konsola wyświetla komunikaty poziomu WARNING i wyżej.
Jeśli operacja zakończy się niepowodzeniem:
- Przejrzyj plik logs/kinowledgebase-demo.log, aby uzyskać szczegóły żądania i uwierzytelniania.
- Zweryfikuj ustawienia w pliku config.yaml.
- Potwierdź, że używany plik PDF istnieje i jest dostępny.
- Potwierdź, że aplikacja używa odpowiedniego punktu końcowego usługi dla organizacji.
- Potwierdź, że uwierzytelniona tożsamość ma dostęp do żądanego zasobu.
- W przypadku awarii interfejsu API zachowaj identyfikator X-Request-ID zwracany w nagłówkach odpowiedzi, jeśli jest dostępny. Pomoc techniczna może użyć tego identyfikatora do śledzenia żądania.
Zagadnienia dotyczące implementacji
- Kompletny obieg pracy akceptuje pliki PDF.
- Demonstracja zarządza tokenami uwierzytelniania po skonfigurowaniu dostępu do interfejsu API.
- Operacje interfejsu API używają uprawnień przypisanych do uwierzytelnionej tożsamości.
- Pakiet źródłowy zawiera funkcjonalność automatycznego wykrywania punktów końcowych regionalnych, ale wartości punktów końcowych produkcyjnych powinny pochodzić z bieżącej dokumentacji API Knowledge Base, a nie ze starszych wartości dołączonych do wersji demonstracyjnej.
