ElasticsearchEmbeddingsCache
这将帮助您开始使用Elasticsearch 键值存储。有关所有ElasticsearchEmbeddingsCache
功能和配置的详细文档,请访问API参考。
概述
ElasticsearchEmbeddingsCache
是一个ByteStore
实现,使用您的Elasticsearch实例进行高效的嵌入存储和检索。
集成细节
类 | 包名 | 本地 | JS支持 | 包下载 | 包最新 |
---|---|---|---|---|---|
ElasticsearchEmbeddingsCache | langchain_elasticsearch | ✅ | ❌ |
设置
要创建一个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