infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

Closed

#4,310 opened on Dec 31, 2024

View on GitHub
 (13 comments) (0 reactions) (1 assignee)Python (9,194 forks)batch import
good first issue

Repository metrics

Stars
 (80,527 stars)
PR merge metrics
 (Avg merge 3d 1h) (600 merged PRs in 30d)

Description

Is there an existing issue for the same feature request?

  • I have checked the existing issues.

Describe the feature you'd like

Although there is already documentation for the RAGFlow API, it would be easier for developers to use if specific examples were provided. This issue proposes creating examples for the RAGFlow SDK, and accessing HTTP interfaces with cURL.

Python SDK example: example/sdk HTTP API with cURL: example/http

Contributor guide

Research direction
Create example scripts in the 'examples' directory of the repo: one for Python SDK usage (example/sdk) and one for HTTP API with cURL (example/http). Refer to existing API docs to illustrate typical workflows like document upload, search, and retrieval. Ensure examples are runnable and include comments.
Tech stack
python
Domain
backendapideveloper experiencedocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythoncURL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85