TypeScript SDK

npm install @bigrag/client

import { BigRAG } from "@bigrag/client";

const client = new BigRAG({
  apiSecret: "your-api-secret",
  baseUrl: "http://localhost:6100",
});

// Create a collection
const collection = await client.createCollection({
  name: "knowledge_base",
  description: "Company docs",
  chunk_size: 512,
});

// Upload a document
const doc = await client.uploadDocument("knowledge_base", file);

// Stream processing progress
for await (const event of client.streamDocumentProgress("knowledge_base", doc.id)) {
  console.log(event.step, event.progress);
  if (event.status === "complete") break;
}

// Query
const { results } = await client.query("knowledge_base", {
  query: "What is the PTO policy?",
  top_k: 5,
});

client.listCollections({ name?, limit?, offset? })
client.createCollection({
  name, description?, embedding_provider?, embedding_model?,
  dimension?, chunk_size?, chunk_overlap?
})
client.getCollection(name)
client.getCollectionStats(name)
client.updateCollection(name, { description?, metadata? })
client.deleteCollection(name)

client.uploadDocument(collection, file, metadata?)
client.batchUploadDocuments(collection, files, metadata?)
client.listDocuments(collection, { status?, limit?, offset? })
client.getDocument(collection, documentId)
client.deleteDocument(collection, documentId)
client.batchGetStatus(collection, documentIds)
client.batchGetDocuments(collection, documentIds)
client.batchDeleteDocuments(collection, documentIds)
client.reprocessDocument(collection, documentId)
client.getDocumentChunks(collection, documentId)
client.getDocumentFileUrl(collection, documentId)  // returns URL string
client.streamDocumentProgress(collection, documentId)  // returns AsyncIterable

client.query(collection, {
  query, top_k?, filters?, min_score?, search_mode?, rerank?
})
client.multiQuery({
  query, collections, top_k?, filters?, min_score?, search_mode?, rerank?
})
client.batchQuery({
  queries: [{ collection, query, top_k?, search_mode? }, ...]
})
client.upsertVectors(collection, vectors)
client.deleteVectors(collection, ids)
client.listEmbeddingModels()
client.getStats()

client.getAnalytics(collection)

const docs = client.collection("knowledge_base");
await docs.query({ query: "PTO policy", top_k: 5 });
await docs.upload(file);
await docs.batchUpload([file1, file2, file3]);
await docs.batchGetStatus(["doc-id-1", "doc-id-2"]);
await docs.batchGetDocuments(["doc-id-1", "doc-id-2"]);
await docs.batchDelete(["doc-id-1", "doc-id-2"]);
await docs.stats();
await docs.analytics();

client.createWebhook({ url, events, collections?, description? })
client.listWebhooks()
client.getWebhook(id)
client.updateWebhook(id, { url?, events?, collections?, description?, active? })
client.deleteWebhook(id)
client.listWebhookDeliveries(id, { limit?, offset? })
client.testWebhook(id)

import {
  BigRAG,
  AuthenticationError,
  NotFoundError,
  APIError,
} from "@bigrag/client";

try {
  await client.getCollection("missing");
} catch (err) {
  if (err instanceof NotFoundError) {
    // 404
  } else if (err instanceof AuthenticationError) {
    // 401
  } else if (err instanceof APIError) {
    // any other API error — check err.status
  }
}