TypeScript SDK for RAGFlow API
npm install ragflow-typescript-sdkA TypeScript SDK for RAGFlow API - providing easy access to RAGFlow's retrieval-augmented generation capabilities.
- 🚀 Full TypeScript support with type definitions
- 📦 Modern ES modules and CommonJS compatibility
- 🔧 Easy-to-use API client
- 📖 Comprehensive documentation
``bash`
npm install ragflowor
yarn add ragflowor
bun add ragflow
`typescript
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);
}
}
`
To install dependencies:
`bash`
bun install
To build the project:
`bash`
bun run build
To run in development mode:
`bash`
bun run dev
To run the built version:
`bash`
bun run start
- build - Compile TypeScript to JavaScriptstart
- - Run the compiled JavaScriptdev
- - Run in development mode with ts-nodelint
- - Run ESLinttest` - Run tests (placeholder)
-
MIT © Cuong Pham
Contributions are welcome! Please feel free to submit a Pull Request.