langchain_community.vectorstores.milvus
.Milvus¶
- class langchain_community.vectorstores.milvus.Milvus(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', 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]¶
`Milvus`向量存储。
您需要安装`pymilvus`并运行Milvus。
请查看以下文档以了解如何运行Milvus实例: https://milvus.io/docs/install_standalone-docker.md
如果正在寻找托管的Milvus,请查看此文档: https://zilliz.com/cloud 并使用在此项目中找到的Zilliz向量存储。
如果使用L2/IP度量,强烈建议对数据进行归一化。
- 参数:
embedding_function (Embeddings): 用于嵌入文本的函数。 collection_name (str): 要使用的Milvus集合。默认为”LangChainCollection”。 collection_description (str): 集合的描述。默认为空。 collection_properties (Optional[dict[str, any]]): 集合属性。默认为None。
如果设置,将覆盖集合的现有属性。 例如: {“collection.ttl.seconds”: 60}。
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): 是否启用主键的自动id。默认为False。
如果为False,您需要提供文本id(小于65535字节的字符串)。 如果为True,Milvus将生成唯一整数作为主键。
primary_field (str): 主键字段的名称。默认为”pk”。 text_field (str): 文本字段的名称。默认为”text”。 vector_field (str): 向量字段的名称。默认为”vector”。 metadata_field (str): 元数据字段的名称。默认为None。
当指定metadata_field时, 文档的元数据将存储为json。
用于此类的连接参数以字典形式提供, 这里是一些选项:
- address (str): Milvus实例的实际地址。
示例地址: “localhost:19530”。
- uri (str): Milvus实例的uri。
示例uri: “http://randomwebsite:19530”, “tcp:foobarsite:19530”, “https://ok.s3.south.com:19530”。
- host (str): Milvus实例的主机。默认为”localhost”,
如果只提供端口,PyMilvus将填充默认主机。
- port (str/int): Milvus实例的端口。默认为19530,
如果只提供主机,PyMilvus将填充默认端口。
- user (str): 用于连接到Milvus实例的用户。
如果提供了用户和密码,我们将在每个RPC调用中添加相关的标头。
password (str): 在提供用户时需要。与用户对应的密码。 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,需要写入通用名称。
- 示例:
from langchain_community.vectorstores import Milvus from langchain_community.embeddings import OpenAIEmbeddings
embedding = OpenAIEmbeddings() # 连接到本地主机上的milvus实例 milvus_store = Milvus(
embedding_function = Embeddings, collection_name = “LangChainCollection”, drop_old = True, auto_id = True
)
- 引发:
ValueError: 如果未安装pymilvus python包。
初始化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。
amax_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从此VectorStore初始化的VectorStoreRetriever。
asearch
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
asimilarity_search
(query[, k])返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性分数在范围[0, 1]内,异步执行。
asimilarity_search_with_score
(*args, **kwargs)使用异步方式运行相似性搜索与距离。
delete
([ids, expr])根据向量ID或布尔表达式删除。 请参考[Milvus文档](https://milvus.io/docs/delete_data.md)查看表达式的说明和示例。
from_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
from_texts
(texts, embedding[, metadatas, ...])创建一个Milvus集合,使用HNSW对其进行索引,并插入数据。
get_pks
(expr, **kwargs)获取带有表达式的主键
max_marginal_relevance_search
(query[, k, ...])执行搜索并返回按MMR重新排序的结果。
执行搜索并返回按MMR重新排序的结果。
search
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
similarity_search
(query[, k, param, expr, ...])对查询字符串执行相似性搜索。
similarity_search_by_vector
(embedding[, k, ...])对查询字符串执行相似性搜索。
返回文档和相关性得分在[0, 1]范围内。
similarity_search_with_score
(query[, k, ...])对查询字符串执行搜索,并返回带有分数的结果。
similarity_search_with_score_by_vector
(embedding)对查询字符串执行搜索,并返回带有分数的结果。
upsert
([ids, documents])更新/插入文档到向量存储。
- 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) –
metadata_field (Optional[str]) –
partition_key_field (Optional[str]) –
partition_names (Optional[list]) –
replica_number (int) –
timeout (Optional[float]) –
num_shards (Optional[int]) –
- __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', 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]¶
初始化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) –
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] ¶
运行更多的文档通过嵌入并添加到向量存储中。
- 参数:
documents (List[Document]): 要添加到向量存储中的文档。
- 返回:
List[str]: 添加的文本的ID列表。
- Parameters
documents (List[Document]) –
kwargs (Any) –
- 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]]) –
kwargs (Any) –
- Return type
List[str]
- add_documents(documents: List[Document], **kwargs: Any) List[str] ¶
运行更多的文档通过嵌入并添加到向量存储中。
- 参数:
documents (List[Document]): 要添加到向量存储中的文档。
- 返回:
List[str]: 添加的文本的ID列表。
- Parameters
documents (List[Document]) –
kwargs (Any) –
- 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] [source]¶
将文本数据插入Milvus。
在尚未创建集合时插入数据将导致创建新的集合。第一个实体的数据决定了新集合的模式,dim从第一个嵌入中提取,列由第一个元数据字典决定。所有插入的值都需要存在元数据键。目前在Milvus中没有None的等价物。
- 参数:
texts (Iterable[str]): 要嵌入的文本,假定它们都适合内存。 metadatas (Optional[List[dict]]): 附加到每个文本的元数据字典。默认为None。 应小于65535字节。在auto_id为False时是必需的并且有效。 timeout (Optional[float]): 每个批次插入的超时时间。默认为None。 batch_size (int, optional): 用于插入的批次大小。默认为1000。 ids (Optional[List[str]]): 文本id列表。每个项目的长度
- 引发:
MilvusException: 添加文本失败
- 返回:
List[str]: 每个插入元素的结果键。
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
timeout (Optional[float]) –
batch_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
List[str]
- async adelete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
根据向量ID或其他条件进行删除。
- 参数:
ids:要删除的ID列表。 **kwargs:子类可能使用的其他关键字参数。
- 返回:
Optional[bool]:如果删除成功则为True,否则为False,如果未实现则为None。
- Parameters
ids (Optional[List[str]]) –
kwargs (Any) –
- 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) –
- Return type
VST
- 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]]) –
kwargs (Any) –
- Return type
VST
- async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 fetch_k:要获取以传递给MMR算法的文档数量。 lambda_mult:0到1之间的数字,确定结果之间多样性的程度,0对应最大多样性,1对应最小多样性。默认为0.5。
- 返回:
由最大边际相关性选择的文档列表。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
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] ¶
返回使用最大边际相关性选择的文档。
- Parameters
embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –
- Return type
List[Document]
- as_retriever(**kwargs: Any) VectorStoreRetriever ¶
返回从此VectorStore初始化的VectorStoreRetriever。
- 参数:
- search_type(可选[str]):定义Retriever应执行的搜索类型。
可以是”similarity”(默认值)、”mmr”或”similarity_score_threshold”。
- search_kwargs(可选[Dict]):传递给搜索函数的关键字参数。可以包括:
k:要返回的文档数量(默认值:4) score_threshold:用于similarity_score_threshold的最小相关性阈值 fetch_k:传递给MMR算法的文档数量(默认值:20) lambda_mult:MMR返回结果的多样性;1表示最小多样性,0表示最大多样性(默认值:0.5) filter:按文档元数据筛选
- 返回:
VectorStoreRetriever:VectorStore的Retriever类。
示例:
# 检索更多具有更高多样性的文档 # 如果数据集中有许多相似的文档,则很有用 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 6, 'lambda_mult': 0.25} ) # 为MMR算法考虑更多文档 # 但只返回前5个 docsearch.as_retriever( search_type="mmr", search_kwargs={'k': 5, 'fetch_k': 50} ) # 仅检索具有特定阈值以上相关性分数的文档 docsearch.as_retriever( search_type="similarity_score_threshold", search_kwargs={'score_threshold': 0.8} ) # 仅从数据集中获取最相似的单个文档 docsearch.as_retriever(search_kwargs={'k': 1}) # 使用筛选器仅从特定论文中检索文档 docsearch.as_retriever( search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}} )
- Parameters
kwargs (Any) –
- Return type
- async asearch(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型的查询最相似的文档。
- Parameters
query (str) –
search_type (str) –
kwargs (Any) –
- Return type
List[Document]
- async asimilarity_search(query: str, k: int = 4, **kwargs: Any) List[Document] ¶
返回与查询最相似的文档。
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- 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) –
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:输入文本 k:要返回的文档数量。默认为4。 **kwargs:要传递给相似性搜索的kwargs。应包括:
score_threshold:可选,介于0到1之间的浮点值,用于过滤检索到的文档集
- 返回:
元组列表(doc,相似度分数)的列表
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- async asimilarity_search_with_score(*args: Any, **kwargs: Any) List[Tuple[Document, float]] ¶
使用异步方式运行相似性搜索与距离。
- Parameters
args (Any) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- delete(ids: Optional[List[str]] = None, expr: Optional[str] = None, **kwargs: str)[source]¶
根据向量ID或布尔表达式删除。 请参考[Milvus文档](https://milvus.io/docs/delete_data.md)查看表达式的说明和示例。
- 参数:
ids: 要删除的ID列表。 expr: 指定要删除的实体的布尔表达式。 kwargs: Milvus删除API中的其他参数。
- Parameters
ids (Optional[List[str]]) –
expr (Optional[str]) –
kwargs (str) –
- classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
返回从文档和嵌入初始化的VectorStore。
- Parameters
documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –
- Return type
VST
- classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, collection_name: str = 'LangChainCollection', connection_args: dict[str, Any] = {'host': 'localhost', 'password': '', 'port': '19530', 'secure': False, 'user': ''}, consistency_level: str = 'Session', index_params: Optional[dict] = None, search_params: Optional[dict] = None, drop_old: bool = False, *, ids: Optional[List[str]] = None, **kwargs: Any) Milvus [source]¶
创建一个Milvus集合,使用HNSW对其进行索引,并插入数据。
- 参数:
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): 要使用的index_params。默认为None。 search_params (Optional[dict], optional): 要使用的搜索参数。默认为None。 drop_old (Optional[bool], optional): 如果存在,是否删除该名称的集合。默认为False。 ids (Optional[List[str]]): 文本id列表。默认为None。
- 返回:
Milvus: Milvus向量存储器
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
connection_args (dict[str, Any]) –
consistency_level (str) –
index_params (Optional[dict]) –
search_params (Optional[dict]) –
drop_old (bool) –
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
- get_pks(expr: str, **kwargs: Any) Optional[List[int]] [source]¶
获取带有表达式的主键
- 参数:
expr: 表达式 - 例如:”id in [1, 2]”,或者 “title LIKE ‘Abc%’”
- 返回:
List[int]: ID列表(主键)
- Parameters
expr (str) –
kwargs (Any) –
- Return type
Optional[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] [source]¶
执行搜索并返回按MMR重新排序的结果。
- 参数:
query (str): 要搜索的文本。 k (int, optional): 要返回的结果数量。默认为4。 fetch_k (int, optional): 从中选择k的总结果数量。默认为20。 lambda_mult: 介于0和1之间的数字,确定结果之间多样性的程度,其中0对应最大多样性,1对应最小多样性。默认为0.5。 param (dict, optional): 指定索引的搜索参数。默认为None。 expr (str, optional): 过滤表达式。默认为None。 timeout (float, optional): 超时错误前等待的时间。默认为None。 kwargs: Collection.search()的关键字参数。
- 返回:
List[Document]: 搜索的文档结果。
- Parameters
query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
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, param: Optional[dict] = None, expr: Optional[str] = None, timeout: Optional[float] = None, **kwargs: Any) List[Document] [source]¶
执行搜索并返回按MMR重新排序的结果。
- 参数:
embedding (str): 正在搜索的嵌入向量。 k (int, optional): 要返回的结果数量。默认为4。 fetch_k (int, optional): 从中选择k的总结果数量。默认为20。 lambda_mult: 介于0和1之间的数字,确定结果之间多样性的程度,其中0对应于最大多样性,1对应于最小多样性。默认为0.5。 param (dict, optional): 指定索引的搜索参数。默认为None。 expr (str, optional): 过滤表达式。默认为None。 timeout (float, optional): 超时错误前等待的时间长度。默认为None。 kwargs: Collection.search()的关键字参数。
- 返回:
List[Document]: 搜索的文档结果。
- Parameters
embedding (list[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
kwargs (Any) –
- Return type
List[Document]
- search(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型的查询最相似的文档。
- Parameters
query (str) –
search_type (str) –
kwargs (Any) –
- 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] [source]¶
对查询字符串执行相似性搜索。
- 参数:
query (str):要搜索的文本。 k (int, 可选):要返回的结果数量。默认为4。 param (dict, 可选):索引类型的搜索参数。默认为None。 expr (str, 可选):过滤表达式。默认为None。 timeout (int, 可选):超时错误前等待的时间。默认为None。 kwargs:Collection.search() 的关键字参数。
- 返回:
List[Document]:搜索的文档结果。
- Parameters
query (str) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
kwargs (Any) –
- 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] [source]¶
对查询字符串执行相似性搜索。
- 参数:
embedding(List[float]):要搜索的嵌入向量。 k(int,可选):要返回的结果数量。默认为4。 param(dict,可选):索引类型的搜索参数。默认为None。 expr(str,可选):过滤表达式。默认为None。 timeout(int,可选):超时错误前等待的时间。默认为None。 kwargs:Collection.search()的关键字参数。
- 返回:
List[Document]:搜索的文档结果。
- Parameters
embedding (List[float]) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
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:输入文本 k:要返回的文档数量。默认为4。 **kwargs:要传递给相似性搜索的kwargs。应包括:
score_threshold:可选,介于0到1之间的浮点值,用于过滤检索到的文档集
- 返回:
元组列表(doc,相似性得分)
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- 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]] [source]¶
对查询字符串执行搜索,并返回带有分数的结果。
有关搜索参数的更多信息,请查看pymilvus文档,网址如下: https://milvus.io/api-reference/pymilvus/v2.2.6/Collection/search().md
- 参数:
query (str): 要搜索的文本。 k (int, 可选): 要返回的结果数量。默认为4。 param (dict): 指定索引的搜索参数。默认为None。 expr (str, 可选): 过滤表达式。默认为None。 timeout (float, 可选): 超时错误前等待的时间。默认为None。 kwargs: Collection.search() 的关键字参数。
- 返回:
List[float], List[Tuple[Document, any, any]]:
- Parameters
query (str) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- 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]] [source]¶
对查询字符串执行搜索,并返回带有分数的结果。
有关搜索参数的更多信息,请查看pymilvus文档,链接如下: https://milvus.io/api-reference/pymilvus/v2.2.6/Collection/search().md
- 参数:
embedding(List[float]):要搜索的嵌入向量。 k(int,可选):要返回的结果数量。默认为4。 param(dict):指定索引的搜索参数。默认为None。 expr(str,可选):过滤表达式。默认为None。 timeout(float,可选):超时错误前的等待时间。默认为None。 kwargs:Collection.search()的关键字参数。
- 返回:
List[Tuple[Document, float]]:结果文档和分数。
- Parameters
embedding (List[float]) –
k (int) –
param (Optional[dict]) –
expr (Optional[str]) –
timeout (Optional[float]) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- upsert(ids: Optional[List[str]] = None, documents: Optional[List[Document]] = None, **kwargs: Any) Optional[List[str]] [source]¶
更新/插入文档到向量存储。
- 参数:
ids: 要更新的ID - 让我们调用get_pks来获取带有表达式的ID documents(List[Document]):要添加到向量存储的文档。
- 返回:
List[str]:已添加文本的ID。
- Parameters
ids (Optional[List[str]]) –
documents (Optional[List[Document]]) –
kwargs (Any) –
- Return type
Optional[List[str]]