Haystack Annotation tool API to fetch file

[i-Anshal]

Do we have any method to get the exported data in a haystack using API don't want to export it locally I want to export it using API is there any way to do it to get the file as a response data

[bilgeyucel]

Hey @i-Anshal, unfortunately, exporting data using API is not possible. You can only export data locally in different formats (excel, CSV, squad).

[OwaisAzad]

@i-Anshal @bilgeyucel Yes, Haystack provides an API endpoint that allows you to export the search results in various formats such as JSON, CSV, or TSV. You can use this API endpoint to get the exported data as a response data.

To use this endpoint, you need to make a GET request to the /api/export/ endpoint with the required parameters. The parameters you need to include depend on the type of export you want to perform.

Export of search results using the Haystack API in Python:

import requests

# define the search query
params = {
    "query": "your search query",
    "filters": {}  # add any filters you need
}

# make a GET request to the export endpoint
response = requests.get("http://your-haystack-server.com/api/export/?format=json", params=params)

# get the exported data from the response content
exported_data = response.content

• JSON export of search results using the format=json parameter.

• Replace your-haystack-server.com with the hostname of your Haystack server.

• Also need to provide the search query and any filters you need as parameters in the params dictionary.

• Once you make the request, you can get the exported data from the response content. Depending on the size of the exported
  data, you may need to use a streaming parser to avoid running out of memory.

[bilgeyucel]

Hey @OwaisAzad, are you sure you're talking about the right Haystack Annotation Tool: https://annotate.deepset.ai/? The Annotation Tool doesn't provide any API key, or Haystack as a framework doesn't provide any admin interface.

[OwaisAzad]

Ooh! Thank you for bringing this to my attention, @bilgeyucel . @i-Anshal , I apologize for any confusion that my suggestion may have caused.
Upon further research https://docs.haystack.deepset.ai/docs/rest_api

[i-Anshal]

@bilgeyucel @OwaisAzad
I am talking about the local version of haystack annotation tool which I can run using docker image on my server and there is no function like api key in admin account

[bilgeyucel]

Hey @i-Anshal, the annotation tool is not meant to use through APIs with an API key. Therefore, there's no support for this and there's no documentation :/
and @OwaisAzad, the API documentation you shared is for Haystack when it's used through RESTful API. It doesn't document the annotation tool
I hope this helps clear up your questions 🙌

[OwaisAzad]

Thanks again @bilgeyucel . @i-Anshal In my opinion, @bilgeyucel can guide you better than I as she is a contributor to Haystack Annotation Tool. So, if she says no API supported, it means no option. I'm sorry bro. :(