RAGFlow Async SDK

Overview

An async-first Python SDK for interacting with the RAGFlow API.

Provides clean, typed, and production-ready access to RAGFlow features such as:

• Dataset & document management
• Document chunking & ingestion
• File & folder management
• Knowledge Graph (GraphRAG)
• Background tasks (parsing, knowledge construction)
• Chat & Agent sessions with streaming (SSE) support

⚡ Quick Start

💿 Installation

Requires Python 3.10+.

pip install ragflow-async-sdk

🚀 Getting Started

All operations in the RAGFlow SDK are asynchronous. To use the SDK, first initialize the client and then run async calls inside Python's asyncio event loop.

🛠 Initialization

from ragflow_async_sdk import AsyncRAGFlowClient

client = AsyncRAGFlowClient(
    server_url="http://your-ragflow-address",
    api_key="YOUR_API_KEY",
)

⏩ Run with asyncio

import asyncio

async def main():
    # Example: Health check
    system_health = await client.systems.healthz()
    print(system_health.status)

# Run the async main function
asyncio.run(main())

Notes:

All SDK calls are async; use await and async for as needed.

📚 Documentation

📝 User Guide

⚡ FastAPI Integration

• FastAPI Usage Examples

🧩 Main Modules

• Datasets
• Documents
• Chunks
• Chat Assistants
• Agents
• Files
• System

📖 Full API Reference

• API Reference

💡 Error Reference

• Error Reference

🧬 Entities Reference

• Entities Reference

🧪 Testing

• Testing Guide

License

Apache License 2.0