VDMS

class langchain_community.vectorstores.vdms.VDMS(client: vdms.vdms, *, embedding: Embeddings | None = None, collection_name: str = 'langchain', distance_strategy: DISTANCE_METRICS = 'L2', engine: ENGINES = 'FaissFlat', relevance_score_fn: Callable[[float], float] | None = None, embedding_dimensions: int | None = None)

英特尔实验室的VDMS用于向量存储工作负载。

要使用，你应该具备以下条件： - 已安装vdms python包 - 与已部署的VDMS服务器关联的主机（str）和端口（int）

访问 IntelLabs/vdms 获取更多信息。

强烈建议对数据进行标准化处理。

Parameters:

• client (vdms.vdms) – 用于连接到VDMS服务器的VDMS客户端

• collection_name (str) – 数据集合的名称 [默认: langchain]

• distance_strategy (DISTANCE_METRICS) – 用于计算距离的方法。VDMS支持 “L2”（欧几里得距离）或“IP”（内积）[默认值：L2]

• engine (ENGINES) – 用于索引和计算距离的底层实现。 VDMS 支持 TileDBDense、TileDBSparse、FaissFlat、FaissIVFFlat 和 Flinng [默认：FaissFlat]

• embedding (可选[Embeddings]) – 任何实现langchain_core.embeddings.Embeddings接口的嵌入函数。

• relevance_score_fn (Optional[Callable[[float], float]]) – 用于获取相关性分数的函数

• embedding_dimensions (可选[int])

示例

from langchain_huggingface import HuggingFaceEmbeddings
from langchain_community.vectorstores.vdms import VDMS, VDMS_Client

model_name = "sentence-transformers/all-mpnet-base-v2"
vectorstore = VDMS(
    client=VDMS_Client("localhost", 55555),
    embedding=HuggingFaceEmbeddings(model_name=model_name),
    collection_name="langchain-demo",
    distance_strategy="L2",
    engine="FaissFlat",
)

属性

embeddings

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

方法

