infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

已关闭

#4,310 创建于 2024年12月31日

在 GitHub 查看
 (13 条评论) (0 个反应) (1 位负责人)Python (9,194 个派生)batch import
good first issue

仓库指标

星标
 (80,527 个星标)
PR 合并指标
 (平均合并 3天 1小时) (30 天内合并 600 个 PR)

描述

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

贡献者指南

研究方向
在仓库的 'examples' 目录中创建示例脚本：一个用于 Python SDK 使用（example/sdk），一个用于通过 cURL 调用 HTTP API（example/http）。参考现有 API 文档，展示典型工作流程，如文档上传、搜索和检索。确保示例可运行并包含注释。
技术栈
python
领域
backendapideveloper experiencedocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythoncURL
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85