`langchain_community.vectorstores.bagel`.Bagel¶

class langchain_community.vectorstores.bagel.Bagel(cluster_name: str = 'langchain', client_settings: Optional[bagel.config.Settings] = None, embedding_function: Optional[Embeddings] = None, cluster_metadata: Optional[Dict] = None, client: Optional[bagel.Client] = None, relevance_score_fn: Optional[Callable[[float], float]] = None)[source]¶

Bagel.net 推理平台。

要使用，您应该已安装``bagelML`` Python包。

示例:

from langchain_community.vectorstores import Bagel
vectorstore = Bagel(cluster_name="langchain_store")

使用贝果客户端进行初始化

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

`__init__`([cluster_name, client_settings, ...])	使用贝果客户端进行初始化
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas, ids, embeddings])	将文本与其对应的嵌入向量和可选元数据添加到Bagel集群中。
`adelete`([ids])	根据向量ID或其他条件进行删除。
`afrom_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	返回从文本和嵌入初始化的VectorStore。
`amax_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`asimilarity_search`(query[, k])	返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	返回文档和相关性分数在范围[0, 1]内，异步执行。
`asimilarity_search_with_score`(args, *kwargs)	使用异步方式运行相似性搜索与距离。
`delete`([ids])	根据IDs删除。
`delete_cluster`()	删除集群。
`from_documents`(documents[, embedding, ids, ...])	创建一个Bagel向量存储，从一个文档列表中。
`from_texts`(texts[, embedding, metadatas, ...])	从文本列表中创建并初始化一个 Bagel 实例。
`get`([ids, where, limit, offset, ...])	获取集合。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, where])	使用Bagel运行相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_by_vector_with_relevance_scores`(...)	返回与嵌入向量最相似的文档及相似度分数。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, where])	运行使用Bagel进行相似性搜索，并返回带有相应相似性分数的文档。
`update_document`(document_id, document)	更新集群中的文档。

Parameters

cluster_name (str) –
client_settings (Optional[bagel.config.Settings]) –
embedding_function (Optional[Embeddings]) –
cluster_metadata (Optional[Dict]) –
client (Optional[bagel.Client]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

Return type

None

__init__(cluster_name: str = 'langchain', client_settings: Optional[bagel.config.Settings] = None, embedding_function: Optional[Embeddings] = None, cluster_metadata: Optional[Dict] = None, client: Optional[bagel.Client] = None, relevance_score_fn: Optional[Callable[[float], float]] = None) → None[source]¶

使用贝果客户端进行初始化

Parameters

cluster_name (str) –
client_settings (Optional[bagel.config.Settings]) –
embedding_function (Optional[Embeddings]) –
cluster_metadata (Optional[Dict]) –
client (Optional[bagel.Client]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

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, ids: Optional[List[str]] = None, embeddings: Optional[List[List[float]]] = None, **kwargs: Any) → List[str][source]¶

将文本与其对应的嵌入向量和可选元数据添加到Bagel集群中。

参数：: texts（Iterable[str]）：要添加的文本。 embeddings（Optional[List[float]）：嵌入向量的列表。 metadatas（Optional[List[dict]）：元数据的可选列表。 ids（Optional[List[str]）：文本的唯一ID列表。
返回：: List[str]：表示已添加文本的唯一ID列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
embeddings (Optional[List[List[float]]]) –
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: VectorStoreRetriever

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) → None[source]¶

根据IDs删除。

参数：: ids：要删除的ID列表。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

None

delete_cluster() → None[source]¶

删除集群。

Return type: None

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, ids: Optional[List[str]] = None, cluster_name: str = 'langchain', client_settings: Optional[bagel.config.Settings] = None, client: Optional[bagel.Client] = None, cluster_metadata: Optional[Dict] = None, **kwargs: Any) → Bagel[source]¶

创建一个Bagel向量存储，从一个文档列表中。

参数:: documents (List[Document]): 要添加到Bagel向量存储中的Document对象列表。 embedding (Optional[List[float]]): 嵌入列表。 ids (Optional[List[str]]): ID列表。默认为None。 cluster_name (str): Bagel集群的名称。 client_settings (Optional[bagel.config.Settings]): 客户端设置。 client (Optional[bagel.Client]): Bagel客户端实例。 cluster_metadata (Optional[Dict]): 与Bagel集群相关的元数据。默认为None。
返回:: Bagel: Bagel向量存储。

Parameters

documents (List[Document]) –
embedding (Optional[Embeddings]) –
ids (Optional[List[str]]) –
cluster_name (str) –
client_settings (Optional[bagel.config.Settings]) –
client (Optional[bagel.Client]) –
cluster_metadata (Optional[Dict]) –
kwargs (Any) –

Return type

Bagel

classmethod from_texts(texts: List[str], embedding: Optional[Embeddings] = None, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, cluster_name: str = 'langchain', client_settings: Optional[bagel.config.Settings] = None, cluster_metadata: Optional[Dict] = None, client: Optional[bagel.Client] = None, text_embeddings: Optional[List[List[float]]] = None, **kwargs: Any) → Bagel[source]¶

从文本列表中创建并初始化一个 Bagel 实例。

参数:: texts (List[str]): 要添加的文本内容列表。 cluster_name (str): Bagel 集群的名称。 client_settings (Optional[bagel.config.Settings]): 客户端设置。 cluster_metadata (Optional[Dict]): 集群的元数据。 embeddings (Optional[Embeddings]): 嵌入列表。 metadatas (Optional[List[dict]]): 元数据列表。 ids (Optional[List[str]]): 唯一 ID 列表。默认为 None。 client (Optional[bagel.Client]): Bagel 客户端实例。
返回:: Bagel: Bagel 向量存储。

Parameters

texts (List[str]) –
embedding (Optional[Embeddings]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
cluster_name (str) –
client_settings (Optional[bagel.config.Settings]) –
cluster_metadata (Optional[Dict]) –
client (Optional[bagel.Client]) –
text_embeddings (Optional[List[List[float]]]) –
kwargs (Any) –

Return type

Bagel

get(ids: Optional[OneOrMany[ID]] = None, where: Optional[Where] = None, limit: Optional[int] = None, offset: Optional[int] = None, where_document: Optional[WhereDocument] = None, include: Optional[List[str]] = None) → Dict[str, Any][source]¶

获取集合。

Parameters

ids (Optional[OneOrMany[ID]]) –
where (Optional[Where]) –
limit (Optional[int]) –
offset (Optional[int]) –
where_document (Optional[WhereDocument]) –
include (Optional[List[str]]) –

Return type

Dict[str, Any]

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 = 5, where: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

使用Bagel运行相似性搜索。

参数：: query（str）：要搜索相似文档/文本的查询文本。 k（int）：要返回的结果数量。 where（Optional[Dict[str, str]]）：用于缩小范围的元数据过滤器。
返回：: List[Document]：表示与查询文本最相似的文档对象列表。

Parameters

query (str) –
k (int) –
where (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 5, where: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

返回与嵌入向量最相似的文档。

Parameters

embedding (List[float]) –
k (int) –
where (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector_with_relevance_scores(query_embeddings: List[float], k: int = 5, where: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与嵌入向量最相似的文档及相似度分数。

Parameters

query_embeddings (List[float]) –
k (int) –
where (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_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]]

similarity_search_with_score(query: str, k: int = 5, where: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

运行使用Bagel进行相似性搜索，并返回带有相应相似性分数的文档。

参数:: query (str): 要搜索相似文档的查询文本。 k (int): 要返回的结果数量。 where (Optional[Dict[str, str]]): 使用元数据进行过滤。
返回:: List[Tuple[Document, float]]: 元组列表，每个元组包含一个表示相似文档的Document对象和其对应的相似性分数。

Parameters

query (str) –
k (int) –
where (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

update_document(document_id: str, document: Document) → None[source]¶

更新集群中的文档。

参数：: document_id（str）：要更新的文档的ID。 document（Document）：要更新的文档。

Parameters

document_id (str) –
document (Document) –

Return type

None

langchain_community.vectorstores.bagel.Bagel¶

Examples using Bagel¶

`langchain_community.vectorstores.bagel`.Bagel¶