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 合併指標
 (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