ElasticsearchStore#

class langchain_elasticsearch.vectorstores.ElasticsearchStore(index_name: str, *, embedding: ~langchain_core.embeddings.embeddings.Embeddings | None = None, es_connection: ~elasticsearch.Elasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None = None, strategy: ~langchain_elasticsearch.vectorstores.BaseRetrievalStrategy | ~elasticsearch.helpers.vectorstore._sync.strategies.RetrievalStrategy = <langchain_elasticsearch.vectorstores.ApproxRetrievalStrategy object>, es_params: ~typing.Dict[str, ~typing.Any] | None = None)[source]#

Elasticsearch vector store.

Setup:

Install langchain_elasticsearch and running the Elasticsearch docker container.

pip install -qU langchain_elasticsearch
docker run -p 9200:9200               -e "discovery.type=single-node"               -e "xpack.security.enabled=false"               -e "xpack.security.http.ssl.enabled=false"               docker.elastic.co/elasticsearch/elasticsearch:8.12.1

Key init args — indexing params:

index_name: str: Name of the index to create.
embedding: Embeddings: Embedding function to use.

Key init args — client params:

es_connection: Optional[Elasticsearch]: Pre-existing Elasticsearch connection.
es_url: Optional[str]: URL of the Elasticsearch instance to connect to.
es_cloud_id: Optional[str]: Cloud ID of the Elasticsearch instance to connect to.
es_user: Optional[str]: Username to use when connecting to Elasticsearch.
es_password: Optional[str]: Password to use when connecting to Elasticsearch.
es_api_key: Optional[str]: API key to use when connecting to Elasticsearch.

Instantiate:

from langchain_elasticsearch import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

vector_store = ElasticsearchStore(
    index_name="langchain-demo",
    embedding=OpenAIEmbeddings(),
    es_url="http://localhost:9200",
)

If you want to use a cloud hosted Elasticsearch instance, you can pass in the cloud_id argument instead of the es_url argument.

Instantiate from cloud:

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

store = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_cloud_id="<cloud_id>"
    es_user="elastic",
    es_password="<password>"
)

You can also connect to an existing Elasticsearch instance by passing in a pre-existing Elasticsearch connection via the es_connection argument.

Instantiate from existing connection:

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

from elasticsearch import Elasticsearch

es_connection = Elasticsearch("http://localhost:9200")

store = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_connection=es_connection
)

Add Documents:

from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"baz": "bar"})
document_2 = Document(page_content="thud", metadata={"bar": "baz"})
document_3 = Document(page_content="i will be deleted :(")

documents = [document_1, document_2, document_3]
ids = ["1", "2", "3"]
vector_store.add_documents(documents=documents, ids=ids)

Delete Documents:

vector_store.delete(ids=["3"])

Search:

results = vector_store.similarity_search(query="thud",k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'bar': 'baz'}]

Search with filter:

results = vector_store.similarity_search(query="thud",k=1,filter=[{"term": {"metadata.bar.keyword": "baz"}}])
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'bar': 'baz'}]

Search with score:

results = vector_store.similarity_search_with_score(query="qux",k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.916092] foo [{'baz': 'bar'}]

Async:

# add documents
# await vector_store.aadd_documents(documents=documents, ids=ids)

# delete documents
# await vector_store.adelete(ids=["3"])

# search
# results = vector_store.asimilarity_search(query="thud",k=1)

# search with score
results = await vector_store.asimilarity_search_with_score(query="qux",k=1)
for doc,score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.916092] foo [{'baz': 'bar'}]

Use as Retriever:

pip install "elasticsearch[vectorstore_mmr]"

retriever = vector_store.as_retriever(
    search_type="mmr",
    search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
)
retriever.invoke("thud")

[Document(metadata={'bar': 'baz'}, page_content='thud')]

Advanced Uses:

ElasticsearchStore by default uses the ApproxRetrievalStrategy, which uses the HNSW algorithm to perform approximate nearest neighbor search. This is the fastest and most memory efficient algorithm.

If you want to use the Brute force / Exact strategy for searching vectors, you can pass in the ExactRetrievalStrategy to the ElasticsearchStore constructor.

Use ExactRetrievalStrategy:

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

store = ElasticsearchStore(
    embedding=OpenAIEmbeddings(),
    index_name="langchain-demo",
    es_url="http://localhost:9200",
    strategy=ElasticsearchStore.ExactRetrievalStrategy()
)

Both strategies require that you know the similarity metric you want to use when creating the index. The default is cosine similarity, but you can also use dot product or euclidean distance.

