这将帮助您开始使用 Elasticsearch 键值存储。有关所有 ElasticsearchEmbeddingsCache 功能和配置的详细文档，请前往 API 参考.

概述

使用您的 Elasticsearch 实例进行高效存储和检索的 ElasticsearchEmbeddingsCache is a ByteStore 实现。

集成详情

设置

要创建 ElasticsearchEmbeddingsCache 字节存储，您需要一个 Elasticsearch 集群。您可以 在本地设置一个 或创建一个 Elastic 账户.

安装

LangChain ElasticsearchEmbeddingsCache 集成位于 langchain-elasticsearch package:

pip install -qU langchain-elasticsearch

实例化

现在我们可以实例化我们的字节存储：

from langchain_elasticsearch import ElasticsearchEmbeddingsCache

# Example config for a locally running Elasticsearch instance
kv_store = ElasticsearchEmbeddingsCache(
    es_url="https://localhost:9200",
    index_name="llm-chat-cache",
    metadata={"project": "my_chatgpt_project"},
    namespace="my_chatgpt_project",
    es_user="elastic",
    es_password="",
    es_params={
        "ca_certs": "~/http_ca.crt",
    },
)

用法

您可以使用以下方式通过键设置数据 mset method:

kv_store.mset(
    [
        ["key1", b"value1"],
        ["key2", b"value2"],
    ]
)

kv_store.mget(
    [
        "key1",
        "key2",
    ]
)

[b'value1', b'value2']

您可以使用以下方式删除数据 mdelete method:

kv_store.mdelete(
    [
        "key1",
        "key2",
    ]
)

kv_store.mget(
    [
        "key1",
        "key2",
    ]
)

[None, None]

用作嵌入缓存

与其他 ByteStores一样，您可以使用一个 ElasticsearchEmbeddingsCache 实例用于 文档摄取中的持久缓存 用于 RAG。

但是，缓存的向量默认情况下无法搜索。开发者可以自定义 Elasticsearch 文档的构建，以便添加索引向量字段。

这可以通过子类化和重写方法来完成：

from typing import Any, Dict, List


class SearchableElasticsearchStore(ElasticsearchEmbeddingsCache):
    @property
    def mapping(self) -> Dict[str, Any]:
        mapping = super().mapping
        mapping["mappings"]["properties"]["vector"] = {
            "type": "dense_vector",
            "dims": 1536,
            "index": True,
            "similarity": "dot_product",
        }
        return mapping

    def build_document(self, llm_input: str, vector: List[float]) -> Dict[str, Any]:
        body = super().build_document(llm_input, vector)
        body["vector"] = vector
        return body

重写映射和文档构建时，请仅进行增量修改，保持基础映射不变。

API 参考

有关所有 ElasticsearchEmbeddingsCache 功能和配置的详细文档，请参阅 API 参考