ElasticsearchEmbeddingsCache

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

概览

ElasticsearchEmbeddingsCache 是一个基于您的 Elasticsearch 实例实现高效存储和检索嵌入向量的 ByteStore 实现。

集成细节

Class	包	本地	JS支持	Package downloads	Package 最新版本
ElasticsearchEmbeddingsCache	langchain_elasticsearch	✅	❌

设置

要创建一个 ElasticsearchEmbeddingsCache 字节的存储，你需要一个 Elasticsearch 集群。你可以 在本地搭建 或创建一个 Elastic 账户。

安装

LangChain ElasticsearchEmbeddingsCache 集成位于 __package_name__ 包中：

%pip install -qU langchain_elasticsearch

Instantiation

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

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="<GENERATED PASSWORD>",
    es_params={
        "ca_certs": "~/http_ca.crt",
    },
)

API 参考:ElasticsearchEmbeddingsCache

用法

您可以使用 mset 方法通过键来设置数据，如下所示：

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

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

[b'value1', b'value2']

并且你可以使用 mdelete 方法删除数据：

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 参考： https://python.langchain.com/api_reference/elasticsearch/cache/langchain_elasticsearch.cache.ElasticsearchEmbeddingsCache.html

相关

• 键值存储 概念指南