SDK TypeScript - Conare

conare incapsula l’API per Node 18 o successivo e Bun, senza dipendenze.

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

I campi delle risposte sono in camelCase, e i timestamp sono Date.

Opzioni

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

Ogni metodo accetta anche { signal, timeout, idempotencyKey } come ultimo argomento.

Metodi

Metodo	Restituisce
`conare.namespace(name)`	Un handle del namespace; nulla viene inviato finché non chiami un metodo
`conare.namespaces({ prefix })`	`[{ name, documents, embeddingModel, rerankModel }]`
`ns.add(docs)`	Gli id
`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 iteratore asincrono di pagine
`ns.get(id)`	Il documento, oppure `null`
`ns.list({ limit })`	Un iteratore asincrono su tutti i documenti
`ns.delete(id)`	Nulla
`ns.deleteMany(ids)`, `ns.deleteWhere(filter)`	Quanti ne sono stati eliminati
`ns.create({ embeddingModel })`	`{ embeddingModel }`
`ns.drop({ force })`	`{ sourcesDeleted }`
`ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })`	Il caricamento e, una volta `ready`, il suo Markdown
`ns.getFile(fileId, { user })`	L’ultimo caricamento del file
`conare.parse(file or { url }, { name, type, pages, password, layout, wait })`	Il Markdown del file, senza salvare nulla
`conare.getParse(id)`	Un parse che ha risposto `parsing`
`conare.embed(texts, { type, outputDtype })`	I vettori; con `int8`, `{ values, scales }` (`dequantize` li riconverte)
`conare.rerank(query, documents, { topK })`	`[{ index, score, document }]`, con `unscored`
`conare.sources`	`connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types`
`conare.organizations()`	Le organizzazioni per cui agisce la chiave
`conare.users.delete(user)`, `deletePrefix(prefix)`	L’esecuzione che elimina i dati di un utente
`conare.events.list({ cursor, types })`	Cosa è cambiato, in ordine

add e write accettano un documento o un array di qualsiasi dimensione, e ne inviano 100 alla volta.
La ricerca in tutti i namespace (POST /query) e answer non hanno ancora un metodo: chiamali via HTTP.

Errori

Ogni errore lancia un ConareError con status, code, message e 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	Comportamento
Nessuna risposta	`status` è `0`, `code` è `timeout` o `connection_error`
`429`, `5xx`, errori di rete	Ritentati fino a `maxRetries` volte, dopo `Retry-After` o un backoff
Scritture	Includono un `Idempotency-Key`, quindi un nuovo tentativo non scrive mai due volte