Haystack 2.x Core Integrations

This repository contains integrations to extend the capabilities of Haystack version 2.0 and onwards. The code in this repo is maintained by deepset, see each integration's README file for details around installation, usage and support.

Quick start

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 test

Hatch will take care of setting up an isolated Python environment and run the tests.

Please check out our Contribution Guidelines for all the details.

Inventory

Package	Type	PyPi Package	Status
amazon-bedrock-haystack	Generator
amazon-sagemaker-haystack	Generator
anthropic-haystack	Generator
astra-haystack	Document Store
chroma-haystack	Document Store
cohere-haystack	Embedder, Generator, Ranker
deepeval-haystack	Evaluator
elasticsearch-haystack	Document Store
fastembed-haystack	Embedder, Ranker
google-ai-haystack	Generator
google-vertex-haystack	Generator
instructor-embedders-haystack	Embedder
jina-haystack	Connector, Embedder, Ranker
langfuse-haystack	Tracer
llama-cpp-haystack	Generator
mistral-haystack	Embedder, Generator
mongodb-atlas-haystack	Document Store
nvidia-haystack	Embedder, Generator, Ranker
ollama-haystack	Embedder, Generator
opensearch-haystack	Document Store
optimum-haystack	Embedder
pinecone-haystack	Document Store
pgvector-haystack	Document Store
qdrant-haystack	Document Store
ragas-haystack	Evaluator
snowflake-haystack	Retriever
unstructured-fileconverter-haystack	File converter
uptrain-haystack	Evaluator		Staged
weaviate-haystack	Document Store

Releasing

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 GitHub. The GitHub Actions workflow will take care of the rest.

1. 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.99
   

2. Push the tag to GitHub

   git push --tags origin
   

3. Wait for the CI to do its magic

Important

When releasing a new integration version, always tag a commit that includes the changes for that integration (usually the PR merge commit). If you tag a commit that doesn't include changes for the integration being released, the generated changelog will be incorrect.