百吉饼#

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

Bagel.net 推理平台。

要使用，您应该安装bagelML python包。

示例

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

使用bagel客户端初始化

属性

embeddings

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

方法

__init__([cluster_name, client_settings, ...])

使用 bagel 客户端进行初始化

aadd_documents(documents, **kwargs)

异步运行更多文档通过嵌入并添加到向量存储中。

aadd_texts(texts[, metadatas, ids])

异步运行更多文本通过嵌入并添加到向量存储中。

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, ids])

异步返回从文本和嵌入初始化的VectorStore。

aget_by_ids(ids, /)

通过ID异步获取文档。

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

根据ID删除。

delete_cluster()

删除集群。

from_documents(documents[, embedding, ids, ...])

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

from_texts(texts[, embedding, metadatas, ...])

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

get([ids, where, limit, offset, ...])

获取集合。

get_by_ids(ids, /)

通过ID获取文档。

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 (可选[bagel.config.Settings])

  • embedding_function (可选[Embeddings])

  • cluster_metadata (可选[字典])

  • client (可选[bagel.Client])

  • relevance_score_fn (可选[Callable[[float], float]])

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

使用bagel客户端初始化

Parameters:

  • cluster_name (str)

  • client_settings (可选[bagel.config.Settings])

  • embedding_function (可选[Embeddings])

  • cluster_metadata (可选[字典])

  • client (可选[bagel.Client])

  • relevance_score_fn (可选[Callable[[float], float]])

Return type:

无

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]#

通过嵌入异步运行更多文档并将其添加到向量存储中。

Parameters:

  • documents (list[Document]) – 要添加到向量存储中的文档。

  • kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

异步运行更多文本通过嵌入并添加到向量存储中。

Parameters:

  • texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

  • ids (list[str] | None) – 可选的列表

  • **kwargs (Any) – 向量存储特定参数。

Returns:

将文本添加到向量存储中后的ID列表。

Raises:

  • ValueError – 如果元数据的数量与文本的数量不匹配。

  • ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

add_documents(documents: list[Document], **kwargs: Any) → list[str]#

在向量存储中添加或更新文档。

Parameters:

  • documents (list[Document]) – 要添加到向量存储中的文档。

  • kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, embeddings: List[List[float]] | None = None, **kwargs: Any) → List[str][source]#

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

Parameters:

  • texts (Iterable[str]) – 要添加的文本。

  • embeddings (可选[列表[浮点数]]) – 嵌入向量列表

  • metadatas (Optional[List[dict]]) – 可选的元数据列表。

  • ids (可选[列表[字符串]]) – 文本的唯一ID列表。

  • kwargs (Any)

Returns:

表示添加文本的唯一ID列表。

Return type:

列表[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

通过向量ID或其他条件异步删除。

Parameters:

  • ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。

  • **kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真， 否则为假，如果未实现则为无。

Return type:

可选[布尔]

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST#

异步返回从文档和嵌入初始化的VectorStore。

Parameters:

  • documents (list[Document]) – 要添加到向量存储中的文档列表。

  • embedding (Embeddings) – 使用的嵌入函数。

  • kwargs (Any) – 额外的关键字参数。

Returns:

从文档和嵌入初始化的VectorStore。

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → VST#

异步返回从文本和嵌入初始化的VectorStore。

Parameters:

  • texts (list[str]) – 要添加到向量存储中的文本。

  • embedding (Embeddings) – 使用的嵌入函数。

  • metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

  • ids (list[str] | None) – 可选的与文本关联的ID列表。

  • kwargs (Any) – 额外的关键字参数。

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • kwargs (Any)

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[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) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。 可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。
可以包括以下内容：

k: 返回的文档数量（默认：4） score_threshold: 最小相关性阈值

用于similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量

（默认：20）

lambda_mult: MMR返回结果的多样性；

1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

VectorStoreRetriever

示例：

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
async asearch(query: str, search_type: str, **kwargs: Any) → list[Document]#

异步返回与查询最相似的文档，使用指定的搜索类型。

Parameters:

  • query (str) – 输入文本。

  • search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

异步返回与查询最相似的文档。

Parameters:

  • query (str) – 输入文本。

  • k (int) – 返回的文档数量。默认为4。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Return type:

列表[Document]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]#

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

Parameters:

  • embedding (list[float]) – 用于查找相似文档的嵌入。

  • k (int) – 返回的文档数量。默认为4。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

