infiniflow/ragflow

[Feature Request]: Examples on RAGFlow API

Fechada

#4.310 aberto em 31 de dez. de 2024

Ver no GitHub
 (13 comentários) (0 reação) (1 responsável)Python (9.194 forks)batch import
good first issue

Métricas do repositório

Stars
 (80.527 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 1h) (600 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Crie scripts de exemplo no diretório 'examples' do repositório: um para uso do SDK Python (example/sdk) e um para a API HTTP com cURL (example/http). Consulte a documentação da API existente para ilustrar fluxos de trabalho típicos, como upload de documentos, pesquisa e recuperação. Certifique se de que os exemplos sejam executáveis e incluam comentários.
Pilha de tecnologia
python
Domain
backendapideveloper experiencedocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythoncURL
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85