SDK de TypeScript - Conare

conare envuelve la API para Node 18 o posterior y Bun, sin dependencias.

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": {}
  }
]

Los campos de la respuesta están en camelCase, y las marcas de tiempo son Date.

Opciones

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
});

Cada método acepta también { signal, timeout, idempotencyKey } como último argumento.

Métodos

Método	Devuelve
`conare.namespace(name)`	Un manejador de namespace; no se envía nada hasta que llamas a un método
`conare.namespaces({ prefix })`	`[{ name, documents, embeddingModel, rerankModel }]`
`ns.add(docs)`	Los ids
`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, ... })`	Un iterador asíncrono de páginas
`ns.get(id)`	El documento, o `null`
`ns.list({ limit })`	Un iterador asíncrono sobre todos los documentos
`ns.delete(id)`	Nada
`ns.deleteMany(ids)`, `ns.deleteWhere(filter)`	Cuántos se eliminaron
`ns.create({ embeddingModel })`	`{ embeddingModel }`
`ns.drop({ force })`	`{ sourcesDeleted }`
`ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })`	La subida y, una vez `ready`, su Markdown
`ns.getFile(fileId, { user })`	La última subida del archivo
`conare.parse(file or { url }, { name, type, pages, password, layout, wait })`	El Markdown del archivo, sin almacenar nada
`conare.getParse(id)`	Un análisis que respondió `parsing`
`conare.embed(texts, { type, outputDtype })`	Los vectores; con `int8`, `{ values, scales }` (`dequantize` los revierte)
`conare.rerank(query, documents, { topK })`	`[{ index, score, document }]`, con `unscored`
`conare.sources`	`connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types`
`conare.organizations()`	Las organizaciones en cuyo nombre actúa la clave
`conare.users.delete(user)`, `deletePrefix(prefix)`	La ejecución que elimina los datos de un usuario
`conare.events.list({ cursor, types })`	Qué cambió, en orden

add y write aceptan un documento o un array de cualquier tamaño, y envían 100 a la vez.
La búsqueda en todos los namespaces (POST /query) y answer aún no tienen método: llámalos por HTTP.

Errores

Cada fallo lanza un ConareError con status, code, message y 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"
}

Caso	Comportamiento
Sin respuesta	`status` es `0`, `code` es `timeout` o `connection_error`
`429`, `5xx`, errores de red	Se reintentan hasta `maxRetries` veces, tras `Retry-After` o un backoff
Escrituras	Llevan una `Idempotency-Key`, así que un reintento nunca escribe dos veces