Haystack docs home page

DocumentStores

You can think of the DocumentStore as a "database" that:

  • stores your texts and meta data
  • provides them to the retriever at query time

There are different DocumentStores in Haystack to fit different use cases and tech stacks.

Initialisation

Initialising a new DocumentStore is straight forward.

Elasticsearch

document_store = ElasticsearchDocumentStore()
# or
document_store = OpenDistroElasticsearchDocumentStore()

FAISS

document_store = FAISSDocumentStore(faiss_index_factory_str="Flat")

In Memory

document_store = InMemoryDocumentStore()

SQL

document_store = SQLDocumentStore()

Each DocumentStore constructor allows for arguments specifying how to connect to existing databases and the names of indexes. See API documentation for more info.

Input Format

DocumentStores expect Documents in dictionary form, like that below. They are loaded using the DocumentStore.write_documents() method. See Preprocessing for more information on the cleaning and splitting steps that will help you maximize Haystack's performance.

document_store = ElasticsearchDocumentStore()
dicts = [
{
'text': DOCUMENT_TEXT_HERE,
'meta': {'name': DOCUMENT_NAME, ...}
}, ...
]
document_store.write_documents(dicts)

Writing Documents (Sparse Retrievers)

Haystack allows for you to write store documents in an optimised fashion so that query times can be kept low. For sparse, keyword based retrievers such as BM25 and TF-IDF, you simply have to call DocumentStore.write_documents(). The creation of the inverted index which optimises querying speed is handled automatically.

document_store.write_documents(dicts)

Writing Documents (Dense Retrievers)

For dense neural network based retrievers like Dense Passage Retrieval, or Embedding Retrieval, indexing involves computing the Document embeddings which will be compared against the Query embedding.

The storing of the text is handled by DocumentStore.write_documents() and the computation of the embeddings is started by DocumentStore.update_embeddings().

document_store.write_documents(dicts)
document_store.update_embeddings(retriever)

This step is computationally intensive since it will engage the transformer based encoders. Having GPU acceleration will significantly speed this up.

Choosing the Right Document Store

The Document Stores have different characteristics. You should choose one depending on the maturity of your project, the use case and technical environment:

Elasticsearch

Pros:

  • Fast & accurate sparse retrieval with many tuning options
  • Basic support for dense retrieval
  • Production-ready
  • Support also for Open Distro

Cons:

  • Slow for dense retrieval with more than ~ 1 Mio documents

FAISS

Pros:

  • Fast & accurate dense retrieval
  • Highly scalable due to approximate nearest neighbour algorithms (ANN)
  • Many options to tune dense retrieval via different index types (more info here)

Cons:

  • No efficient sparse retrieval

In Memory

Pros:

  • Simple
  • Exists already in many environments

Cons:

  • Only compatible with minimal TF-IDF Retriever
  • Bad retrieval performance
  • Not recommended for production

SQL

Pros:

  • Simple & fast to test
  • No database requirements
  • Supports MySQL, PostgreSQL and SQLite

Cons:

  • Not scalable
  • Not persisting your data on disk

Our Recommendations

Restricted environment: Use the InMemoryDocumentStore, if you are just giving Haystack a quick try on a small sample and are working in a restricted environment that complicates running Elasticsearch or other databases

Allrounder: Use the ElasticSearchDocumentStore, if you want to evaluate the performance of different retrieval options (dense vs. sparse) and are aiming for a smooth transition from PoC to production

Vector Specialist: Use the FAISSDocumentStore, if you want to focus on dense retrieval and possibly deal with larger datasets