`langchain_community.vectorstores.marqo`.Marqo¶

class langchain_community.vectorstores.marqo.Marqo(client: marqo.Client, index_name: str, add_documents_settings: Optional[Dict[str, Any]] = None, searchable_attributes: Optional[List[str]] = None, page_content_builder: Optional[Callable[[Dict[str, Any]], str]] = None)[source]¶

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])	异步运行更多文本通过嵌入并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	将带有元数据（属性）的文本上传到 Marqo。
`adelete`([ids])	通过向量 ID 或其他条件异步删除。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的 VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	异步返回从文本和嵌入初始化的 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)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **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])	从 Marqo 返回与查询相似的文档以及它们的分数。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

client (marqo.Client) –
index_name (str) –
add_documents_settings (Optional[Dict[str, Any]]) –
searchable_attributes (Optional[List[str]]) –
page_content_builder (Optional[Callable[[Dict[str, Any]], str]]) –

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

使用 Marqo 客户端初始化。

参数

client (marqo.Client) –
index_name (str) –
add_documents_settings (Optional[Dict[str, Any]]) –
searchable_attributes (Optional[List[str]]) –
page_content_builder (Optional[Callable[[Dict[str, Any]], str]]) –

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]¶

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加关键字参数。

返回

添加文本的 ID 列表。

Raises

ValueError – 如果 ID 数量与文档数量不匹配，则引发 ValueError。

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回

从将文本添加到向量存储中获取的 id 列表。

Raises

ValueError – 如果元数据的数量与文本的数量不匹配，则引发 ValueError。
ValueError – 如果 id 的数量与文本的数量不匹配，则引发 ValueError。

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]¶

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加关键字参数。如果 kwargs 包含 ids 且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回

添加文本的 ID 列表。

Raises

ValueError – 如果 id 的数量与文档的数量不匹配，则引发 ValueError。

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]¶

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

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

参数

texts (Iterable[str]) – 文本的迭代器 - 假定保留一个
metadatas. (order that matches the) –
metadatas (Optional[List[dict]], optional) – 元数据列表。
kwargs (Any) –

Raises

ValueError – 如果提供了元数据，并且元数据的数量不同
from the number of texts. –

返回

添加的 id 列表。

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

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

参数

ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None，则删除全部。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则返回 True，否则返回 False，如果未实现，则返回 None。

Return type

Optional[bool]

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回

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

Return type

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

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

参数

texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加关键字参数。

返回

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

Return type

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]¶

异步通过 ID 获取文档。

返回的文档应将 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 id 列表。
返回: 文档列表。
Return type: List[Document]

0.2.11 版本新增功能。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
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]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。

可以是 “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: 按文档元数据过滤

返回

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

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

参数

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是 “similarity”, “mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

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

Return type

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Return type

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集

返回

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

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

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

参数

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

返回

（文档，相似度评分）元组列表。

Return type

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 额外的关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回

响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增功能。

bulk_similarity_search(queries: Iterable[Union[str, Dict[str, float]]], k: int = 4, **kwargs: Any) → List[List[Document]][source]¶

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

参数

queries (Iterable[Union[str, Dict[str, float]]]) – 要批量执行的查询的可迭代对象
bulk (execute in) –
of (queries in the list can be strings or dictionaries) – 列表中查询可以是字符串或字典
queries. (weighted) – 加权查询。
k (int, optional) – 每个查询返回的文档数量。
4. (Defaults to) – 默认为 4。
kwargs (Any) –

返回

每个查询的结果列表。

Return type

List[List[Document]]

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

使用一批查询，从 Marqo 返回与查询相似的文档以及它们的分数。

参数

query (Iterable[Union[str, Dict[str, float]]]) – 查询的可迭代对象
bulk (to execute in) – 要批量执行
dictionaries (queries in the list can be strings or) – 列表中查询可以是字符串或字典
queries. (of weighted) – 加权查询。
k (int, optional) – 要返回的文档数量。默认为 4。
queries (Iterable[Union[str, Dict[str, float]]]) –
kwargs (Any) –

返回

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

Return type

List[Tuple[Document, float]]

delete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

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

参数

ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None，则删除全部。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则返回 True，否则返回 False，如果未实现，则返回 None。

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, **kwargs: Any) → Marqo[source]¶

从文档初始化并返回 VectorStore。请注意，Marqo 不需要嵌入，我们保留此参数是为了遵守 Liskov 替换原则。

参数

documents (List[Document]) – 输入文档
embedding (Any, optional) – 嵌入（不是必需的）。默认为 None。
kwargs (Any) –

返回

Marqo 向量存储

