SDKs

SDKs oficiales

Clientes Python y TypeScript tipados para la API de Claix, más tools para LangChain, LangGraph, CrewAI y LlamaIndex.

TypeScript SDK

Cliente oficial de Claix en TypeScript

Endpoint

NPMnpm install claix-ai

El paquete npm claix-ai expone ClaixClient, el mismo mapa de llamadas que el SDK de Python: extracción, schemas, ventana de contexto y espacios de conocimiento. El cliente es async (Node.js 18+).

Las tools de CrewAI en TypeScript usan @crewai-ts/core (claix-ai/crewai). El runtime oficial de CrewAI en Python sigue en pip install 'claix-ai[crewai]'.

1. Instalación

npm install claix-ai
npm install claix-ai @langchain/core zod
npm install claix-ai @crewai-ts/core
npm install claix-ai llamaindex

La API key va en CLAIX_API_KEY o en el constructor (apiKey). El cliente envía x-api-key.

2. Inicio rápido

import { ClaixClient } from "claix-ai";

const client = new ClaixClient();
const result = await client.extract.pdf("invoice.pdf", "3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f");
const answers = await client.context.ask(String(result.document_id), [
  { question: "What is the total?", format: "int" },
]);

3. Mapa de métodos

MétodoHTTP
client.extract.pdf / excel / document / image / audio / textPOST /api/*-json o POST /agent/*-json
client.extract.jsonToExcel({ schemaId, data })POST /api/json-excel
client.context.get / ask / deleteGET /get-document, POST /document-context, DELETE /delete-document
client.context.replace(documentId, newContentDocumentId)POST /replace-document
client.spaces.create / add / ask / removeDocument / deletecreate-space, add-space, space-context, remove-document-from-space, delete-space
client.schemas.list / get / create / update / deleteGET /api/schemas, GET /api/get-schema, POST /api/create-schema, PUT /api/update-schema, POST /api/delete-schema

Una pregunta string se envía como format "string". También puedes pasar { question, format } con string, int, boolean, timestamp o array.

Ejemplos de petición

import { ClaixClient } from "claix-ai";

const client = new ClaixClient();
const result = await client.extract.pdf("invoice.pdf", "3c7a9f21-4b8e-4d1a-9c6f-2e0d8a5b7c4f");
console.log(result.data);