TypeScript SDK - Conare

conare обгортає API для Node 18 і новіших версій та Bun, без залежностей.

npm install conare

import { Conare } from "conare";

const conare = new Conare(); // reads CONARE_API_KEY
const docs = conare.namespace("docs");

await docs.add({ text: "Refunds are available for 30 days." });
const results = await docs.query("how do refunds work?");

Result

[
  {
    "id": "doc_HmsFWqbQQc2mY03FhVZE",
    "text": "Refunds are available for 30 days.",
    "score": 0.3192,
    "reranked": true,
    "metadata": {}
  }
]

Поля відповіді записано в camelCase, а позначки часу є об’єктами Date.

Параметри

new Conare({
  apiKey: "sk-conare-...",           // default: CONARE_API_KEY
  baseURL: "https://api.conare.ai",  // default: CONARE_BASE_URL
  timeout: 60_000,                   // ms per attempt
  maxRetries: 2,
  organization: "org_...",           // for a multi-organization key
});

Кожен метод також приймає останнім аргументом { signal, timeout, idempotencyKey }.

Методи

Метод	Повертає
`conare.namespace(name)`	Дескриптор простору імен; нічого не надсилається, доки ви не викличете метод
`conare.namespaces({ prefix })`	`[{ name, documents, embeddingModel, rerankModel }]`
`ns.add(docs)`	Ідентифікатори
`ns.write(docs)`	`[{ id, version, result, chunks, chunksEmbedded }]`
`ns.query(query, { topK, filter, rerank, rerankDepth, retrievers, user, userPrefix, excludeIds, hops })`	`[{ id, text, score, reranked, metadata }]`
`ns.queryPages(query, { maxResults, ... })`	Асинхронний ітератор сторінок
`ns.get(id)`	Документ або `null`
`ns.list({ limit })`	Асинхронний ітератор по всіх документах
`ns.delete(id)`	Нічого
`ns.deleteMany(ids)`, `ns.deleteWhere(filter)`	Скільки видалено
`ns.create({ embeddingModel })`	`{ embeddingModel }`
`ns.drop({ force })`	`{ sourcesDeleted }`
`ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })`	Завантаження і, коли воно `ready`, його Markdown
`ns.getFile(fileId, { user })`	Останнє завантаження файлу
`conare.parse(file or { url }, { name, type, pages, password, layout, wait })`	Markdown файлу, нічого не зберігається
`conare.getParse(id)`	Розбір, який відповів `parsing`
`conare.embed(texts, { type, outputDtype })`	Вектори; з `int8` — `{ values, scales }` (`dequantize` перетворює їх назад)
`conare.rerank(query, documents, { topK })`	`[{ index, score, document }]`, з `unscored`
`conare.sources`	`connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types`
`conare.organizations()`	Організації, від імені яких діє ключ
`conare.users.delete(user)`, `deletePrefix(prefix)`	Запуск, що видаляє дані користувача
`conare.events.list({ cursor, types })`	Що змінилося, по порядку

add і write приймають один документ або масив будь-якого розміру й надсилають по 100 за раз.
Пошук у всіх просторах імен (POST /query) і answer поки не мають методу: викликайте їх через HTTP.

Помилки

Кожна помилка викидає ConareError з status, code, message і requestId.

import { ConareError } from "conare";

try {
  await docs.add({ text: "" });
} catch (err) {
  if (err instanceof ConareError) console.log(err.status, err.code); // 400 "invalid_request"
}

Випадок	Поведінка
Немає відповіді	`status` дорівнює `0`, `code` — `timeout` або `connection_error`
`429`, `5xx`, мережеві помилки	Повторюються до `maxRetries` разів, після `Retry-After` або затримки
Записи	Містять `Idempotency-Key`, тож повтор ніколи не записує двічі