Return type

VectorStore

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

从文本初始化并返回 Marqo。请注意，Marqo 不需要嵌入，我们保留此参数是为了遵守 Liskov 替换原则。

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

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

示例： .. code-block:: python

from langchain_community.vectorstores import Marqo

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

参数

texts (List[str]) – 创建后要索引到 marqo 中的文本列表。
embedding (Any, optional) – 嵌入（不是必需的）。默认为 None。
index_name (str, optional) – 要使用的索引的名称，如果没有
None. (accompany the texts. Defaults to) – 伴随文本。默认为 None。
url (str, optional) – Marqo 的 URL。默认为 “http://localhost:8882”。
api_key (str, optional) – Marqo 的 API 密钥。默认为 “”。
metadatas (Optional[List[dict]], optional) – 元数据的列表，用于伴随文本。
None. – 默认为 None。
Can (this is only used when a new index is being created. Defaults to "cpu".) – 仅在创建新索引时使用。默认为 “cpu”。
"cuda". (be "cpu" or) – 可以是 “cpu” 或 “cuda”。
add_documents_settings (Optional[Dict[str, Any]], optional) – 添加文档的设置
documents (for adding) –
see – 请参阅
https – //docs.marqo.ai/0.0.16/API-Reference/documents/#query-parameters。
{}. (Defaults to) – 默认为 {}。
index_settings (Optional[Dict[str, Any]], optional) – 索引设置，如果索引不存在
exist (the index doesn't) –
see – 请参阅
https – //docs.marqo.ai/0.0.16/API-Reference/indexes/#index-defaults-object。
{}. – 默认为 {}。
searchable_attributes (Optional[List[str]]) –
page_content_builder (Optional[Callable[[Dict[str, str]], str]]) –
verbose (bool) –
kwargs (Any) –

返回

Marqo 向量存储的实例

Return type

Marqo

get_by_ids(ids: Sequence[str], /) → List[Document]¶

通过 ID 获取文档。

返回的文档应将 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 id 列表。
返回: 文档列表。
Return type: List[Document]

0.2.11 版本新增功能。

get_indexes() → List[Dict[str, str]][source]¶

帮助查看您在 marqo 中的可用索引，如果在未使用指定索引名称的情况下使用 from_texts 方法，则很有用

返回: 索引列表
Return type: List[Dict[str, str]]

get_number_of_documents() → int[source]¶

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

返回: 文档数量
Return type: int

marqo_bulk_similarity_search(queries: Iterable[Union[str, Dict[str, float]]], k: int = 4) → Dict[str, List[Dict[str, List[Dict[str, str]]]]][source]¶

从 Marqo 返回文档，使用批量搜索，直接公开 Marqo 的输出

参数

queries (Iterable[Union[str, Dict[str, float]]]) – 查询列表。
k (int, optional) – 每个查询返回的文档数量。
4. (Defaults to) – 默认为 4。

返回

批量搜索结果对象

Return type

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

marqo_similarity_search(query: Union[str, Dict[str, float]], k: int = 4) → Dict[str, List[Dict[str, str]]][source]¶

从 Marqo 返回文档，直接公开 Marqo 的输出

参数

query (str) – 用于搜索的查询。
k (int, optional) – 要返回的文档数量。默认为 4。

返回

这来自 marqo。

Return type

List[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 (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**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 (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Return type

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”, “mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

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

Return type

List[Document]

similarity_search(query: Union[str, Dict[str, float]], k: int = 4, **kwargs: Any) → List[Document][source]¶

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

参数

query (Union[str, Dict[str, float]]) – 搜索查询，可以是
query. (字符串 或加权) –
k (int, optional) – 要返回的文档数量。默认为 4。
kwargs (Any) –

返回

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

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Return type

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性评分，范围为 [0, 1]。

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

参数

query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集。

返回

（文档，相似度评分）元组列表。

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: Union[str, Dict[str, float]], k: int = 4) → List[Tuple[Document, float]][source]¶

从 Marqo 返回与查询相似的文档以及它们的分数。

参数

query (str) – 用于搜索的查询，可以是字符串或加权
query. –
k (int, optional) – 要返回的文档数量。默认为 4。

返回

匹配的文档及其得分，按得分降序排列。

Return type

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式 Upsert 文档。

参数

items (Iterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

Iterator[UpsertResponse]

0.2.11 版本新增功能。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

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

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回

响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增功能。

使用 Marqo 的示例¶

Marqo

langchain_community.vectorstores.marqo.Marqo¶

使用 Marqo 的示例¶

`langchain_community.vectorstores.marqo`.Marqo¶