langchain_community.vectorstores.clickhouse
.Clickhouse¶
- class langchain_community.vectorstores.clickhouse.Clickhouse(embedding: Embeddings, config: Optional[ClickhouseSettings] = None, **kwargs: Any)[source]¶
ClickHouse VectorSearch 向量存储。
您需要 clickhouse-connect python 包和有效的账户来连接到 ClickHouse。
ClickHouse 不仅可以使用简单的向量索引进行搜索, 还支持具有多个条件、约束甚至子查询的复杂查询。
- 欲了解更多信息,请访问
[ClickHouse 官方网站](https://clickhouse.com/clickhouse)
ClickHouse包装器到LangChain
embedding_function (嵌入函数): config (ClickHouse设置): ClickHouse客户端的配置 其他关键字参数将传递到
[clickhouse-connect](https://docs.clickhouse.com/)
Attributes
embeddings
提供对Clickhouse实例使用的嵌入机制的访问。
metadata_column
Methods
__init__
(embedding[, config])ClickHouse包装器到LangChain
aadd_documents
(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
aadd_texts
(texts[, metadatas])运行更多的文本通过嵌入,并添加到向量存储中。
add_documents
(documents, **kwargs)运行更多的文档通过嵌入并添加到向量存储中。
add_texts
(texts[, metadatas, batch_size, ids])通过嵌入插入更多文本,并添加到VectorStore中。
adelete
([ids])根据向量ID或其他条件进行删除。
afrom_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
afrom_texts
(texts, embedding[, metadatas])返回从文本和嵌入初始化的VectorStore。
amax_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从此VectorStore初始化的VectorStoreRetriever。
asearch
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
asimilarity_search
(query[, k])返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性分数在范围[0, 1]内,异步执行。
asimilarity_search_with_score
(*args, **kwargs)使用异步方式运行相似性搜索与距离。
delete
([ids])根据向量ID或其他条件进行删除。
drop
()辅助函数:丢弃数据
escape_str
(value)在Clickhouse SQL查询中转义字符串中的特殊字符。
from_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
from_texts
(texts, embedding[, metadatas, ...])创建具有现有文本的ClickHouse包装器
max_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
search
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
similarity_search
(query[, k, where_str])使用ClickHouse进行相似性搜索
similarity_search_by_vector
(embedding[, k, ...])使用ClickHouse通过向量执行相似性搜索
使用ClickHouse进行相似性搜索
similarity_search_with_score
(*args, **kwargs)使用距离进行相似性搜索。
- Parameters
embedding (Embeddings) –
config (Optional[ClickhouseSettings]) –
kwargs (Any) –
- Return type
None
- __init__(embedding: Embeddings, config: Optional[ClickhouseSettings] = None, **kwargs: Any) None [source]¶
ClickHouse包装器到LangChain
embedding_function (嵌入函数): config (ClickHouse设置): ClickHouse客户端的配置 其他关键字参数将传递到
[clickhouse-connect](https://docs.clickhouse.com/)
- Parameters
embedding (Embeddings) –
config (Optional[ClickhouseSettings]) –
kwargs (Any) –
- Return type
None
- async aadd_documents(documents: List[Document], **kwargs: Any) List[str] ¶
运行更多的文档通过嵌入并添加到向量存储中。
- 参数:
documents (List[Document]): 要添加到向量存储中的文档。
- 返回:
List[str]: 添加的文本的ID列表。
- Parameters
documents (List[Document]) –
kwargs (Any) –
- Return type
List[str]
- async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) List[str] ¶
运行更多的文本通过嵌入,并添加到向量存储中。
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –
- Return type
List[str]
- add_documents(documents: List[Document], **kwargs: Any) List[str] ¶
运行更多的文档通过嵌入并添加到向量存储中。
- 参数:
documents (List[Document]): 要添加到向量存储中的文档。
- 返回:
List[str]: 添加的文本的ID列表。
- Parameters
documents (List[Document]) –
kwargs (Any) –
- Return type
List[str]
- add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, batch_size: int = 32, ids: Optional[Iterable[str]] = None, **kwargs: Any) List[str] [source]¶
通过嵌入插入更多文本,并添加到VectorStore中。
- 参数:
texts:要添加到VectorStore中的字符串的可迭代对象。 ids:要与文本关联的可选id列表。 batch_size:插入的批量大小。 metadata:要插入的可选列数据。
- 返回:
将文本添加到VectorStore中的id列表。
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
batch_size (int) –
ids (Optional[Iterable[str]]) –
kwargs (Any) –
- Return type
List[str]
- async adelete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
根据向量ID或其他条件进行删除。
- 参数:
ids:要删除的ID列表。 **kwargs:子类可能使用的其他关键字参数。
- 返回:
Optional[bool]:如果删除成功则为True,否则为False,如果未实现则为None。
- Parameters
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
Optional[bool]
- async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
返回从文档和嵌入初始化的VectorStore。
- Parameters
documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –
- Return type
VST
- async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) VST ¶
返回从文本和嵌入初始化的VectorStore。
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –
- Return type
VST
- async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 fetch_k:要获取以传递给MMR算法的文档数量。 lambda_mult:0到1之间的数字,确定结果之间多样性的程度,0对应最大多样性,1对应最小多样性。默认为0.5。
- 返回:
由最大边际相关性选择的文档列表。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –
- 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] ¶
返回使用最大边际相关性选择的文档。
- Parameters
embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –
- Return type
List[Document]
- as_retriever(**kwargs: Any) VectorStoreRetriever ¶
返回从此VectorStore初始化的VectorStoreRetriever。
- 参数:
- search_type(可选[str]):定义Retriever应执行的搜索类型。
可以是”similarity”(默认值)、”mmr”或”similarity_score_threshold”。
- search_kwargs(可选[Dict]):传递给搜索函数的关键字参数。可以包括:
k:要返回的文档数量(默认值:4) score_threshold:用于similarity_score_threshold的最小相关性阈值 fetch_k:传递给MMR算法的文档数量(默认值:20) lambda_mult:MMR返回结果的多样性;1表示最小多样性,0表示最大多样性(默认值:0.5) filter:按文档元数据筛选
- 返回:
VectorStoreRetriever:VectorStore的Retriever类。
示例:
# 检索更多具有更高多样性的文档 # 如果数据集中有许多相似的文档,则很有用 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 6, 'lambda_mult': 0.25} ) # 为MMR算法考虑更多文档 # 但只返回前5个 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 5, 'fetch_k': 50} ) # 仅检索具有特定阈值以上相关性分数的文档 docsearch.as_retriever( search_type="similarity_score_threshold", search_kwargs={'score_threshold': 0.8} ) # 仅从数据集中获取最相似的单个文档 docsearch.as_retriever(search_kwargs={'k': 1}) # 使用筛选器仅从特定论文中检索文档 docsearch.as_retriever( search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}} )
- Parameters
kwargs (Any) –
- Return type
- async asearch(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型的查询最相似的文档。
- Parameters
query (str) –
search_type (str) –
kwargs (Any) –
- Return type
List[Document]
- async asimilarity_search(query: str, k: int = 4, **kwargs: Any) List[Document] ¶
返回与查询最相似的文档。
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- Return type
List[Document]
- async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) List[Document] ¶
返回与嵌入向量最相似的文档。
- Parameters
embedding (List[float]) –
k (int) –
kwargs (Any) –
- Return type
List[Document]
- async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) List[Tuple[Document, float]] ¶
返回文档和相关性分数在范围[0, 1]内,异步执行。
0表示不相似,1表示最相似。
- 参数:
query:输入文本 k:要返回的文档数量。默认为4。 **kwargs:要传递给相似性搜索的kwargs。应包括:
score_threshold:可选,介于0到1之间的浮点值,用于过滤检索到的文档集
- 返回:
元组列表(doc,相似度分数)的列表
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- async asimilarity_search_with_score(*args: Any, **kwargs: Any) List[Tuple[Document, float]] ¶
使用异步方式运行相似性搜索与距离。
- Parameters
args (Any) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- delete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
根据向量ID或其他条件进行删除。
- 参数:
ids:要删除的ID列表。 **kwargs:子类可能使用的其他关键字参数。
- 返回:
Optional[bool]:如果删除成功则为True,否则为False,如果未实现则为None。
- Parameters
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
Optional[bool]
- escape_str(value: str) str [source]¶
在Clickhouse SQL查询中转义字符串中的特殊字符。
此方法用于内部使用,用于准备字符串以安全地插入SQL查询中,通过转义可能会干扰查询语法的特殊字符。
- 参数:
value:要转义的字符串。
- 返回:
转义后的字符串,可安全插入SQL查询。
- Parameters
value (str) –
- Return type
str
- classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
返回从文档和嵌入初始化的VectorStore。
- Parameters
documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –
- Return type
VST
- classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[Dict[Any, Any]]] = None, config: Optional[ClickhouseSettings] = None, text_ids: Optional[Iterable[str]] = None, batch_size: int = 32, **kwargs: Any) Clickhouse [source]¶
创建具有现有文本的ClickHouse包装器
- 参数:
embedding_function(Embeddings):用于提取文本嵌入的函数 texts(Iterable[str]):要添加的字符串列表或元组 config(ClickHouseSettings,可选):ClickHouse配置 text_ids(Optional[Iterable],可选):文本的ID。
默认为None。
- batch_size(int,可选):传输数据到ClickHouse时的批处理大小。
默认为32。
metadata(List[dict],可选):文本的元数据。默认为None。 其他关键字参数将传递到
[clickhouse-connect](https://clickhouse.com/docs/en/integrations/python#clickhouse-connect-driver-api)
- 返回:
ClickHouse索引
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[Dict[Any, Any]]]) –
config (Optional[ClickhouseSettings]) –
text_ids (Optional[Iterable[str]]) –
batch_size (int) –
kwargs (Any) –
- Return type
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 fetch_k:要获取以传递给MMR算法的文档数量。 lambda_mult:0到1之间的数字,确定结果之间多样性的程度,0对应最大多样性,1对应最小多样性。默认为0.5。
- 返回:
由最大边际相关性选择的文档列表。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –
- 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] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
embedding:要查找相似文档的嵌入。 k:要返回的文档数量。默认为4。 fetch_k:要获取以传递给MMR算法的文档数量。 lambda_mult:介于0和1之间的数字,确定结果之间多样性的程度,其中0对应最大多样性,1对应最小多样性。默认为0.5。
- 返回:
由最大边际相关性选择的文档列表。
- Parameters
embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –
- Return type
List[Document]
- search(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型的查询最相似的文档。
- Parameters
query (str) –
search_type (str) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search(query: str, k: int = 4, where_str: Optional[str] = None, **kwargs: Any) List[Document] [source]¶
使用ClickHouse进行相似性搜索
- 参数:
query (str): 查询字符串 k (int, optional): 要检索的前K个邻居。默认为4。 where_str (Optional[str], optional): where条件字符串。
默认为None。
- 注意: 请不要让最终用户填写这个内容,并始终注意SQL注入问题。
处理元数据时,请记得使用`{self.metadata_column}.attribute`而不是仅使用`attribute`。 其默认名称为`metadata`。
- 返回:
List[Document]: 文档列表
- Parameters
query (str) –
k (int) –
where_str (Optional[str]) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_by_vector(embedding: List[float], k: int = 4, where_str: Optional[str] = None, **kwargs: Any) List[Document] [source]¶
使用ClickHouse通过向量执行相似性搜索
- 参数:
query (str): 查询字符串 k (int, optional): 要检索的前K个邻居。默认为4。 where_str (Optional[str], optional): where条件字符串。
默认为None。
- 注意:请不要让最终用户填写此内容,并始终注意SQL注入问题。
处理元数据时,请记住使用`{self.metadata_column}.attribute`而不是仅使用`attribute`。 其默认名称为`metadata`。
- 返回:
List[Document]: 文档列表
- Parameters
embedding (List[float]) –
k (int) –
where_str (Optional[str]) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_with_relevance_scores(query: str, k: int = 4, where_str: Optional[str] = None, **kwargs: Any) List[Tuple[Document, float]] [source]¶
使用ClickHouse进行相似性搜索
- 参数:
query (str): 查询字符串 k (int, optional): 要检索的前K个邻居。默认为4。 where_str (Optional[str], optional): where条件字符串。
默认为None。
- 注意: 请不要让最终用户填写这个内容,并始终注意SQL注入问题。
处理元数据时,请记住使用`{self.metadata_column}.attribute`而不是仅使用`attribute`。 其默认名称为`metadata`。
- 返回:
List[Document]: (Document, 相似度) 列表
- Parameters
query (str) –
k (int) –
where_str (Optional[str]) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]