Marqo#

class langchain_community.vectorstores.marqo.Marqo(client: marqo.Client, index_name: str, add_documents_settings: Dict[str, Any] | None = None, searchable_attributes: List[str] | None = None, page_content_builder: Callable[[Dict[str, Any]], str] | None = None)[来源]#

Marqo 向量存储。

Marqo索引有与之关联的模型来生成您的嵌入。这意味着您可以从一系列不同的模型中选择,并且还可以使用CLIP模型来创建包含图像和文本的多模态索引。

Marqo 还支持更高级的查询,包括多个加权项,请参见 https://docs.marqo.ai/latest/#searching-using-weights-in-queries。 该类可以灵活地在其相似性搜索方法中接受字符串或字典进行加权查询。

要使用,你应该安装marqo python包,你可以通过pip install marqo来完成。

示例

import marqo
from langchain_community.vectorstores import Marqo
client = marqo.Client(url=os.environ["MARQO_URL"], ...)
vectorstore = Marqo(client, index_name)

使用 Marqo 客户端进行初始化。

属性

embeddings

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

方法

__init__(client, index_name[, ...])

使用Marqo客户端进行初始化。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas, ids])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

将带有元数据(属性)的文本上传到Marqo。

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)

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

bulk_similarity_search(queries[, k])

使用多个查询批量搜索marqo索引中最相似的文档。

bulk_similarity_search_with_score(queries[, k])

从Marqo返回与查询相似的文档及其分数,使用批量查询。

delete([ids])

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

from_documents(documents[, embedding])

返回从文档初始化的VectorStore。

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

返回从文本初始化的Marqo。

get_by_ids(ids, /)

通过ID获取文档。

get_indexes()

帮助查看你在marqo中可用的索引,如果在使用from_texts方法时没有指定索引名称,这将非常有用

get_number_of_documents()

帮助查看索引中的文档数量

marqo_bulk_similarity_search(queries[, k])

使用批量搜索从Marqo返回文档,直接暴露Marqo的输出

marqo_similarity_search(query[, k])

从Marqo返回文档,直接暴露Marqo的输出

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

similarity_search(query[, k])

在marqo索引中搜索最相似的文档。

similarity_search_by_vector(embedding[, k])

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

similarity_search_with_relevance_scores(query)

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

similarity_search_with_score(query[, k])

返回与查询相似的文档及其分数。

Parameters:
  • client (marqo.Client)

  • index_name (str)

  • add_documents_settings (可选[字典[字符串, 任意类型]])

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

  • page_content_builder (可选[可调用[[字典[字符串, 任意类型]], 字符串]])

__init__(client: marqo.Client, index_name: str, add_documents_settings: Dict[str, Any] | None = None, searchable_attributes: List[str] | None = None, page_content_builder: Callable[[Dict[str, Any]], str] | None = None)[source]#

使用 Marqo 客户端进行初始化。

Parameters:
  • client (marqo.Client)

  • index_name (str)

  • add_documents_settings (可选[字典[字符串, 任意类型]])

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

  • page_content_builder (可选[可调用[[字典[字符串, 任意类型]], 字符串]])

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, **kwargs: Any) List[str][source]#

将带有元数据(属性)的文本上传到Marqo。

您可以让marqo为每个文档生成id,或者您可以通过在元数据对象中包含“_id”字段来提供自己的id。

Parameters:
  • texts (Iterable[str]) – 一个文本的迭代器 - 假设保留一个

  • metadatas. (匹配的顺序)

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

  • kwargs (Any)

Raises:
  • ValueError – 如果提供了metadatas且metadatas的数量不一致

  • 从文本的数量

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, 浮点数]]

在marqo索引中批量搜索与多个查询最相似的文档。

Parameters:
  • queries (Iterable[Union[str, Dict[str, float]]]) – 一个可迭代的查询集合

  • bulk (批量执行)

  • of (列表中的查询可以是字符串字典)

  • queries. (加权的)

  • k (int, optional) – 每个查询返回的文档数量。

  • 4. (默认为)

  • kwargs (Any)

Returns:

每个查询的结果列表。

Return type:

列表[列表[Document]]

bulk_similarity_search_with_score(queries: Iterable[str | Dict[str, float]], k: int = 4, **kwargs: Any) List[List[Tuple[Document, float]]][source]#

返回与查询相似的文档及其分数,使用一批查询。

Parameters:
  • query (Iterable[Union[str, Dict[str, float]]]) – 一个可迭代的查询集合

  • bulk (在...中执行)

  • dictionaries (列表中的查询可以是字符串或)

  • queries. (加权的)

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

  • queries (可迭代对象[字符串 | 字典[字符串, 浮点数]])

  • kwargs (Any)

Returns:

匹配文档及其每个查询得分的列表的列表