Use dot product similarity:

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores.utils import DistanceStrategy

store = ElasticsearchStore(
    "langchain-demo",
    embedding=OpenAIEmbeddings(),
    es_url="http://localhost:9200",
    distance_strategy="DOT_PRODUCT"
)

Attributes

embeddings

Access the query embedding object if available.

Methods

`ApproxRetrievalStrategy`([query_model_id, ...])	Used to perform approximate nearest neighbor search using the HNSW algorithm.
`BM25RetrievalStrategy`([k1, b])	Used to apply BM25 without vector search.
`ExactRetrievalStrategy`()	Used to perform brute force / exact nearest neighbor search via script_score.
`SparseVectorRetrievalStrategy`([model_id])	Used to perform sparse vector search via text_expansion.
`__init__`(index_name, *[, embedding, ...])
`aadd_documents`(documents, **kwargs)	Async run more documents through the embeddings and add to the vectorstore.
`aadd_texts`(texts[, metadatas, ids])	Async run more texts through the embeddings and add to the vectorstore.
`add_documents`(documents, **kwargs)	Add or update documents in the vectorstore.
`add_embeddings`(text_embeddings[, metadatas, ...])	Add the given texts and embeddings to the store.
`add_texts`(texts[, metadatas, ids, ...])	Run more texts through the embeddings and add to the store.
`adelete`([ids])	Async delete by vector ID or other criteria.
`afrom_documents`(documents, embedding, **kwargs)	Async return VectorStore initialized from documents and embeddings.
`afrom_texts`(texts, embedding[, metadatas, ids])	Async return VectorStore initialized from texts and embeddings.
`aget_by_ids`(ids, /)	Async get documents by their IDs.
`amax_marginal_relevance_search`(query[, k, ...])	Async return docs selected using the maximal marginal relevance.
`amax_marginal_relevance_search_by_vector`(...)	Async return docs selected using the maximal marginal relevance.
`as_retriever`(**kwargs)	Return VectorStoreRetriever initialized from this VectorStore.
`asearch`(query, search_type, **kwargs)	Async return docs most similar to query using a specified search type.
`asimilarity_search`(query[, k])	Async return docs most similar to query.
`asimilarity_search_by_vector`(embedding[, k])	Async return docs most similar to embedding vector.
`asimilarity_search_with_relevance_scores`(query)	Async return docs and relevance scores in the range [0, 1].
`asimilarity_search_with_score`(args, *kwargs)	Async run similarity search with distance.
`close`()
`connect_to_elasticsearch`(*[, es_url, ...])
`delete`([ids, refresh_indices])	Delete documents from the Elasticsearch index.
`from_documents`(documents[, embedding, ...])	Construct ElasticsearchStore wrapper from documents.
`from_texts`(texts[, embedding, metadatas, ...])	Construct ElasticsearchStore wrapper from raw documents.
`get_by_ids`(ids, /)	Get documents by their IDs.
`max_marginal_relevance_search`(query[, k, ...])	Return docs selected using the maximal marginal relevance.
`max_marginal_relevance_search_by_vector`(...)	Return docs selected using the maximal marginal relevance.
`search`(query, search_type, **kwargs)	Return docs most similar to query using a specified search type.
`similarity_search`(query[, k, fetch_k, ...])	Return Elasticsearch documents most similar to query.
`similarity_search_by_vector`(embedding[, k])	Return docs most similar to embedding vector.
`similarity_search_by_vector_with_relevance_scores`(...)	Return Elasticsearch documents most similar to query, along with scores.
`similarity_search_with_relevance_scores`(query)	Return docs and relevance scores in the range [0, 1].
`similarity_search_with_score`(query[, k, ...])	Return Elasticsearch documents most similar to query, along with scores.

Parameters:

index_name (str)
embedding (Embeddings | None)
es_connection (Elasticsearch | None)
es_url (str | None)
es_cloud_id (str | None)
es_user (str | None)
es_api_key (str | None)
es_password (str | None)
vector_query_field (str)
query_field (str)
distance_strategy (Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None)
strategy (BaseRetrievalStrategy | RetrievalStrategy)
es_params (Dict[str, Any] | None)

static ApproxRetrievalStrategy(query_model_id: str | None = None, hybrid: bool | None = False, rrf: dict | bool | None = True) → ApproxRetrievalStrategy[source]#

Used to perform approximate nearest neighbor search using the HNSW algorithm.

At build index time, this strategy will create a dense vector field in the index and store the embedding vectors in the index.

