infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

Geschlossen

#4.310 geöffnet am 31.12.2024

Auf GitHub ansehen
 (13 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (9.194 Forks)batch import
good first issue

Repository-Metriken

Stars
 (80.527 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 1h) (600 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Erstelle Beispielskripte im 'examples' Verzeichnis des Repositorys: eines für die Python SDK Nutzung (example/sdk) und eines für die HTTP API mit cURL (example/http). Verweise auf die vorhandene API Dokumentation, um typische Arbeitsabläufe wie Dokumentenupload, Suche und Abruf zu veranschaulichen. Stelle sicher, dass die Beispiele ausführbar sind und Kommentare enthalten.
Tech Stack
python
Domain
backendapideveloper experiencedocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythoncURL
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85