Return type:

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

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

根据向量ID或其他条件删除。

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

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

Returns:

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

Return type:

可选[布尔]

classmethod from_documents(documents: List[Document], embedding: Embeddings | None = None, **kwargs: Any) Marqo[来源]#

返回从文档初始化的VectorStore。请注意,Marqo不需要嵌入,我们保留该参数以遵循Liskov替换原则。

Parameters:
  • documents (List[Document]) – 输入文档

  • embedding (Any, 可选) – 嵌入(非必需)。默认为 None。

  • kwargs (Any)

Returns:

一个Marqo向量存储

Return type:

VectorStore

classmethod from_texts(texts: List[str], embedding: Any = None, metadatas: List[dict] | None = None, index_name: str = '', url: str = 'http://localhost:8882', api_key: str = '', add_documents_settings: Dict[str, Any] | None = None, searchable_attributes: List[str] | None = None, page_content_builder: Callable[[Dict[str, str]], str] | None = None, index_settings: Dict[str, Any] | None = None, verbose: bool = True, **kwargs: Any) Marqo[来源]#

返回从文本初始化的Marqo。请注意,Marqo不需要嵌入,我们保留该参数以遵循Liskov替换原则。

这是一个快速开始使用marqo的方法 - 只需提供您的文本和元数据,这将创建一个数据存储实例并索引提供的数据。

要使用此方法了解文档的ID,您需要在每个文本的元数据中包含键“_id”下的ID。

示例: .. code-block:: python

从langchain_community.vectorstores导入Marqo

datastore = Marqo(texts=[‘text’], index_name=’my-first-index’, url=’http://localhost:8882’)

Parameters:
  • texts (List[str]) – 创建时要索引到marqo的文本列表。

  • embedding (Any, 可选) – 嵌入(非必需)。默认为 None。

  • index_name (str, optional) – 要使用的索引名称,如果没有

  • 无。 (伴随文本。默认为)

  • url (str, optional) – Marqo的URL。默认为“http://localhost:8882”。

  • api_key (str, optional) – Marqo的API密钥。默认为“”。

  • metadatas (可选[列表[字典]], 可选) – 一个元数据列表,用于

  • 无。

  • 可以 (这仅在创建新索引时使用。默认为“cpu”。)

  • "cuda". (可以是 "cpu" 或)

  • add_documents_settings (可选[Dict[str, Any]], 可选) – 设置

  • documents (用于添加)

  • 查看

  • https – //docs.marqo.ai/0.0.16/API-Reference/documents/#query-parameters.

  • {}. (默认为)

  • index_settings (可选[Dict[str, Any]], 可选) – 索引设置如果

  • exist (索引不存在)

  • 查看

  • https – //docs.marqo.ai/0.0.16/API-Reference/indexes/#index-defaults-object.

  • {}.

  • searchable_attributes (列表[字符串] | )

  • page_content_builder (Callable[[Dict[str, str]], str] | None)

  • verbose (布尔值)

  • kwargs (Any)

Returns:

Marqo向量存储的一个实例

Return type:

Marqo

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中添加。

get_indexes() List[Dict[str, str]][source]#

帮助查看您在marqo中可用的索引,如果在使用from_texts方法时未指定索引名称,这将非常有用

Returns:

索引列表

Return type:

列表[字典[字符串, 字符串]]

get_number_of_documents() int[source]#

帮助查看索引中的文档数量

Returns:

文档数量

Return type:

整数

使用批量搜索从Marqo返回文档,直接暴露Marqo的输出

Parameters:
  • queries (Iterable[Union[str, Dict[str, float]]]) – 查询列表。

  • k (int, optional) – 每个查询返回的文档数量。

  • 4. (默认为)

Returns:

批量搜索结果对象

Return type:

Dict[str, Dict[List[Dict[str, Dict[str, Any]]]]]

从Marqo返回文档,直接暴露Marqo的输出

Parameters:
  • query (str) – 用于搜索的查询。

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

Returns:

这是来自marqo的点击。

Return type:

列表[字典[字符串, 任意类型]]

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

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

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]

在marqo索引中搜索最相似的文档。

Parameters:
  • query (Union[str, Dict[str, float]]) – 搜索的查询,可以是

  • query. (作为字符串加权的)

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

  • kwargs (Any)

Returns:

k 个文档按最佳到最差匹配排序。

Return type:

列表[Document]

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

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 | Dict[str, float], k: int = 4) List[Tuple[Document, float]][source]#

返回与查询相似的Marqo文档及其分数。

Parameters:
  • query (str) – 用于搜索的查询,可以是字符串或加权的

  • 查询.

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

Returns:

匹配的文档及其分数,按分数降序排列。

Return type:

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

使用 Marqo 的示例