This repository contains integrations to extend the capabilities of Haystack. The code in this repo is maintained by deepset, see each integration's README file for details around installation, usage and support.
You will need hatch to work on or create new integrations, open this link and follow the install instructions for your operating system and platform.
All the integrations are self contained, so the first step before working on one is to cd into the proper folder. For example, to run the tests suite for the Chroma document store, from the root of the repo:
$ cd integrations/chroma
$ hatch run testHatch will take care of setting up an isolated Python environment and run the tests.
Please check out our Contribution Guidelines for all the details.
Note
Only maintainers can release new versions of integrations. If you're a community contributor and want to release a new version of an integration, reach out to a maintainer.
To release a new version of an integration to PyPI tag the commit with the right version number and push the tag to . The Actions workflow will take care of the rest.
Tag the commit with the right version number
The tag needs to have the following format:
git tag integrations/<INTEGRATION_FOLDER_NAME>-<version>For example, if we want to release version 1.0.99 of the google-vertex-haystack integration we'd have to push the tag:
git tag integrations/google_vertex-v1.0.99Push the tag to
git push --tags originWait for the CI to do its magic
Review the changelog PR
If the release is successful, the HaystackBot will open a pull request to generate the changelog. Add yourself as the reviewer. If there are any issues, edit the changelog manually.
Important
To ensure the changelog is accurate, it's recommended to tag a commit that includes the actual changes for the integration (usually the PR merge commit). Tagging a commit that doesn't contain those changes can lead to an incorrect changelog.