На этой странице

SDK для Python и TypeScript

Создайте ключ чтения для проиндексированной памятки Next Product Lab по инструкции Подключите ContextBase к приложению. Задайте CONTEXTBASE_BASE_URL, CONTEXTBASE_API_KEY и CONTEXTBASE_SPACE_ID. Клиенты берут адрес и ключ из окружения или аргументов конструктора.

Поиск через Python

Установите релиз-кандидат из PyPI командой pip install --pre contextbase-sdk. Сохраните и запустите скрипт.

import os

from contextbase import ContextBase

with ContextBase() as client:
    client.check_compatibility()
    space = client.spaces.get(os.environ["CONTEXTBASE_SPACE_ID"])
    question = "За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?"
    for source in space.search(question):
        print(source.id, source.text)

Найдите в выводе абзац о заметках к выпуску. В сервисе с asyncio используйте AsyncContextBase. Контекстный менеджер закрывает HTTP-соединение.

Поиск через TypeScript

Используйте Node.js 18 или новее. Установите релиз-кандидат из npm командой npm install contextbase-sdk@next. Запустите пример как ES-модуль.

import { ContextBase } from "contextbase-sdk";

const client = new ContextBase();
await client.checkCompatibility();
const space = await client.spaces.get(process.env.CONTEXTBASE_SPACE_ID);
const question = "За сколько рабочих дней до демонстрации нужно подготовить черновик заметок к выпуску?";
for (const source of await space.search(question, { top_k: 5 })) {
  console.log(source.id, source.text);
}

Получение ответа или потока

Настройте модель и включите генератор в пространстве. В Python выполните этот вызов внутри контекстного менеджера клиента.

result = space.query(question, top_k=5)
if result.outcome == "accepted":
    print(result.answer)
    for source in result.sources:
        print(source.locator, source.text)
else:
    print(result.outcome)

В примере на TypeScript вызовите queryStream() для того же пространства и вопроса.

for await (const event of space.queryStream(question, { top_k: 5 })) {
  if (event.type === "done") {
    const { answer, sources, outcome } = event.answer;
    console.log(outcome === "accepted" ? { answer, sources } : { outcome });
  } else if (event.type === "error") {
    console.error(event.reason, event.detail);
  }
}

Установка из исходников

Для Python выполните uv sync --directory sdk/python --frozen из корня репозитория. Запускайте скрипты в этом окружении через uv run --directory sdk/python python.

Для сборки TypeScript используйте Node.js 22. Установите полученный пакет в приложение командой npm install /path/to/package.tgz.

cd sdk/typescript
npm ci
npm run build
npm pack

Методы для типовых задач

Задача

Python

TypeScript

Проверить версию API сервера

client.check_compatibility()

client.checkCompatibility()

Перечислить доступные пространства

client.spaces.list()

client.spaces.list()

Загрузить документ и дождаться индексации

space.documents.upload(), space.documents.wait_indexed()

space.documents.upload(), space.documents.waitIndexed()

Найти фрагменты, получить ответ или поток

space.search(), space.query(), space.query_stream()

space.search(), space.query(), space.queryStream()

Проверить и применить настройки пайплайна

space.config.validate(), space.config.apply()

space.config.validate(), space.config.apply()

Измерить качество пайплайна

client.eval_datasets.create(), space.evaluations.run()

client.evalDatasets.create(), space.evaluations.run()

search() возвращает список источников. Метод Python search_with_receipt() также отдаёт сведения о фактических параметрах поиска, включая результат применения rrf_k. Метод query() возвращает объект с отдельными полями answer, sources и outcome. Поток в Python выдаёт объекты классов Check, Token, Done, ErrorEvent и других. В TypeScript вид события определяется полем type. В обоих SDK итог находится в event.answer события завершения.

Точные сигнатуры, значения по умолчанию и описания методов Python собраны в Справочник методов Python SDK. Остальные эндпоинты описаны в Справочник REST API. В Python используйте contextbase.types, сгенерированные операции и низкоуровневый клиент. В TypeScript используйте types, operations и client.raw. Полный список типов и ошибок содержится в экспорте Python SDK и экспорте TypeScript SDK. Версии и выпуски описаны в README Python SDK и README TypeScript SDK.

Запустите готовую интеграцию

  • Ноутбук ищет фрагменты и запрашивает ответ в готовом пространстве с генератором. Установите три переменные окружения и выберите ядро из окружения SDK.

  • Загрузка и запрос — пример создания пространства с явно заданной моделью, загрузки файла и ожидания индексации. Владельцу ключа нужно право создания пространств.

  • Сервис FastAPI предоставляет POST /ask для заданного пространства. Из каталога sdk/python запустите uv run fastapi dev examples/fastapi_service.py. Перед использованием обеспечьте авторизацию на стороне приложения.

  • Адаптер для LangChain и адаптер для LlamaIndex передают найденные фрагменты в отдельно настроенный пайплайн генерации.

Команды настройки есть в README примеров. Тесты примеров проверяют их с контролируемыми HTTP-ответами.

ContextBase0.1.0

Поиск в документации