Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RAG Example for using REST API in 2.0 #5991

Closed
Timoeller opened this issue Oct 6, 2023 · 4 comments
Closed

RAG Example for using REST API in 2.0 #5991

Timoeller opened this issue Oct 6, 2023 · 4 comments
Assignees
Labels
2.x Related to Haystack v2.0 P1 High priority, add to the next sprint topic:rest_api type:documentation Improvements on the docs
Milestone

Comments

@Timoeller
Copy link
Contributor

Timoeller commented Oct 6, 2023

Is your feature request related to a problem? Please describe.
We want an example of a RAG pipeline + file upload through our REST API.
Making the the app work async (async pipeline + fastAPI) would be the cherry on top of our juicy haystack 2.0 cake.

Since we need updated docker images for starting the REST API, this issue is related to #5990

Describe the solution you'd like
Ideally, we use the existing REST API and just create documentation around it.
See how the indexing pipeline is used we might need a few parameter changes.
Also, the pipeline usage in our search endpoint seems reasonably generic.

@Timoeller Timoeller added 2.x Related to Haystack v2.0 topic:rest_api type:documentation Improvements on the docs labels Oct 6, 2023
@Timoeller Timoeller added this to the 2.0-beta milestone Oct 6, 2023
@Timoeller Timoeller added the P1 High priority, add to the next sprint label Oct 12, 2023
@anakin87
Copy link
Member

To start, we can simplify the scope of this activity.

I will try to put myself in the shoes of a user who has tried Haystack and wants to start building a real application with it.
I already have some sort of indexing and RAG pipeline.
I want to create an API with two endpoints: uploading/indexing and querying.

The output of this initial activity can consist of:

  • a simple page documentation page (with copyable code)
  • a demo project/repo with an API example

@r4881t
Copy link

r4881t commented Nov 9, 2023

Would be useful. I just made this app and its services. If it's any help, here's how my stack looks like

  1. Using fastapi to create web server
  2. Using sqlalchemy to log the user's query, answer, debug info and other stuff

I may not be able to create a complete example, but if there's a wip, I can contribute to it.

@dfokina dfokina assigned dfokina and agnieszka-m and unassigned dfokina Nov 27, 2023
@agnieszka-m agnieszka-m assigned dfokina and unassigned agnieszka-m Dec 4, 2023
@anakin87
Copy link
Member

anakin87 commented Dec 4, 2023

TO DO:

@anakin87 anakin87 removed their assignment Dec 6, 2023
@masci
Copy link
Contributor

masci commented Dec 19, 2023

Closing as we agreed it's not going to be docs, to be decided whether it's an article or a tutorial. Comprehensive docs about how to deploy pipelines will follow in 2.0

@masci masci closed this as completed Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Related to Haystack v2.0 P1 High priority, add to the next sprint topic:rest_api type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

6 participants