__init__(client, *[, embedding, ...])
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
add(collection_name, texts, embeddings[, ...])
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_from(texts, embeddings, ids[, ...])
add_images(uris[, metadatas, ids, ...])	通过嵌入运行更多图像并将其添加到向量存储中。
add_set(collection_name[, engine, metric])
add_texts(texts[, metadatas, ids, batch_size])	通过嵌入运行更多文本并将其添加到向量存储中。
add_videos(paths[, texts, metadatas, ids, ...])	将视频通过嵌入处理并添加到向量存储中。
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)	异步运行带距离的相似性搜索。
count(collection_name)
decode_image(base64_image)
delete([ids, collection_name, constraints])	按ID删除。
encode_image(image_path)
from_documents(documents[, embedding, ids, ...])	从文档列表创建VDMS向量存储。
from_texts(texts[, embedding, metadatas, ...])	从原始文档创建VDMS向量存储。
get(collection_name[, constraints, limit, ...])	获取集合。
get_by_ids(ids, /)	通过ID获取文档。
get_descriptor_response(command_str, setname)
get_k_candidates(setname, fetch_k[, ...])
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_with_score(query)	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_with_score_by_vector(...)	返回使用最大边际相关性选择的文档。
query_collection_embeddings([...])
search(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
similarity_search(query[, k, fetch_k, filter])	使用VDMS运行相似性搜索。
similarity_search_by_vector(embedding[, k, ...])	返回与嵌入向量最相似的文档。
similarity_search_with_relevance_scores(query)	返回文档和相关分数，范围在[0, 1]之间。
similarity_search_with_score(query[, k, ...])	使用VDMS进行带距离的相似性搜索。
similarity_search_with_score_by_vector(embedding)	返回与嵌入向量最相似的文档及其相似度分数。
update_document(collection_name, ...)	更新集合中的文档。
update_documents(collection_name, ids, documents)	更新集合中的文档。

__init__(client: vdms.vdms, *, embedding: Embeddings | None = None, collection_name: str = 'langchain', distance_strategy: DISTANCE_METRICS = 'L2', engine: ENGINES = 'FaissFlat', relevance_score_fn: Callable[[float], float] | None = None, embedding_dimensions: int | None = None) → None

Parameters:

• client (vdms.vdms)

• embedding (可选[Embeddings])

• collection_name (str)

• distance_strategy (DISTANCE_METRICS)

• engine (ENGINES)

• relevance_score_fn (可选[Callable[[float], float]])

• embedding_dimensions (可选[int])

Return type:

无

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(collection_name: str, texts: List[str], embeddings: List[List[float]], metadatas: List[None] | List[Dict[str, Any]] | None = None, ids: List[str] | None = None) → List

Parameters:

• collection_name (str)

• 文本 (列表[字符串])

• embeddings (List[List[float]])

• metadatas (List[None] | List[Dict[str, Any]] | None)

• ids (列表[字符串] | 无)

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_from(texts: List[str], embeddings: List[List[float]], ids: List[str], metadatas: List[dict] | None = None, batch_size: int = 32, **kwargs: Any) → List[str]

Parameters:

• 文本 (列表[字符串])

• embeddings (List[List[float]])

• ids (列表[字符串])

• metadatas (列表[字典] | 无)

• batch_size (int)

• kwargs (Any)

Return type:

列表[str]

add_images(uris: List[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 32, add_path: bool | None = True, **kwargs: Any) → List[str]

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

图像作为嵌入（AddDescriptor）而不是单独的实体（AddImage）添加到VDMS中，以利用相似性搜索功能

Parameters:

• uris (List[str]) – 要添加到向量存储中的图像路径列表。

• metadatas (List[dict] | None) – 可选的与图像关联的元数据列表。

• ids (List[str] | None) – 可选的唯一ID列表。

• batch_size (int) – 发送到服务器的并发请求数量。

• add_path (bool | None) – 布尔值，用于将图像路径添加为元数据

• kwargs (Any)

Returns:

将图像添加到向量存储中的ID列表。

Return type:

列表[str]

add_set(collection_name: str, engine: Literal['TileDBDense', 'TileDBSparse', 'FaissFlat', 'FaissIVFFlat', 'Flinng'] = 'FaissFlat', metric: Literal['L2', 'IP'] = 'L2') → str

Parameters:

• collection_name (str)

• engine (Literal['TileDBDense', 'TileDBSparse', 'FaissFlat', 'FaissIVFFlat', 'Flinng'])

• metric (Literal['L2', 'IP'])

Return type:

字符串

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 32, **kwargs: Any) → List[str]

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

Parameters:

• texts (Iterable[str]) – 要添加到向量存储中的字符串列表。

• metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。

• ids (List[str] | None) – 可选的唯一ID列表。

• batch_size (int) – 发送到服务器的并发请求数量。

• kwargs (Any)

Returns:

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

Return type:

列表[str]

add_videos(paths: List[str], texts: List[str] | None = None, metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 1, add_path: bool | None = True, **kwargs: Any) → List[str]

通过嵌入运行视频并添加到向量存储中。

视频作为嵌入（AddDescriptor）而不是单独的实体（AddVideo）添加到VDMS中，以利用相似性搜索功能

Parameters:

• paths (List[str]) – 要添加到向量存储的视频路径列表。

• metadatas (List[dict] | None) – 可选的与视频相关的文本列表。

• metadatas – 可选的与视频相关的元数据列表。

• ids (List[str] | None) – 可选的唯一ID列表。

• batch_size (int) – 发送到服务器的并发请求数量。

• add_path (bool | None) – 布尔值，用于将视频路径添加为元数据

• texts (List[str] | None)

• kwargs (Any)

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

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

count(collection_name: str) → int

Parameters:

collection_name (str)

Return type:

整数

decode_image(base64_image: str) → bytes

Parameters:

base64_image (str)

Return type:

字节

delete(ids: List[str] | None = None, collection_name: str | None = None, constraints: Dict | None = None, **kwargs: Any) → bool

按ID删除。这些是向量存储中的ID。

Parameters:

• ids (List[str] | None) – 要删除的ID列表。

• collection_name (str | None)

• 约束条件 (字典 | 无)

• kwargs (Any)

Returns:

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

Return type:

可选[布尔]

encode_image(image_path: str) → str

Parameters:

image_path (str)

Return type:

字符串

classmethod from_documents(documents: List[Document], embedding: Embeddings | None = None, ids: List[str] | None = None, batch_size: int = 32, collection_name: str = 'langchain', **kwargs: Any) → VDMS

从文档列表创建一个VDMS向量存储。

Parameters:

• collection_name (str) – 要创建的集合的名称。

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

• embedding (Embeddings) – 嵌入函数。默认为 None。

• ids (可选[列表[字符串]]) – 文档ID列表。默认为None。

• batch_size (int) – 发送到服务器的并发请求数量。

• kwargs (Any)

Returns:

VDMS 向量存储。

Return type:

VDMS

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 32, collection_name: str = 'langchain', **kwargs: Any) → VDMS

