На этой странице
Подключите ContextBase к приложению¶
1. Выдайте приложению доступ к пространству¶
В разделе Доступ и ключи создайте ключ типа Обычный для пространства с проиндексированной памяткой Next Product Lab из Установка и быстрый старт. Выберите Чтение, задайте срок действия и сохраните полный ключ в хранилище секретов. В списке ключей видны его префикс и статус.
Задайте переменные в локальном терминале или на сервере приложения.
CONTEXTBASE_BASE_URL—http://localhost:13000для локального запуска или HTTPS-адрес вашей установки.CONTEXTBASE_SPACE_ID— UUID из адреса пространства или ответаGET /api/v1/spaces/с выданным ключом.CONTEXTBASE_API_KEY— полный ключ для заголовкаX-API-Key. Храните ключ на серверной стороне приложения.
2. Найдите фрагменты с подтверждением¶
curl --fail-with-body "$CONTEXTBASE_BASE_URL/api/v1/spaces/$CONTEXTBASE_SPACE_ID/search" \
-H "X-API-Key: $CONTEXTBASE_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"query":"За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?","top_k":5}'
Найдите абзац о заметках к выпуску в sources[].text. В памятке
указан срок не позднее чем за два рабочих дня до демонстрации.
Найденные фрагменты
Вызовите POST /search и выведите sources[] в порядке
ранжирования. Чтобы обойтись без LLM, выберите преобразования
запроса и реранкеры, которым она не нужна.
Ответ с цитатами
Вызовите POST /query или POST /query/stream. Выведите
answer и sources[] отдельными блоками. Из потока
возьмите их в завершающем событии done.
Параметры поиска¶
top_kдляsearch,queryиquery/streamпринимает от 1 до 20. Значение по умолчанию — 5.metadata_filterограничивает поиск по полям пространства. Сверьте ограничения для выбранного режима.rrf_kменяет константу объединения вsearch, если пайплайн это поддерживает. Фактическое значение смотрите вretrieval_receipt.
3. Получите ответ и выведите цитаты¶
Настройте модель и включите генератор в пространстве.
curl --fail-with-body "$CONTEXTBASE_BASE_URL/api/v1/spaces/$CONTEXTBASE_SPACE_ID/query" \
-H "X-API-Key: $CONTEXTBASE_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"query":"За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?","top_k":5}'
Проверьте, что цитаты подтверждают срок в два рабочих дня. Формулировка
ответа может различаться. При outcome со значением blocked
пайплайн удержал ответ.
Используйте для цитат поля источника.
text— найденная выдержка. Вparent_textможет прийти более широкий контекст. Вgraph_context— сводки и связи графа.locator— проверенное место в документе, когда оно известно. В нём естьdocument_id, название документа, путь раздела и позиции в символах Юникода. Началоstartвходит в диапазон, конецendисключён. Страница и метка необязательны. У родительского фрагмента может быть свойparent_locator.bibliography— доступное описание канонического документа. Покажите URL владельца как справочную ссылку. Скачивайте сохранённый оригинал через API документов с авторизацией.
Открывайте канонический чанк через
GET /api/v1/spaces/{space_id}/chunks/{chunk_id}. У выдержки из
подключённого хранилища может не быть канонического чанка. В этом
случае покажите полученный текст. Передавайте ID целиком. После
изменения документа он может перестать открываться.
Обратная связь¶
При наличии query_id по нему можно найти запись запроса. Автор
запроса может оценить сохранённый ответ через веб-сессию или ключ с правом
read в пространстве. Отправьте оценку через
PUT /api/v1/spaces/{space_id}/queries/{query_id}/feedback.
4. Покажите ход генерации¶
POST /api/v1/spaces/{space_id}/query/stream принимает тело query
и возвращает Server-Sent Events. Читайте ответ на POST через SDK или
curl -N. Обработайте ошибки HTTP до чтения событий.
Событие |
Действие в приложении |
|---|---|
|
Покажите этап по полям |
|
Свяжите проверки по |
|
Добавьте |
|
Замените предварительный текст полями |
|
Завершите показ прогресса. Выведите |
Если запрос не сработал¶
401— проверьте полныйX-API-Key, срок действия и установку.404— проверьте UUID и доступ ключа. Пространство без доступа тоже может вернуть404.409— поreasonпроверьте готовность индекса, модель генератора и совместимость фильтра с режимом запроса.502— поdetailопределите, какой провайдер, хранилище или другой внешний сервис нужно проверить.
Выпуск ключей по API¶
Вызовите POST /api/v1/auth/api-keys/ с авторизованной пользовательской
сессией.
{
"name": "Демо-приложение Next Product Lab",
"purpose": "generic",
"scopes": [{"space": "SPACE_UUID", "level": "read"}]
}
Выдайте write для загрузки документов, manage для изменения
пайплайна и запуска оценки от имени владельца в операциях, принимающих
ключи. Действуют и уровень ключа, и текущая роль его владельца. Для
выпуска ключей нужна пользовательская сессия. Участниками и настройками
установки управляйте в веб-интерфейсе. См. Пространства и доступ.