`langchain_milvus.vectorstores.zilliz`.Zilliz¶

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

Zilliz 向量存储。

您需要安装 pymilvus 并运行 Zilliz 数据库。

请参阅以下文档，了解如何运行 Zilliz 实例: https://docs.zilliz.com/docs/create-cluster

如果使用 L2/IP 指标，强烈建议对数据进行标准化处理。

参数 (Parameters)

embedding_function (Embeddings) – 用于嵌入文本的函数。
collection_name (str) – 要使用的 Zilliz 集合。默认为 “LangChainCollection”。
connection_args (Optional[dict[str, any]]) – 此类使用的连接参数以字典形式提供。
consistency_level (str) – 集合使用的一致性级别。默认为 “Session”。
index_params (Optional[dict]) – 要使用的索引参数。默认为 HNSW/AUTOINDEX，取决于服务。
search_params (Optional[dict]) – 要使用的搜索参数。默认为索引的默认值。
drop_old (Optional[bool]) – 是否删除当前集合。默认为 False。
auto_id (bool) – 是否为 primary key 启用自动 ID。默认为 False。如果为 False，则需要提供文本 ID（小于 65535 字节的字符串）。如果为 True，Milvus 将生成唯一的整数作为 primary key。
collection_description (str) –
collection_properties (Optional[dict[str, Any]]) –
primary_field (str) –
text_field (str) –
vector_field (str) –
enable_dynamic_field (bool) –
metadata_field (Optional[str]) –
partition_key_field (Optional[str]) –
partition_names (Optional[list]) –
replica_number (int) –
timeout (Optional[float]) –
num_shards (Optional[int]) –

此类使用的连接参数以字典形式提供，以下是一些选项：

address (str): Zilliz 的实际地址
实例。示例地址：“localhost:19530”

uri (str): Zilliz 实例的 URI。示例 URI
“https://in03-ba4234asae.api.gcp-us-west1.zillizcloud.com”,

host (str): Zilliz 实例的主机。默认为 “localhost”，
如果仅提供端口，PyMilvus 将填充默认主机。

port (str/int): Zilliz 实例的端口。默认为 19530，PyMilvus
如果仅提供主机，PyMilvus 将填充默认端口。

user (str): 用于连接到 Zilliz 实例的用户名。如果提供用户名和
密码，我们将在每次 RPC 调用中添加相关标头。

password (str): 当提供用户名时为必填项。与用户
对应的密码。

token (str): API 密钥，用于无服务器集群，可以替代
用户名和密码。

secure (bool): 默认为 false。如果设置为 true，将启用 tls。 client_key_path (str): 如果使用 tls 双向身份验证，则需要

写入 client.key 路径。

client_pem_path (str): 如果使用 tls 双向身份验证，则需要
写入 client.pem 路径。

ca_pem_path (str): 如果使用 tls 双向身份验证，则需要写入
ca.pem 路径。

server_pem_path (str): 如果使用 tls 单向身份验证，则需要
写入 server.pem 路径。

server_name (str): 如果使用 tls，则需要写入通用名称。

示例 (Example)

from langchain_community.vectorstores import Zilliz from langchain_community.embeddings import OpenAIEmbeddings

embedding = OpenAIEmbeddings() # 连接到 Zilliz 实例 milvus_store = Milvus(

embedding_function = embedding, collection_name = “LangChainCollection”, connection_args = {

“uri”: “https://in03-ba4234asae.api.gcp-us-west1.zillizcloud.com”, “user”: “temp”, “password”: “temp”, “token”: “temp”, # API 密钥，替代用户名和密码 “secure”: True

} drop_old: True,

)

Raises

ValueError – 如果未安装 pymilvus python 包。

参数 (Parameters)