从原始文档创建一个VDMS向量存储。

Parameters:

• texts (List[str]) – 要添加到集合中的文本列表。

• embedding (Embeddings) – 嵌入函数。默认为 None。

• metadatas (可选[列表[字典]]) – 元数据列表。默认为 None。

• ids (可选[列表[字符串]]) – 文档ID列表。默认为None。

• batch_size (int) – 发送到服务器的并发请求数量。

• collection_name (str) – 要创建的集合的名称。

• kwargs (Any)

Returns:

VDMS 向量存储。

Return type:

VDMS

get(collection_name: str, constraints: Dict | None = None, limit: int | None = None, include: List[str] = ['metadata']) → Tuple[Any, Any]

获取集合。 从数据存储中获取嵌入及其相关数据。 如果没有提供约束条件，则返回所有嵌入，直到达到限制。

Parameters:

• constraints (Dict | None) – 用于过滤结果的字典。 例如 {“color” : [“==”, “red”], “price”: [“>”, 4.00]}。可选。

• limit (int | None) – 返回的文档数量。可选。

• include (List[str]) – 结果中包含的内容列表。 可以包含 “embeddings”, “metadatas”, “documents”。 Ids 总是包含在内。 默认为 [“metadatas”, “documents”]。可选。

• collection_name (str)

Return type:

元组[任意, 任意]

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_descriptor_response(command_str: str, setname: str, k_neighbors: int = 3, fetch_k: int = 15, constraints: dict | None = None, results: Dict[str, Any] | None = None, query_embedding: List[float] | None = None, normalize_distance: bool = False) → Tuple[List[Dict[str, Any]], List]

Parameters:

• command_str (str)

• setname (str)

• k_neighbors (int)

• fetch_k (int)

• constraints (dict | None)

• 结果 (字典[字符串, 任意类型] | 无)

• query_embedding (List[float] | None)

• normalize_distance (bool)

Return type:

元组[列表[字典[str, 任意]], 列表]

get_k_candidates(setname: str, fetch_k: int | None, results: Dict[str, Any] | None = None, all_blobs: List | None = None, normalize: bool | None = False) → Tuple[List[Dict[str, Any]], List, float]

Parameters:

• setname (str)

• fetch_k (int | None)

• 结果 (字典[字符串, 任意类型] | 无)

• all_blobs (列表 | 无)

• normalize (bool | None)

Return type:

元组[列表[字典[str, 任意]], 列表, float]

max_marginal_relevance_search(query: str, k: int = 3, fetch_k: int = 15, lambda_mult: float = 0.5, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Document]

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

