Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 11.9 KB

README.md

File metadata and controls

83 lines (64 loc) · 11.9 KB

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.

Contributing

You will need hatch to work on or create new integrations. Run pip install hatch to install it.

Local development

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

Create a new integration

Core integrations follow the naming convention PREFIX-haystack, where PREFIX can be the name of the technology you're integrating Haystack with. For example, a deepset integration would be named as deepset-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

Inventory

Package Type PyPi Package Status
astra-haystack Document Store PyPI - Version Test / astra
amazon-bedrock-haystack Generator PyPI - Version Test / amazon_bedrock
chroma-haystack Document Store PyPI - Version Test / chroma
cohere-haystack Embedder, Generator PyPI - Version Test / cohere
elasticsearch-haystack Document Store PyPI - Version Test / elasticsearch
google-ai-haystack Generator PyPI - Version Test / google-ai
google-vertex-haystack Generator PyPI - Version Test / google-vertex
gradient-haystack Embedder, Generator PyPI - Version Test / gradient
instructor-embedders-haystack Embedder PyPI - Version Test / instructor-embedders
jina-haystack Embedder PyPI - Version Test / jina
llama-cpp-haystack Generator PyPI - Version Test / llama-cpp
ollama-haystack Generator PyPI - Version Test / ollama
opensearch-haystack Document Store PyPI - Version Test / opensearch
pinecone-haystack Document Store PyPI - Version Test / pinecone
pgvector-haystack Document Store PyPI - Version Test / pgvector
qdrant-haystack Document Store PyPI - Version Test / qdrant
unstructured-fileconverter-haystack File converter PyPI - Version Test / unstructured
uptrain-haystack Evaluator PyPI - Version Test / uptrain
amazon-sagemaker-haystack Generator PyPI - Version Test / amazon_sagemaker