At query time, the text will either be embedded using the provided embedding function or the query_model_id will be used to embed the text using the model deployed to Elasticsearch.

if query_model_id is used, do not provide an embedding function.

Parameters:

query_model_id (str | None) – Optional. ID of the model to use to embed the query text within the stack. Requires embedding model to be deployed to Elasticsearch.
hybrid (bool | None) – Optional. If True, will perform a hybrid search using both the knn query and a text query. Defaults to False.
rrf (dict | bool | None) –
Optional. rrf is Reciprocal Rank Fusion. When hybrid is True,

and rrf is True, then rrf: {}. and rrf is False, then rrf is omitted. and isinstance(rrf, dict) is True, then pass in the dict values.

rrf could be passed for adjusting ‘rank_constant’ and ‘window_size’.

Return type:

ApproxRetrievalStrategy

static BM25RetrievalStrategy(k1: float | None = None, b: float | None = None) → BM25RetrievalStrategy[source]#

Used to apply BM25 without vector search.

Parameters:

k1 (float | None) – Optional. This corresponds to the BM25 parameter, k1. Default is None, which uses the default setting of Elasticsearch.
b (float | None) – Optional. This corresponds to the BM25 parameter, b. Default is None, which uses the default setting of Elasticsearch.

Return type:

BM25RetrievalStrategy

static ExactRetrievalStrategy() → ExactRetrievalStrategy[source]#

Used to perform brute force / exact nearest neighbor search via script_score.

Return type:: ExactRetrievalStrategy

static SparseVectorRetrievalStrategy(model_id: str | None = None) → SparseRetrievalStrategy[source]#

Used to perform sparse vector search via text_expansion. Used for when you want to use ELSER model to perform document search.

At build index time, this strategy will create a pipeline that will embed the text using the ELSER model and store the resulting tokens in the index.

At query time, the text will be embedded using the ELSER model and the resulting tokens will be used to perform a text_expansion query.

Parameters:: model_id (str | None) – Optional. Default is “.elser_model_1”. ID of the model to use to embed the query text within the stack. Requires embedding model to be deployed to Elasticsearch.
Return type:: SparseRetrievalStrategy

__init__(index_name: str, *, embedding: ~langchain_core.embeddings.embeddings.Embeddings | None = None, es_connection: ~elasticsearch.Elasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, vector_query_field: str = 'vector', query_field: str = 'text', distance_strategy: ~typing.Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None = None, strategy: ~langchain_elasticsearch.vectorstores.BaseRetrievalStrategy | ~elasticsearch.helpers.vectorstore._sync.strategies.RetrievalStrategy = <langchain_elasticsearch.vectorstores.ApproxRetrievalStrategy object>, es_params: ~typing.Dict[str, ~typing.Any] | None = None)[source]#

Parameters:

index_name (str)
embedding (Embeddings | None)
es_connection (Elasticsearch | None)
es_url (str | None)
es_cloud_id (str | None)
es_user (str | None)
es_api_key (str | None)
es_password (str | None)
vector_query_field (str)
query_field (str)
distance_strategy (Literal[DistanceStrategy.COSINE, DistanceStrategy.DOT_PRODUCT, DistanceStrategy.EUCLIDEAN_DISTANCE, DistanceStrategy.MAX_INNER_PRODUCT] | None)
strategy (BaseRetrievalStrategy | RetrievalStrategy)
es_params (Dict[str, Any] | None)

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]#

Async run more documents through the embeddings and add to the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of IDs does not match the number of documents.

Return type:

list[str]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

Async run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
ids (list[str] | None) – Optional list
**kwargs (Any) – vectorstore specific parameters.

Returns:

List of ids from adding the texts into the vectorstore.

Raises:

ValueError – If the number of metadatas does not match the number of texts.
ValueError – If the number of ids does not match the number of texts.

Return type:

list[str]

add_documents(documents: list[Document], **kwargs: Any) → list[str]#

Add or update documents in the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments. if kwargs contains ids and documents contain ids, the ids in the kwargs will receive precedence.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of ids does not match the number of documents.

Return type:

list[str]

add_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: List[dict] | None = None, ids: List[str] | None = None, refresh_indices: bool = True, create_index_if_not_exists: bool = True, bulk_kwargs: Dict | None = None, **kwargs: Any) → List[str][source]#

Add the given texts and embeddings to the store.

Parameters:

