infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

Chiusa

#4310 aperta il 31 dic 2024

Vedi su GitHub
 (13 commenti) (0 reazioni) (1 assegnatario)Python (9194 fork)batch import
good first issue

Metriche repository

Star
 (80.527 stelle)
Metriche merge PR
 (Merge medio 3g 1h) (600 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Crea script di esempio nella directory 'examples' del repository: uno per l'uso dell'SDK Python (example/sdk) e uno per l'API HTTP con cURL (example/http). Fai riferimento alla documentazione API esistente per illustrare flussi di lavoro tipici come il caricamento di documenti, la ricerca e il recupero. Assicurati che gli esempi siano eseguibili e includano commenti.
Tech stack
python
Dominio
backendapideveloper experiencedocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythoncURL
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85