@qzsy/ragflow-sdk

RagFlow REST API（/api/v1）TypeScript 客户端，对齐 ragflow-mul-tenant。

• 版本：0.8.0
• 环境：Node.js 服务端
• API 文档：docs/api.md

安装

npm install @qzsy/ragflow-sdk

快速开始

import { RagFlowClient } from '@qzsy/ragflow-sdk';

const client = new RagFlowClient({
  baseUrl: 'https://your-ragflow-host',
  apiKey: 'ragflow-your-token',
});

const dataset = await client.datasets.create({
  name: 'my-dataset',
  embedding_model: 'BAAI/bge-m3@provider',
  chunk_method: 'naive',
});

const docs = await client.documents.upload(dataset.id, {
  content: fileBuffer,
  filename: 'doc.pdf',
});

await client.documents.parse(dataset.id, [docs[0].id]);

const result = await client.retrieval.retrieve({
  question: '你的问题',
  dataset_ids: [dataset.id],
});

模块

| 属性 | 说明 | |:--|:--| | datasets | 知识库 CRUD、Tags、元数据 Schema | | documents | 上传、解析、停止、批量 metadata、ingest | | chunks | 分块 CRUD | | retrieval | 检索与 datasets/search | | chat / chatAssistants | OpenAI 补全、助手会话 | | agents | Agent CRUD、对话 | | tenants / projects | 多租户 API |

开发

npm install
npm run build
npm test

变更

见 CHANGELOG.md。

许可

MIT