infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

Fermée

#4 310 ouverte le 31 déc. 2024

Voir sur GitHub
 (13 commentaires) (0 réaction) (1 personne assignée)Python (9 194 forks)batch import
good first issue

Métriques du dépôt

Stars
 (80 527 étoiles)
Métriques de merge PR
 (Merge moyen 3j 1h) (600 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Créez des scripts d'exemple dans le répertoire 'examples' du dépôt : un pour l'utilisation du SDK Python (example/sdk) et un pour l'API HTTP avec cURL (example/http). Référez vous à la documentation API existante pour illustrer des workflows typiques comme le téléchargement de documents, la recherche et la récupération. Assurez vous que les exemples sont exécutables et incluent des commentaires.
Stack technique
python
Domaine
backendapideveloper experiencedocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythoncURL
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85