RAGFlow SDK

A TypeScript SDK for RAGFlow API - providing easy access to RAGFlow's retrieval-augmented generation capabilities.

Features

• 🚀 Full TypeScript support with type definitions
• 📦 Modern ES modules and CommonJS compatibility
• 🔧 Easy-to-use API client
• 📖 Comprehensive documentation

Installation

npm install ragflow
# or
yarn add ragflow
# or
bun add ragflow

Quick Start

import { RAGFlow } from 'ragflow';

// Initialize the client
const client = new RAGFlow({
  apiKey: 'your-api-key',
  baseURL: 'https://your-ragflow-instance.com'
});

// Example usage
async function example() {
  try {
    // Your RAGFlow API calls here
    console.log('RAGFlow SDK is ready!');
  } catch (error) {
    console.error('Error:', error);
  }
}

Development

To install dependencies:

bun install

To build the project:

bun run build

To run in development mode:

bun run dev

To run the built version:

bun run start

Scripts

• build - Compile TypeScript to JavaScript
• start - Run the compiled JavaScript
• dev - Run in development mode with ts-node
• lint - Run ESLint
• test - Run tests (placeholder)

License

MIT © Cuong Pham

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.