Milvus#

class langchain_milvus.vectorstores.milvus.Milvus(embedding_function: Embeddings | BaseSparseEmbedding | List[Embeddings | BaseSparseEmbedding], collection_name: str = 'LangChainCollection', collection_description: str = '', collection_properties: dict[str, Any] | None = None, connection_args: dict[str, Any] | None = None, consistency_level: str = 'Session', index_params: dict | List[dict] | None = None, search_params: dict | List[dict] | None = None, drop_old: bool | None = False, auto_id: bool = False, *, primary_field: str = 'pk', text_field: str = 'text', vector_field: str | List[str] = 'vector', enable_dynamic_field: bool = False, metadata_field: str | None = None, partition_key_field: str | None = None, partition_names: list | None = None, replica_number: int = 1, timeout: float | None = None, num_shards: int | None = None, vector_schema: dict[str, Any] | List[dict[str, Any]] | None = None, metadata_schema: dict[str, Any] | None = None)[source]#

Milvus 向量存储集成。

Setup:

安装 langchain_milvus 包：

pip install -qU  langchain_milvus

Key init args — indexing params:

collection_name: str: 集合的名称。
collection_description: str: 集合的描述。
embedding_function: Union[Embeddings, BaseSparseEmbedding]: 使用的嵌入函数。

Key init args — client params:

connection_args: Optional[dict]: 连接参数。

Instantiate:

from langchain_milvus import Milvus
from langchain_openai import OpenAIEmbeddings

URI = "./milvus_example.db"

vector_store = Milvus(
    embedding_function=OpenAIEmbeddings(),
    connection_args={"uri": URI},
)

Add Documents:

from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"baz": "bar"})
document_2 = Document(page_content="thud", metadata={"baz": "baz"})
document_3 = Document(page_content="i will be deleted :(", metadata={"baz": "qux"})

documents = [document_1, document_2, document_3]
ids = ["1", "2", "3"]
vector_store.add_documents(documents=documents, ids=ids)

Delete Documents:

vector_store.delete(ids=["3"])

Search:

results = vector_store.similarity_search(query="thud",k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'baz': 'baz', 'pk': '2'}]

Search with filter:

results = vector_store.similarity_search(query="thud",k=1,filter={"bar": "baz"})
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'baz': 'baz', 'pk': '2'}]

Search with score:

results = vector_store.similarity_search_with_score(query="qux",k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.335463] foo [{'baz': 'bar', 'pk': '1'}]

Async:

# add documents
# await vector_store.aadd_documents(documents=documents, ids=ids)

# delete documents
# await vector_store.adelete(ids=["3"])

# search
# results = vector_store.asimilarity_search(query="thud",k=1)

# search with score
results = await vector_store.asimilarity_search_with_score(query="qux",k=1)
for doc,score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.335463] foo [{'baz': 'bar', 'pk': '1'}]

Use as Retriever:

retriever = vector_store.as_retriever(
    search_type="mmr",
    search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
)
retriever.invoke("thud")

[Document(metadata={'baz': 'baz', 'pk': '2'}, page_content='thud')]

初始化Milvus向量存储。

属性

`client`	获取客户端。
`embeddings`	如果可用，访问查询嵌入对象。

方法