Parameters:

• query (str) – 要查找的查询。文本或图像或视频的路径。

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

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 3, fetch_k: int = 15, lambda_mult: float = 0.5, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Document]

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

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

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

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

max_marginal_relevance_search_with_score(query: str, k: int = 3, fetch_k: int = 15, lambda_mult: float = 0.5, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Tuple[Document, float]]

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

Parameters:

• query (str) – 要查找的查询。文本或图像/视频的路径。

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

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[元组[文档, 浮点数]]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 3, fetch_k: int = 15, lambda_mult: float = 0.5, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Tuple[Document, float]]

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

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

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

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[元组[文档, 浮点数]]

query_collection_embeddings(query_embeddings: List[List[float]] | None = None, collection_name: str | None = None, n_results: int = 3, fetch_k: int = 15, filter: None | Dict[str, Any] = None, results: None | Dict[str, Any] = None, normalize_distance: bool = False, **kwargs: Any) → List[Tuple[Dict[str, Any], List]]

Parameters:

• query_embeddings (List[List[float]] | None)

• collection_name (str | None)

• n_results (int)

• fetch_k (int)

• filter (None | Dict[str, Any])

• 结果 (无 | 字典[字符串, 任意类型])

• normalize_distance (bool)

• kwargs (Any)

Return type:

列表[元组[字典[str, 任意], 列表]]

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 = 3, fetch_k: int = 15, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Document]

使用VDMS运行相似性搜索。

Parameters:

• query (str) – 要查找的查询。文本或图像/视频的路径。

• k (int) – 返回的结果数量。默认为3。

• fetch_k (int) – 为knn获取的候选数量（>= k）。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[Document]

similarity_search_by_vector(embedding: List[float], k: int = 3, fetch_k: int = 15, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Document]

返回与嵌入向量最相似的文档。 :param embedding: 要查找相似文档的嵌入向量。 :type embedding: List[float] :param k: 要返回的文档数量。默认为3。 :type k: int :param fetch_k: 为knn获取的候选文档数量（>= k）。 :type fetch_k: int :param filter: 通过元数据进行过滤。默认为None。 :type filter: Optional[Dict[str, str]]

Returns:

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

Parameters:

• embedding (列表[浮点数])

• k (整数)

• fetch_k (int)

• filter (Dict[str, List] | None)

• kwargs (Any)

Return type:

列表[文档]

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 = 3, fetch_k: int = 15, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Tuple[Document, float]]

使用VDMS进行带距离的相似性搜索。

Parameters:

• query (str) – 要查找的查询。文本或图像/视频的路径。

• k (int) – 返回的结果数量。默认为3。

• fetch_k (int) – 为knn获取的候选数量（>= k）。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表以及每个文档的余弦距离（浮点数）。分数越低表示相似度越高。

Return type:

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

similarity_search_with_score_by_vector(embedding: List[float], k: int = 3, fetch_k: int = 15, filter: Dict[str, List] | None = None, **kwargs: Any) → List[Tuple[Document, float]]

返回与嵌入向量最相似的文档和相似度分数。

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

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

• fetch_k (int) – 为knn获取的候选数量（>= k）。

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

与查询文本最相似的文档列表。分数越低表示相似度越高。

Return type:

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

update_document(collection_name: str, document_id: str, document: Document) → None

更新集合中的文档。

Parameters:

• document_id (str) – 要更新的文档的ID。

• document (Document) – 要更新的文档。

• collection_name (str)

Return type:

无

update_documents(collection_name: str, ids: List[str], documents: List[Document]) → None

更新集合中的文档。

Parameters:

• ids (List[str]) – 要更新的文档的ID列表。

• documents (List[Document]) – 要更新的文档列表。

• collection_name (str)

Return type:

无

使用 VDMS 的示例

• Intel的视觉数据管理系统 (VDMS)

• VDMS