text_embeddings (Iterable[Tuple[str, List[float]]]) – Iterable pairs of string and embedding to add to the store.
metadatas (List[dict] | None) – Optional list of metadatas associated with the texts.
ids (List[str] | None) – Optional list of unique IDs.
refresh_indices (bool) – Whether to refresh the Elasticsearch indices after adding the texts.
create_index_if_not_exists (bool) – Whether to create the Elasticsearch index if it doesn’t already exist.
*bulk_kwargs (Dict | None) –
Additional arguments to pass to Elasticsearch bulk. - chunk_size: Optional. Number of texts to add to the

index at a time. Defaults to 500.
kwargs (Any)

Returns:

List of ids from adding the texts into the store.

Return type:

List[str]

add_texts(texts: Iterable[str], metadatas: List[Dict[Any, Any]] | None = None, ids: List[str] | None = None, refresh_indices: bool = True, create_index_if_not_exists: bool = True, bulk_kwargs: Dict | None = None, **kwargs: Any) → List[str][source]#

Run more texts through the embeddings and add to the store.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the store.
metadatas (List[Dict[Any, Any]] | None) – Optional list of metadatas associated with the texts.
ids (List[str] | None) – Optional list of ids to associate with the texts.
refresh_indices (bool) – Whether to refresh the Elasticsearch indices after adding the texts.
create_index_if_not_exists (bool) – Whether to create the Elasticsearch index if it doesn’t already exist.
*bulk_kwargs (Dict | None) –
Additional arguments to pass to Elasticsearch bulk. - chunk_size: Optional. Number of texts to add to the

index at a time. Defaults to 500.
kwargs (Any)

Returns:

List of ids from adding the texts into the store.

Return type:

List[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

Async delete by vector ID or other criteria.

Parameters:

ids (list[str] | None) – List of ids to delete. If None, delete all. Default is None.
**kwargs (Any) – Other keyword arguments that subclasses might use.

Returns:

True if deletion is successful, False otherwise, None if not implemented.

Return type:

Optional[bool]

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST#

Async return VectorStore initialized from documents and embeddings.

Parameters:

documents (list[Document]) – List of Documents to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from documents and embeddings.

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → VST#

Async return VectorStore initialized from texts and embeddings.

Parameters:

texts (list[str]) – Texts to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
ids (list[str] | None) – Optional list of IDs associated with the texts.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from texts and embeddings.

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

Async get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
kwargs (Any)

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

async amax_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

Return VectorStoreRetriever initialized from this VectorStore.

Parameters:

**kwargs (Any) –

Keyword arguments to pass to the search function. Can include: search_type (Optional[str]): Defines the type of search that

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): Keyword arguments to pass to the

search function. Can include things like:

k: Amount of documents to return (Default: 4) score_threshold: Minimum relevance threshold

for similarity_score_threshold

fetch_k: Amount of documents to pass to MMR algorithm: (Default: 20)
lambda_mult: Diversity of results returned by MMR;: 1 for minimum diversity and 0 for maximum. (Default: 0.5)

filter: Filter by document metadata

Returns:

Retriever class for VectorStore.

Return type:

VectorStoreRetriever

Examples:

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

async asearch(query: str, search_type: str, **kwargs: Any) → list[Document]#

Async return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text.
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to query.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Return type:

list[Document]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to embedding vector.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query vector.

Return type:

list[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Async return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs

Returns:

List of Tuples of (doc, similarity_score)

Return type:

list[tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

Async run similarity search with distance.

Parameters:

*args (Any) – Arguments to pass to the search method.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

close() → None[source]#

Return type:: None

Parameters:

es_url (str | None)
cloud_id (str | None)
api_key (str | None)
username (str | None)
password (str | None)
es_params (Dict[str, Any] | None)

Return type:

Elasticsearch

delete(ids: List[str] | None = None, refresh_indices: bool | None = True, **kwargs: Any) → bool | None[source]#

Delete documents from the Elasticsearch index.

Parameters:

ids (List[str] | None) – List of ids of documents to delete.
refresh_indices (bool | None) – Whether to refresh the index after deleting documents. Defaults to True.
kwargs (Any)

Return type:

bool | None

classmethod from_documents(documents: List[Document], embedding: Embeddings | None = None, bulk_kwargs: Dict | None = None, **kwargs: Any) → ElasticsearchStore[source]#

Construct ElasticsearchStore wrapper from documents.

Example

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

db = ElasticsearchStore.from_documents(
    texts,
    embeddings,
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

Parameters:

texts – List of texts to add to the Elasticsearch index.
embedding (Embeddings | None) – Embedding function to use to embed the texts. Do not provide if using a strategy that doesn’t require inference.
metadatas – Optional list of metadatas associated with the texts.
index_name – Name of the Elasticsearch index to create.
es_url – URL of the Elasticsearch instance to connect to.
cloud_id – Cloud ID of the Elasticsearch instance to connect to.
es_user – Username to use when connecting to Elasticsearch.
es_password – Password to use when connecting to Elasticsearch.
es_api_key – API key to use when connecting to Elasticsearch.
es_connection – Optional pre-existing Elasticsearch connection.
vector_query_field – Optional. Name of the field to store the embedding vectors in.
query_field – Optional. Name of the field to store the texts in.
bulk_kwargs (Dict | None) – Optional. Additional arguments to pass to Elasticsearch bulk.
documents (List[Document])
kwargs (Any)

Return type:

ElasticsearchStore

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[Dict[str, Any]] | None = None, bulk_kwargs: Dict | None = None, **kwargs: Any) → ElasticsearchStore[source]#

Construct ElasticsearchStore wrapper from raw documents.

Example

from langchain_elasticsearch.vectorstores import ElasticsearchStore
from langchain_openai import OpenAIEmbeddings

db = ElasticsearchStore.from_texts(
    texts,
    // embeddings optional if using
    // a strategy that doesn't require inference
    embeddings,
    index_name="langchain-demo",
    es_url="http://localhost:9200"
)

Parameters:

texts (List[str]) – List of texts to add to the Elasticsearch index.
embedding (Embeddings | None) – Embedding function to use to embed the texts.
metadatas (List[Dict[str, Any]] | None) – Optional list of metadatas associated with the texts.
index_name – Name of the Elasticsearch index to create.
es_url – URL of the Elasticsearch instance to connect to.
cloud_id – Cloud ID of the Elasticsearch instance to connect to.
es_user – Username to use when connecting to Elasticsearch.
es_password – Password to use when connecting to Elasticsearch.
es_api_key – API key to use when connecting to Elasticsearch.
es_connection – Optional pre-existing Elasticsearch connection.
vector_query_field – Optional. Name of the field to store the embedding vectors in.
query_field – Optional. Name of the field to store the texts in.
distance_strategy – Optional. Name of the distance strategy to use. Defaults to “COSINE”. can be one of “COSINE”, “EUCLIDEAN_DISTANCE”, “DOT_PRODUCT”, “MAX_INNER_PRODUCT”.
bulk_kwargs (Dict | None) – Optional. Additional arguments to pass to Elasticsearch bulk.
kwargs (Any)

Return type:

ElasticsearchStore

get_by_ids(ids: Sequence[str], /) → list[Document]#

Get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, fields: List[str] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Document][source]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity: among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
fields (List[str] | None) – Other fields to get from elasticsearch source. These fields will be added to the document metadata.
custom_query (Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None)
doc_builder (Callable[[Dict], Document] | None)
kwargs (Any)

Returns:

A list of Documents selected by maximal marginal relevance.

Return type:

List[Document]

max_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

search(query: str, search_type: str, **kwargs: Any) → list[Document]#

Return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

similarity_search(query: str, k: int = 4, fetch_k: int = 50, filter: List[dict] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Document][source]#

Return Elasticsearch documents most similar to query.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to knn num_candidates.
filter (List[dict] | None) – Array of Elasticsearch filter clauses to apply to the query.
custom_query (Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None)
doc_builder (Callable[[Dict], Document] | None)
kwargs (Any)

Returns:

List of Documents most similar to the query, in descending order of similarity.

Return type:

List[Document]

similarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]#

Return docs most similar to embedding vector.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query vector.

Return type:

list[Document]

similarity_search_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, filter: List[Dict] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Return Elasticsearch documents most similar to query, along with scores.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
filter (List[Dict] | None) – Array of Elasticsearch filter clauses to apply to the query.
custom_query (Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None)
doc_builder (Callable[[Dict], Document] | None)
kwargs (Any)

Returns:

List of Documents most similar to the embedding and score for each

Return type:

List[Tuple[Document, float]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: List[dict] | None = None, *, custom_query: Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None = None, doc_builder: Callable[[Dict], Document] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Return Elasticsearch documents most similar to query, along with scores.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
filter (List[dict] | None) – Array of Elasticsearch filter clauses to apply to the query.
custom_query (Callable[[Dict[str, Any], str | None], Dict[str, Any]] | None)
doc_builder (Callable[[Dict], Document] | None)
kwargs (Any)

Returns:

List of Documents most similar to the query and score for each

Return type:

List[Tuple[Document, float]]