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.
You will need hatch
to work on or create new integrations. Run pip install hatch
to install it.
All the integrations are self contained, so the first step before working on one is to cd
into the proper folder.
For example, to work on the Chroma Document Store, from the root of the repo:
$ cd integrations/chroma
From there, you can run the tests with hatch
, that will take care of setting up an isolated Python environment:
hatch run test
Similarly, to run the linters:
hatch run lint:all
Core integrations follow the naming convention
PREFIX-haystack
, wherePREFIX
can be the name of the technology you're integrating Haystack with. For example, a deepset integration would be named asdeepset-haystack
.
To create a new integration, from the root of the repo change directory into integrations
:
cd integrations
From there, use hatch
to create the scaffold of the new integration:
$ hatch --config hatch.toml new -i
Project name: deepset-haystack
Description []: An example integration, this text can be edited later
deepset-haystack
├── src
│ └── deepset_haystack
│ ├── __about__.py
│ └── __init__.py
├── tests
│ └── __init__.py
├── LICENSE.txt
├── README.md
└── pyproject.toml
Package | Type | PyPi Package | Status |
---|---|---|---|
astra-haystack | Document Store | ||
amazon-bedrock-haystack | Generator | ||
chroma-haystack | Document Store | ||
cohere-haystack | Embedder, Generator | ||
elasticsearch-haystack | Document Store | ||
google-ai-haystack | Generator | ||
google-vertex-haystack | Generator | ||
gradient-haystack | Embedder, Generator | ||
instructor-embedders-haystack | Embedder | ||
jina-haystack | Embedder | ||
llama-cpp-haystack | Generator | ||
ollama-haystack | Generator | ||
opensearch-haystack | Document Store | ||
pinecone-haystack | Document Store | ||
pgvector-haystack | Document Store | ||
qdrant-haystack | Document Store | ||
unstructured-fileconverter-haystack | File converter | ||
uptrain-haystack | Evaluator | ||
amazon-sagemaker-haystack | Generator |