异步返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

  • query (str) – 输入文本。

  • k (int) – 返回的文档数量。默认为4。

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

    过滤检索到的文档集

Returns:

（文档，相似度分数）的元组列表

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

异步运行带有距离的相似性搜索。

Parameters:

  • *args (Any) – 传递给搜索方法的参数。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

delete(ids: List[str] | None = None, **kwargs: Any) → None[来源]#

按ID删除。

Parameters:

  • ids (List[str] | None) – 要删除的ID列表。

  • kwargs (Any)

Return type:

无

delete_cluster() → None[source]#

删除集群。

Return type:

无

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

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

Parameters:

  • documents (List[Document]) – 要添加到Bagel向量存储中的Document对象列表。

  • embedding (Optional[List[float]]) – 嵌入列表。

  • ids (可选[列表[字符串]]) – ID列表。默认为None。

  • cluster_name (str) – Bagel集群的名称。

  • client_settings (Optional[bagel.config.Settings]) – 客户端设置。

  • client (可选[bagel.Client]) – Bagel 客户端实例。

  • cluster_metadata (可选[字典]) – 与Bagel集群关联的元数据。默认为None。

  • kwargs (Any)

Returns:

Bagel 向量存储。

Return type:

Bagel

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

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

Parameters:

  • texts (List[str]) – 要添加的文本内容列表。

  • cluster_name (str) – Bagel集群的名称。

  • client_settings (Optional[bagel.config.Settings]) – 客户端设置。

  • cluster_metadata (可选[字典]) – 集群的元数据。

  • embeddings (可选[Embeddings]) – 嵌入列表。

  • metadatas (可选[列表[字典]]) – 元数据列表。

  • ids (可选[列表[字符串]]) – 唯一ID的列表。默认为None。

  • client (可选[bagel.Client]) – Bagel 客户端实例。

  • embedding (可选[Embeddings])

  • text_embeddings (可选[列表[列表[浮点数]]])

  • kwargs (Any)

Returns:

Bagel 向量存储。

Return type:

Bagel

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

获取集合。

Parameters:

  • ids (可选[一个或多个[ID]])

  • where (可选[Where])

  • limit (可选[整数])

  • offset (可选[int])

  • where_document (可选[WhereDocument])

  • include (可选[列表[字符串]])

Return type:

Dict[str, Any]

get_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[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]#

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

  • embedding (list[float]) – 用于查找相似文档的嵌入。

  • k (int) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

search(query: str, search_type: str, **kwargs: Any) → list[Document]#

使用指定的搜索类型返回与查询最相似的文档。

Parameters:

  • query (str) – 输入文本

  • search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

  • **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

使用Bagel运行相似性搜索。

Parameters:

  • query (str) – 用于搜索相似文档/文本的查询文本。

  • k (int) – 返回的结果数量。

  • where (可选[Dict[str, str]]) – 用于缩小范围的元数据过滤器。

  • kwargs (Any)

Returns:

表示与查询文本最相似的文档对象的列表。

Return type:

列表[Document]

similarity_search_by_vector(embedding: List[float], k: int = 5, where: Dict[str, str] | None = None, **kwargs: Any) → List[Document][来源]#

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

Parameters:

  • embedding (列表[浮点数])

  • k (整数)

  • where (Dict[str, str] | None)

  • kwargs (Any)

Return type:

列表[文档]

similarity_search_by_vector_with_relevance_scores(query_embeddings: List[float], k: int = 5, where: Dict[str, str] | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

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

Parameters:

  • query_embeddings (List[float])

  • k (整数)

  • where (Dict[str, str] | None)

  • kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

  • query (str) – 输入文本。

  • k (int) – 返回的文档数量。默认为4。

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

    用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

使用Bagel运行相似性搜索并返回文档及其对应的相似性分数。

Parameters:

  • query (str) – 用于搜索相似文档的查询文本。

  • k (int) – 返回的结果数量。

  • where (可选[Dict[str, str]]) – 使用元数据进行过滤。

  • kwargs (Any)

Returns:

元组列表，每个元组包含一个表示相似文档的Document对象及其对应的相似度分数。

Return type:

列表[元组[Document, 浮点数]]

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

更新集群中的文档。

Parameters:

  • document_id (str) – 要更新的文档的ID。

  • document (Document) – 要更新的文档。

Return type:

无

使用 Bagel 的示例