На этой странице
Работа из командной строки¶
Установите CLI¶
Подготовьте Python 3.11 или новее. Выполните из корня репозитория:
python -m pip install './sdk/python[cli]'
contextbase --version
Если SDK с CLI опубликован, установите его командой
python -m pip install 'contextbase-sdk[cli]'.
См. метаданные пакета.
--help и --version работают без сети.
Подключитесь к пространству¶
Создайте ключ с правом read для проиндексированной памятки
Next Product Lab из Установка и быстрый старт. Возьмите UUID пространства
по инструкции Подключите ContextBase к приложению. Задайте CONTEXTBASE_API_KEY через
хранилище секретов или передайте --key-file с файлом, доступным
только вашей учётной записи.
Подставьте UUID вместо SPACE_UUID. В примере указан адрес
локальной установки.
contextbase --base-url http://localhost:13000 --space SPACE_UUID \
search 'За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?'
В подходящем фрагменте указан срок в два рабочих дня до демонстрации.
Проверить индексацию памятки можно через documents list.
Сохраните профиль¶
contextbase profile set local --url http://localhost:13000 --default-space SPACE_UUID
contextbase --profile local meta
contextbase --profile local spaces list
meta проверяет совместимость сервера без ключа. profile list
показывает сохранённые адреса и пространства. Профиль хранит эти
настройки без ключа.
Указывайте глобальные параметры перед командой, например
contextbase --profile local --key-file /secure/contextbase.key spaces list.
--profileимеет приоритет надCONTEXTBASE_PROFILE. Профиль по умолчанию —default.--base-urlи--spaceимеют приоритет надCONTEXTBASE_BASE_URLиCONTEXTBASE_SPACE, а переменные окружения — над значениями профиля.--key-fileимеет приоритет надCONTEXTBASE_API_KEY.CONTEXTBASE_CONFIGменяет путь к файлуprofiles.json.--timeoutзадаёт лимит времени запроса SDK. По умолчанию действует 60 секунд.
Загрузите документ и задайте вопрос¶
Выдайте ключу право write. Скачайте
памятку Next Product Lab
или возьмите свой файл. Команды используют пространство из профиля.
contextbase --profile local documents upload ./next-product-lab-demo-ru.txt --wait
contextbase --profile local documents list
Для пакетной загрузки передайте папку. С --recursive CLI обработает
вложенные папки, с --include '*.txt' — только подходящие файлы.
--wait ждёт индексации до 300 секунд. Лимит меняется параметром
--wait-timeout.
Если сервер вернул ID файлов, а ожидание прервалось, продолжите по этим
ID. Если исход загрузки неизвестен, проверьте documents list
перед повтором. Ctrl+C прерывает локальное ожидание. Сервер может
продолжать работу.
contextbase --profile local documents get DOCUMENT_UUID
contextbase --profile local documents wait DOCUMENT_UUID --wait-timeout 600
Получите ответ или поток событий¶
Подключите языковую модель и включите генерацию в пространстве. См. Установка и быстрый старт.
contextbase --profile local query 'За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?'
contextbase --profile local --output ndjson query 'За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?' --stream
query возвращает ответ с источниками. В потоковом режиме
--deadline ограничивает весь запрос, включая ожидание событий.
Лимит по умолчанию — 300 секунд. Поля ответа описаны в Подключите ContextBase к приложению.
Настройте и оцените пайплайн¶
presets listвыводит шаблоны. Примените шаблон поиска командойpresets apply search --yes, затем проверьте перестройку черезpresets status. Граф агента настраивается отдельно по инструкции Генерация ответа и просмотр источников.Для датасета и ключа с нужными правами запустите
evaluations run DATASET_UUID. Передайте полученный ID вevaluations get RUN_UUID. См. Оцените качество поиска и ответов.
Читайте результаты из скриптов¶
contextbase schema > commands.json
contextbase --profile local --output json --non-interactive documents list
Формат по умолчанию — терминальный text. JSON возвращает один объект
с schema_version, event и data. При сбое добавляется
error. Ход работы и диагностика идут в stderr. Проверяйте код выхода
и сохраняйте ID для следующих запросов статуса.
Для query --stream используйте --output ndjson. В каждой строке
приходит одно событие stage, check, token, done
или error. Для токенов берите data.delta, для итогового ответа
и источников — data.answer в событии done. Проверяйте наличие
done и нулевой код выхода.
При сбое пакетной загрузки JSON и NDJSON сохраняют ID принятых файлов
в data.uploaded, а пути распределяют по failed, unknown
и unattempted. Проверяйте состояние принятых файлов до завершения
индексации.
Вызовите операцию API напрямую¶
Для отдельных операций используйте
contextbase api <resource> <operation>. Сгенерированные команды
охватывают операции для ключей, общедоступные сведения о сервере
и статус первичной настройки.
contextbase api --help
contextbase api spaces get-space --help
contextbase --profile local --output json api spaces get-space --id "$SPACE_ID"
contextbase --profile local --output json api spaces list-spaces --page 2
Запишите UUID своего пространства в SPACE_ID. Сгенерированные
команды принимают явные параметры вроде --id или --space-id
и возвращают одну страницу за вызов. Готовые команды списков собирают
все страницы.
Передайте JSON через --body или --body-file, файл для
загрузки — через --file, путь сохранения — через --save-to.
Для удаления нужен --yes. Права и контракт REST описаны в
Справочник REST API. Коды выхода и автодополнение — в
руководстве CLI.