Developing another user interface for integration with Ragflow.

[Gude-asefa]

I'm planning to create a user interface that integrates with Ragflow, and I'd like to know what kind of APIs and features are available for this integration. Specifically, I want to include functionalities like:

File Upload: Allowing users to upload various types of documents.

Citation Management: Displaying citations linked to specific parts of a file.

Source File Display: Showing the file or document from which a citation was taken.

Role and Access Management: Managing user roles and restricting access to files based on these roles.

Is there a way to implement these features using Ragflow, and if so, is there any demo or example available that showcases this type of functionality ?

[dosubot[bot]]

Hi @Gude-asefa! I'm Dosu and I’m helping the ragflow team.

Ragflow provides a set of backend APIs and frontend components you can use to build a UI with the features you described:

• For file upload, use the /upload and /upload_and_parse POST endpoints to upload documents to a knowledge base, with user authorization checks. There’s also a flexible file uploader component in the frontend (web/src/components/file-uploader.tsx) that supports drag-and-drop, multiple files, and size limits, and recent updates allow uploads via dialog without binding to a dataset (source, more, more).

• For citation management, Ragflow manages documents in "chunks" (segments), each with metadata like keywords, positions, and IDs. The /chunk/list and related chunk endpoints let you retrieve and display these segments, which you can use to link citations to specific parts of a file (source).

• For source file display, use the /get/<doc_id> endpoint to fetch the original document or file content by ID, with correct content-type headers for rendering or download (source).

• For role and access management, Ragflow enforces authorization at the API level using user roles (OWNER, NORMAL, INVITE) and tenant-based access. Endpoints for user and tenant management are in api/apps/tenant_app.py, supporting user listing, role assignment, and access checks (source).

There isn’t a single demo or example project that showcases all these features together, but the codebase contains the necessary APIs and frontend components to implement them. You’ll need to combine these endpoints and UI elements in your own interface. If you need more details on specific endpoints or integration patterns, let me know!

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[Magicbook1108]

Documents for apis here: https://ragflow.io/docs/http_api_reference