embedding_function (Embeddings) –
collection_name (str) –
collection_description (str) –
collection_properties (Optional[dict[str, Any]]) –
connection_args (Optional[dict[str, Any]]) –
consistency_level (str) –
index_params (Optional[dict]) –
search_params (Optional[dict]) –
drop_old (Optional[bool]) –
auto_id (bool) –
primary_field (str) –
text_field (str) –
vector_field (str) –
enable_dynamic_field (bool) –
metadata_field (Optional[str]) –
partition_key_field (Optional[str]) –
partition_names (Optional[list]) –
replica_number (int) –
timeout (Optional[float]) –
num_shards (Optional[int]) –

初始化 Milvus 向量存储。

属性 (Attributes)

embeddings

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

方法 (Methods)

`__init__`(embedding_function[, ...])	初始化 Milvus 向量存储。
`aadd_documents`(documents, **kwargs)	通过嵌入运行更多文档并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步通过嵌入运行更多文本并添加到向量存储。
`add_documents`(documents, **kwargs)	通过嵌入运行更多文档并添加到向量存储。
`add_texts`(texts[, metadatas, timeout, ...])	将文本数据插入到 Milvus 中。
`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)
`delete`([ids, expr])	通过向量 ID 或布尔表达式删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	创建 Zilliz 集合，使用 HNSW 对其进行索引，并插入数据。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`get_pks`(expr, **kwargs)	使用表达式获取 primary key
`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)	对嵌入执行搜索，并返回带分数的结果。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`([ids, documents])	更新/插入文档到向量存储。

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

初始化 Milvus 向量存储。

参数 (Parameters)

embedding_function (Embeddings) –
collection_name (str) –
collection_description (str) –
collection_properties (Optional[dict[str, Any]]) –
connection_args (Optional[dict[str, Any]]) –
consistency_level (str) –
index_params (Optional[dict]) –
search_params (Optional[dict]) –
drop_old (Optional[bool]) –
auto_id (bool) –
primary_field (str) –
text_field (str) –
vector_field (str) –
enable_dynamic_field (bool) –
metadata_field (Optional[str]) –
partition_key_field (Optional[str]) –
partition_names (Optional[list]) –
replica_number (int) –
timeout (Optional[float]) –
num_shards (Optional[int]) –

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

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

参数 (Parameters)

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

返回值 (Returns)

添加的文本的 ID 列表。

返回类型 (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]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回值 (Returns)

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

Raises

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

返回类型 (Return type)

List[str]

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

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

参数 (Parameters)

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

返回值 (Returns)

添加的文本的 ID 列表。

返回类型 (Return type)

List[str]

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

将文本数据插入到 Milvus 中。

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

参数 (Parameters)

texts (Iterable[str]) – 要嵌入的文本的可迭代对象，假设它们都适合内存。
metadatas (Optional[List[dict]]) – 附加到每个文本的元数据字典的可选列表。默认为 None。
False. (should be less than 65535 bytes. Required and work when auto_id is) –
timeout (Optional[float]) – 每次批量插入的超时时间。默认为 None。
batch_size (int, optional) – 用于插入的批量大小。默认为 1000。
ids (Optional[List[str]]) – 文本 ID 列表。每个项目的长度
kwargs (Any) –

Raises

MilvusException – 添加文本失败

返回值 (Returns)

每个插入元素的最终键。

返回类型 (Return type)

List[str]

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

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

参数 (Parameters)

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

返回值 (Returns)

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

返回类型 (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) – 附加关键字参数。

返回值 (Returns)

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

返回类型 (Return type)

VectorStore

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]]) – 与文本关联的可选元数据列表。默认为 None。
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): 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]¶

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

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

参数 (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)

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) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，确定结果之间多样性的程度，0 表示最大多样性，1 表示最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回值 (Returns)

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

返回类型 (Return type)

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此 VectorStore 初始化的 VectorStoreRetriever。

参数 (Parameters)

**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: 按文档元数据过滤

返回值 (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)

List[Document]

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

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

参数 (Parameters)

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

返回值 (Returns)

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

返回类型 (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) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回值 (Returns)

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

返回类型 (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 表示最相似。

参数 (Parameters)

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

过滤检索到的文档结果集

返回值 (Returns)

(doc, similarity_score) 元组列表

返回类型 (Return type)

List[Tuple[Document, float]]

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

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

参数 (Parameters)

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

返回值 (Returns)

(doc, similarity_score) 元组列表。

返回类型 (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 的异步版本。

参数 (Parameters)

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可异步迭代对象。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ID 以避免语义不明确。相反，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 字段，则更新功能应使用该字段。如果未提供 ID，则更新方法可以自由地为文档生成 ID。

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

参数 (Parameters)

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

返回值 (Returns)

响应对象，其中包含向量存储中成功添加或更新的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型 (Return type)

UpsertResponse

0.2.11 版本新增。

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

按向量 ID 或布尔表达式删除。有关表达式的说明和示例，请参阅 [Milvus 文档](https://milvus.io/docs/delete_data.md)。

参数 (Parameters)

ids (Optional[List[str]]) – 要删除的 ID 列表。
expr (Optional[str]) – 指定要删除的实体的布尔表达式。
kwargs (str) – Milvus delete 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, metadatas: Optional[List[dict]] = None, collection_name: str = 'LangChainCollection', connection_args: Optional[Dict[str, Any]] = None, consistency_level: str = 'Session', index_params: Optional[dict] = None, search_params: Optional[dict] = None, drop_old: bool = False, *, ids: Optional[List]str]] = None, auto_id: bool = False, **kwargs: Any) → Zilliz[source]¶

创建 Zilliz 集合，使用 HNSW 对其进行索引，并插入数据。

参数 (Parameters)

texts (List[str]) – 文本数据。
embedding (Embeddings) – 嵌入函数。
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 (Optional[dict], optional) – 要使用的索引参数。默认为 None。
search_params (Optional[dict], optional) – 要使用的搜索参数。默认为 None。
drop_old (Optional[bool], optional) – 如果具有该名称的集合已存在，是否删除它。默认为 False。
ids (Optional[List[str]]) – 文本 ID 列表。
auto_id (bool) – 是否为 primary key 启用自动 ID。默认为 False。如果为 False，则需要提供文本 ID（小于 65535 字节的字符串）。如果为 True，Milvus 将生成唯一的整数作为 primary key。
kwargs (Any) –

返回值 (Returns)

Zilliz 向量数据库

返回类型 (Return type)

Zilliz

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

通过 ID 获取文档。

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

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

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

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

参数 (Parameters): ids (Sequence[str]) – 要检索的 ID 列表。
返回值 (Returns): 文档列表。
返回类型 (Return type): List[Document]

0.2.11 版本新增。

get_pks(expr: str, **kwargs: Any) → Optional[List]int]]¶

使用表达式获取 primary key

参数 (Parameters)

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

返回值 (Returns)

ID 列表 (主键)

返回类型 (Return type)

List[int]

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

执行搜索并返回按 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)

List[Document]

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

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

参数 (Parameters)

embedding (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)

List[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)

List[Document]

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

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

参数 (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)

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[float] = 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)

List[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)

(doc, similarity_score) 元组列表。

返回类型 (Return type)

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[float] = None, **kwargs: Any) → List[Tuple[Document, float]]¶

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

有关搜索参数的更多信息，请参阅 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], k: int = 4, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[float] = 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]) – 正在搜索的嵌入向量。
k (int, optional) – 返回的结果数量。默认为 4。
param (dict) – 指定索引的搜索参数。默认为 None。
expr (str, optional) – 过滤表达式。默认为 None。
timeout (float, optional) – 在超时错误之前等待多长时间。默认为 None。
kwargs (Any) – Collection.search() 关键字参数。

返回值 (Returns)

结果文档和分数。

返回类型 (Return type)

List[Tuple[Document, float]]

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

Beta

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

以流式方式更新文档。

参数 (Parameters)

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

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

参数 (Parameters)

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

返回值 (Returns)

添加的文本的 ID。

返回类型 (Return type)

List[str]

langchain_milvus.vectorstores.zilliz.Zilliz¶

`langchain_milvus.vectorstores.zilliz`.Zilliz¶