Загрузите и извлеките пакет демонстрации на Python.
Пакет содержит скрипты и конфигурацию, используемые для демонстрации управления коллекциями, обработки документов, выполнения вывода и соответствующих операций API.
Последнее обновление
12 окт. 2026 г.
Запускайте, проверяйте и адаптируйте рабочую реализацию на Python общих рабочих процессов API Knowledge Base.
Демо-версия Python обеспечивает функциональную отправную точку для разработки приложений. Используйте полный рабочий процесс, чтобы увидеть совместную работу операций создания коллекции, обработки документов и вывода ИИ, а затем изучите отдельные скрипты для выполнения конкретных операций с коллекцией и задач вывода.
Перед началом работы
Убедитесь, что у вас есть:
- Доступ к API Knowledge Base.
- Учетные данные, необходимые для аутентификации вашего приложения.
- Python 3.7 или более поздняя версия. Рекомендуется Python 3.11 или более поздняя версия.
- Файл PDF, который можно использовать для выполнения полного демонстрационного рабочего процесса.
Если вы еще не настроили доступ к API-интерфейсу, см. раздел Настройка доступа к API-интерфейсу Knowledge Base.
Загрузка и настройка демо-приложения на Python
Создайте виртуальную среду:
python3 -m venv venv
Активируйте среду:
- На macOS или Linux:
source venv/bin/activate - В Windows:
venv\Scripts\activate
Установите зависимости:
pip install --upgrade pip
pip install -e .
Добавьте необходимые учетные данные API и конфигурацию службы в config.yaml.
Перейдите в подпапку python перед запуском примеров скриптов.
Демо-версия использует запросы, pyyaml и tqdm. Учетные данные хранятся в config.yaml, а токены аутентификации управляются автоматически.
Не фиксируйте файлы config.yaml или созданные файлы .token в системе управления версиями.
Запуск полного рабочего процесса
Запустите:
python knowledgebase.py
Чтобы использовать определенный PDF:
python knowledgebase.py --document=<path-to-pdf>
Демонстрация:
- Выполняет аутентификацию в API.
- Создает коллекцию с названием demo-collection.
- Добавляет PDF.
- Отслеживает документ до завершения индексирования.
- Выполняет запрос на инференс для обработанного документа.
Добавление и индексирование — это отдельные части обработки документов. Индексирование извлекает содержимое документа и делает его доступным для операций ИИ.
Если не указать файл PDF, демонстрационная программа выберет один из файлов, находящихся в каталоге документов пакета. Время обработки документа истекает через пять минут, если документ не переходит в завершенное состояние.
Примечание
Полный технологический процесс создает коллекцию с названием demo-collection и добавляет в нее PDF. Демонстрация не удаляет коллекцию или добавленный документ после завершения технологического процесса.
Обзор операций с коллекциями
После запуска полного технологического процесса используйте отдельные сценарии для изучения конкретных операций API.
Создание коллекции
python collection.py --action create --name <collection-name>
Названия коллекций могут содержать до 255 символов.
Список коллекций
python collection.py --action list
При запросе выберите, показывать ли коллекции, созданные вами, переданные вами в общий доступ или переданные другими пользователями.
Предоставление общего доступа к коллекции
python collection.py --action share --collection-id <collection-id>
Введите адреса электронной почты, которые должны получить доступ на чтение или запись при запросе.
Добавление документов
python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>
Скрипт может добавить один файл или документы из указанного каталога.
Просмотр документов в коллекции
python collection.py --action get_documents --collection-id <collection-id>
Проверка статуса обработки документа
python collection.py --action get_status --document-id <document-id>
Демонстрация предоставляет эти операции в качестве отдельных примеров, которые вы можете изучить и адаптировать независимо от полного технологического процесса.
Обзор операций вывода
Примеры вывода требуют идентификатор коллекции и идентификатор документа. Используйте скрипты для работы с коллекциями, чтобы определить их:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Ответы на вопросы
Просмотрите ваши коллекции и документы, затем запустите пример вопросов и ответов:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Введите идентификатор коллекции, идентификатор документа и вопрос при запросе.
Краткое изложение документа
Определите коллекцию и документ, затем запустите образец для создания сводки:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Введите идентификатор коллекции и идентификатор документа при запросе.
Поиск по контексту
Определите коллекцию и документ, затем запустите пример поиска по контексту:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Введите идентификатор коллекции, идентификатор документа и текст для поиска при запросе.
Извлечение свойств
Определите коллекцию и документ, затем запустите пример извлечения:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Введите идентификатор коллекции, идентификатор документа, имя свойства, запрос извлечения, тип данных и необязательное описание при появлении запроса.
Продолжение разработки с помощью API
Python Demo предоставляет рабочие шаблоны реализации, а не полную документацию API.
Используйте раздел Начало работы с API Knowledge Base, чтобы понять модель ресурсов API, жизненный цикл документа, поведение вывода и обработку ответов.
Используйте справочник по API Knowledge Base, если вам нужны текущие пути к конечным точкам, параметры, схемы запросов и ответов, а также информация о состоянии.
Устранение неполадок
Демо записывает подробную диагностическую информацию в:
logs/knowledgebase-demo.log
В файл журнала записывается информация уровня DEBUG, а на консоль выводятся сообщения уровня WARNING и выше.
Если операция завершается неудачно:
- Просмотрите logs/kinowledgebase-demo.log для получения сведений о запросе и аутентификации.
- Проверьте настройки в config.yaml.
- Убедитесь, что используемый PDF существует и доступен.
- Убедитесь, что приложение использует соответствующую конечную точку службы для вашей организации.
- Убедитесь, что аутентифицированный пользователь имеет доступ к запрашиваемому ресурсу.
- При сбоях API сохраните X-Request-ID, возвращаемый в заголовках ответа, если доступен. Поддержка может использовать этот идентификатор для отслеживания запроса.
Соображения по реализации
- Полный технологический процесс принимает файлы PDF.
- Демонстрационное приложение управляет токенами аутентификации после настройки доступа к API.
- Операции API используют разрешения, доступные аутентифицированному удостоверению.
- Пакет исходного кода включает функции для обнаружения региональных конечных точек, однако для рабочей среды значения конечных точек следует брать из актуальной документации по Knowledge Base API, а не использовать устаревшие значения из демонстрационной версии.
