Skip to main content
Open In ColabOpen on GitHub

Elasticsearch嵌入缓存

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

概述​

ElasticsearchEmbeddingsCache 是一个 ByteStore 实现，它使用您的 Elasticsearch 实例来高效存储和检索嵌入。

集成详情​

类包本地JS支持包下载量包最新版本
ElasticsearchEmbeddingsCachelangchain_elasticsearch✅❌PyPI - 下载量PyPI - 版本

设置​

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

安装​

LangChain 的 ElasticsearchEmbeddingsCache 集成位于 __package_name__ 包中：

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

用法​

你可以使用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

这个页面有帮助吗？