Basic Information

• Used with the following retrievers:
  • OpenSearchBM25Retriever
  • OpenSearchEmbeddingRetriever
• Type: haystack_integrations.document_stores.opensearch.document_store.OpenSearchDocumentStore

Overview

For details on how this document store works, see OpenSearchDocumentStore in the Haystack documentation.

Authorization

This is the core document store of deepset Cloud and as such, we handle the authorization.

Usage

For instructions on how to create a secret to connect to the document store, write documents, and then retrieve them, see Connect to external database.

Example Configuration

In an Indexing Pipeline

To write the preprocesses files into the document store:

1. Add DocumentWriter to your pipeline.
2. On the component card, click Configure under the document_store parameters. This opens a YAML editor.

In a Query Pipeline

To retrieve files from the document store:

1. Add an OpenSearch retriever to your pipeline.
2. On the retriever's card, click Configure under the document_store parameter. This opens a YAML editor.

This is an example of how to configure the OpenSearchDocumentStore. To access the configuration:

1. Add an OpenSearch retriever to your pipeline.
2. On the retriever's card, click Configure under the document_store parameter. This opens a YAML editor.

Example

This is where you can access the configuration:

This is a YAML example of the OpenSearch document store configuration:

type: haystack_integrations.document_stores.opensearch.document_store.OpenSearchDocumentStore
init_parameters:
  use_ssl: true
  verify_certs: false
  hosts:
    - ${OPENSEARCH_HOST}
  http_auth:
    - ${OPENSEARCH_USER}
    - ${OPENSEARCH_PASSWORD}
  embedding_dim: 768
  similarity: cosine

Init Parameters

For a list of parameters you can configure, see OpenSearchDocumentStore API reference in Haystack documentation.