search

deepset-ai / hayhooks

Deploy Haystack pipelines behind a REST Api.
https://haystack.deepset.ai
Apache License 2.0
30 stars 8 forks source link

Enhance `/` endpoint #5

Closed srini047 closed 2 months ago

srini047 commented 3 months ago

Currently if the server starts I go to http://localhost:1416/ which is the root of the server. But I get a empty response, which seems unsatisfying. Instead better to have a message to showcase.

Modifications to be done here: https://github.com/deepset-ai/hayhooks/blob/ee9150c2711e3c088306be65b96dbdb0d31066da/src/hayhooks/server/app.py#L37

I would like to take up this issue if that's fine.

masci commented 2 months ago

Hi @srini047 what info would you expect to see? Let's agree on what to show and I'll be happy to review a PR if you want to contribute the feature!

srini047 commented 2 months ago

Sure @masci Atleast a very basic response:

{
  "message": "Sever is running"
}

Or something similar to the Github API. For Haystack equivalent:

{
  "haystack_swagger_ui": "http://localhost:1416/docs",
  "haystack_deploy": "http://localhost:1416/deploy",
  "haystack_pipleine": "http://localhost:1416/pipeline",
}

Something like this. Which one do you prefer @masci?

masci commented 2 months ago

@srini047 the first one is very similar to the /status endpoint, so I'd go with the second, a "summary" of the available endpoints might be helpful indeed