`__init__`(embedding_function[, ...])	初始化 Milvus 向量存储。
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
`add_documents`(documents, **kwargs)	通过嵌入运行更多文档并将其添加到向量存储中。
`add_embeddings`(texts, embeddings[, ...])	将带有嵌入向量的文本数据插入到Milvus中。
`add_texts`(texts[, metadatas, timeout, ...])	将文本数据插入到Milvus中。
`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, expr])	通过向量ID或布尔表达式删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	创建一个 Milvus 集合，使用 HNSW 进行索引，并插入数据。
`get_by_ids`(ids, /)	通过ID获取文档。
`get_pks`(expr, **kwargs)	通过表达式获取主键
`max_marginal_relevance_search`(query[, k, ...])	执行搜索并返回按MMR重新排序的结果。
`max_marginal_relevance_search_by_vector`(...)	执行搜索并返回按MMR重新排序的结果。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, param, expr, ...])	对查询字符串执行相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	对查询字符串执行相似性搜索。
`similarity_search_with_relevance_scores`(query)	返回文档和相关度分数，范围在[0, 1]之间。
`similarity_search_with_score`(query[, k, ...])	对查询字符串执行搜索并返回带分数的结果。
`similarity_search_with_score_by_vector`(embedding)	在嵌入上执行搜索并返回带有分数的结果。
`upsert`([ids, documents])	更新/插入文档到向量存储。

Parameters:

embedding_function (Union[EmbeddingType, List[EmbeddingType]])
collection_name (str)
collection_description (str)
collection_properties (可选[字典[字符串, 任意类型]])
connection_args (可选[字典[字符串, 任意类型]])
consistency_level (str)
index_params (可选[联合[字典, 列表[字典]]])
search_params (可选[联合[字典, 列表[字典]]])
drop_old (可选[布尔型])
auto_id (bool)
primary_field (str)
text_field (str)
vector_field (联合[字符串, 列表[字符串]])
enable_dynamic_field (bool)
metadata_field (可选[str])
partition_key_field (可选[str])
partition_names (可选[列表])
replica_number (int)
timeout (可选[float])
num_shards (可选[整数])
vector_schema (可选[联合[字典[字符串, 任意], 列表[字典[字符串, 任意]]]])
metadata_schema (可选[字典[字符串, 任意类型]])

__init__(embedding_function: Embeddings | BaseSparseEmbedding | List[Embeddings | BaseSparseEmbedding], collection_name: str = 'LangChainCollection', collection_description: str = '', collection_properties: dict[str, Any] | None = None, connection_args: dict[str, Any] | None = None, consistency_level: str = 'Session', index_params: dict | List[dict] | None = None, search_params: dict | List[dict] | None = None, drop_old: bool | None = False, auto_id: bool = False, *, primary_field: str = 'pk', text_field: str = 'text', vector_field: str | List[str] = 'vector', enable_dynamic_field: bool = False, metadata_field: str | None = None, partition_key_field: str | None = None, partition_names: list | None = None, replica_number: int = 1, timeout: float | None = None, num_shards: int | None = None, vector_schema: dict[str, Any] | List[dict[str, Any]] | None = None, metadata_schema: dict[str, Any] | None = None)[来源]#

初始化Milvus向量存储。

Parameters:

embedding_function (Embeddings | BaseSparseEmbedding | List[Embeddings | BaseSparseEmbedding])
collection_name (str)
collection_description (str)
collection_properties (dict[str, Any] | None)
connection_args (dict[str, Any] | None)
consistency_level (str)
index_params (dict | List[dict] | None)
search_params (dict | List[dict] | None)
drop_old (bool | None)
auto_id (bool)
primary_field (str)
text_field (str)
vector_field (str | List[str])
enable_dynamic_field (bool)
metadata_field (str | None)
partition_key_field (str | None)
partition_names (列表 | 无)
replica_number (int)
timeout (float | None)
num_shards (int | None)
vector_schema (字典[字符串, 任意类型] | 列表[字典[字符串, 任意类型]] | 无)
metadata_schema (dict[str, Any] | None)

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][source]#

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

Parameters:

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

Returns:

已添加文本的ID列表。

Return type:

列表[str]

add_embeddings(texts: List[str], embeddings: List[List[float]] | List[List[List[float]]], metadatas: List[dict] | None = None, timeout: float | None = None, batch_size: int = 1000, *, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

将带有嵌入向量的文本数据插入到Milvus中。

此方法将一批文本嵌入插入到Milvus集合中。如果集合未初始化，它将根据嵌入、元数据和其他参数自动初始化集合。嵌入应使用兼容的嵌入函数预先生成，与每个文本关联的元数据是可选的，但必须与文本数量匹配。

Parameters:

texts (List[str]) – 要插入的文本
embeddings (List[List[Union[float, List[float]]]]) – 每个文本的向量嵌入（在单个向量的情况下）或每个文本的向量列表（在多向量的情况下）
metadatas (Optional[List[dict]]) – 附加到每个文本的元数据字典。默认为 None。
错误。 (应小于65535字节。当auto_id为时必需且有效)
timeout (可选[float]) – 每次批量插入的超时时间。默认为 None。
batch_size (int, optional) – 用于插入的批量大小。默认为1000。
ids (可选[列表[字符串]]) – 文本ID列表。每个项目的长度
kwargs (Any)

Raises:

MilvusException – 添加文本和嵌入失败

Returns:

每个插入元素的生成键。

Return type:

列表[str]

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

将文本数据插入到Milvus中。

当集合尚未创建时插入数据将导致创建一个新的集合。第一个实体的数据决定了新集合的模式，维度从第一个嵌入中提取，列由第一个元数据字典决定。所有插入的值都需要存在元数据键。目前Milvus中没有等效于None的值。

Parameters:

texts (Iterable[str]) – 要嵌入的文本，假设它们都适合在内存中。
metadatas (Optional[List[dict]]) – 附加到每个文本的元数据字典。默认为 None。
错误。 (应小于65535字节。当auto_id为时必需且有效)
timeout (可选[float]) – 每次批量插入的超时时间。默认为 None。
batch_size (int, optional) – 用于插入的批量大小。默认为1000。
ids (可选[列表[字符串]]) – 文本ID列表。每个项目的长度
kwargs (Any)

Raises:

MilvusException – 添加文本失败

Returns:

每个插入元素的生成键。

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

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

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

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

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]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → list[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, expr: str | None = None, **kwargs: str)[source]#

通过向量ID或布尔表达式删除。请参考[Milvus文档](https://milvus.io/docs/delete_data.md) 获取表达式的注意事项和示例。

Parameters:

ids (List[str] | None) – 要删除的ID列表。
expr (str | None) – 布尔表达式，指定要删除的实体。
kwargs (str) – Milvus 删除 API 中的其他参数。

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings | BaseSparseEmbedding | List[Embeddings | BaseSparseEmbedding], metadatas: List[dict] | None = None, collection_name: str = 'LangChainCollection', connection_args: Dict[str, Any] | None = None, consistency_level: str = 'Session', index_params: dict | List[dict] | None = None, search_params: dict | List[dict] | None = None, drop_old: bool = False, *, ids: List[str] | None = None, auto_id: bool = False, **kwargs: Any) → Milvus[source]#

创建一个Milvus集合，使用HNSW进行索引，并插入数据。

Parameters:

texts (List[str]) – 文本数据。
embedding (Union[Embeddings, BaseSparseEmbedding]) – 嵌入函数。
metadatas (Optional[List[dict]]) – 每个文本的元数据（如果存在）。默认为 None。
collection_name (str, optional) – 使用的集合名称。默认为 “LangChainCollection”。
connection_args (dict[str, Any], optional) – 要使用的连接参数。默认为DEFAULT_MILVUS_CONNECTION。
consistency_level (str, optional) – 使用哪种一致性级别。默认为“Session”。
index_params (可选[字典], 可选) – 使用哪个index_params。默认为None。
search_params (Optional[dict], optional) – 使用哪些搜索参数。默认为 None。
drop_old (可选[bool], 可选) – 如果存在同名集合，是否删除该集合。默认为 False。
ids (可选[列表[字符串]]) – 文本ID列表。默认为None。
auto_id (bool) – 是否为主键启用自动ID。默认为False。如果为False，您需要提供文本ID（小于65535字节的字符串）。如果为True，Milvus将生成唯一的整数作为主键。
kwargs (Any)

Returns:

Milvus 向量存储

Return type:

Milvus

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_pks(expr: str, **kwargs: Any) → List[int] | None[source]#

获取带有表达式的主键

Parameters:

expr (str) – 表达式 - 例如: “id in [1, 2]”, 或 “title LIKE ‘Abc%’”
kwargs (Any)

Returns:

ID列表（主键）

Return type:

整数列表

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Document][source]#

执行搜索并返回按MMR重新排序的结果。

Parameters:

query (str) – 被搜索的文本。
k (int, optional) – 返回多少个结果。默认为4。
fetch_k (int, optional) – 从总结果中选择k个。默认为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5
param (dict, optional) – 指定索引的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (float, optional) – 在超时错误发生前等待的时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

Returns:

搜索的文档结果。

Return type:

列表[Document]

max_marginal_relevance_search_by_vector(embedding: list[float] | dict[int, float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Document][source]#

执行搜索并返回按MMR重新排序的结果。

Parameters:

embedding (list[float] | dict[int, float]) – 正在搜索的嵌入向量。
k (int, optional) – 返回多少个结果。默认为4。
fetch_k (int, optional) – 从总结果中选择k个。默认为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5
param (dict, optional) – 指定索引的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (float, optional) – 在超时错误发生前等待的时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

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]

similarity_search(query: str, k: int = 4, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Document][source]#

对查询字符串执行相似性搜索。

Parameters:

query (str) – 要搜索的文本。
k (int, optional) – 返回多少结果。默认为4。
param (dict, optional) – 索引类型的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (int, optional) – 在超时错误发生前等待多长时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

Returns:

搜索的文档结果。

Return type:

列表[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Document][来源]#

对查询字符串执行相似性搜索。

Parameters:

embedding (List[float]) – 要搜索的嵌入向量。
k (int, optional) – 返回多少结果。默认为4。
param (dict, optional) – 索引类型的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (int, optional) – 在超时错误发生前等待多长时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

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, k: int = 4, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

对查询字符串执行搜索并返回带有分数的结果。

有关搜索参数的更多信息，请查看pymilvus文档，文档位于： https://milvus.io/api-reference/pymilvus/v2.4.x/ORM/Collection/search.md

Parameters:

query (str) – 被搜索的文本。
k (int, optional) – 返回的结果数量。默认为4。
param (dict) – 指定索引的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (float, optional) – 在超时错误发生前等待的时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

Return type:

List[float], List[Tuple[Document, any, any]]

similarity_search_with_score_by_vector(embedding: List[float] | Dict[int, float], k: int = 4, param: dict | None = None, expr: str | None = None, timeout: float | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

在嵌入上执行搜索并返回带有分数的结果。

有关搜索参数的更多信息，请查看pymilvus文档，链接如下： https://milvus.io/api-reference/pymilvus/v2.4.x/ORM/Collection/search.md

Parameters:

embedding (List[float] | Dict[int, float]) – 正在搜索的嵌入向量。
k (int, optional) – 返回的结果数量。默认为4。
param (dict) – 指定索引的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (float, optional) – 在超时错误发生前等待的时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

Returns:

结果文档和分数。

Return type:

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

upsert(ids: List[str] | None = None, documents: List[Document] | None = None, **kwargs: Any) → List[str] | None[source]#

更新/插入文档到向量存储。

Parameters:

ids (List[str] | None) – 要更新的ID - 让我们调用get_pks来获取带有表达式的ID
documents (List[Document]) – 要添加到向量存储中的文档。
kwargs (Any)

Returns:

添加的文本的ID。

Return type:

列表[str]

使用 Milvus 的示例