ApertureDB

class langchain_community.vectorstores.aperturedb.ApertureDB(embeddings: Embeddings, descriptor_set: str = 'langchain', dimensions: int | None = None, engine: str | None = None, metric: str | None = None, log_level: int = 30, properties: Dict | None = None, **kwargs: Any)

创建一个由ApertureDB支持的向量存储

单个ApertureDB实例可以支持许多向量存储，通过‘descriptor_set’名称进行区分。如果描述符集不存在，则会创建它。不同的描述符集可以使用不同的引擎和度量标准，由不同的嵌入模型提供，并且具有不同的维度。

请参阅ApertureDB文档中的AddDescriptorSet https://docs.aperturedata.io/query_language/Reference/descriptor_commands/desc_set_commands/AddDescriptorSet 以获取更多关于引擎和度量选项的信息。

Parameters:

• embeddings (Embeddings) – 嵌入对象

• descriptor_set (str, optional) – 描述符集名称。默认为 “langchain”。

• dimensions (可选[int], 可选) – 嵌入的维度数。默认为 None。

• engine (str, optional) – 使用的引擎。对于新的描述符集，默认为“HNSW”。

• metric (str, optional) – 使用的度量标准。对于新的描述符集，默认为“CS”。

• log_level (int, optional) – 日志级别。默认为 logging.WARN。

• 属性 (可选[字典])

• kwargs (Any)

属性

embeddings

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

方法

__init__(embeddings[, descriptor_set, ...])	创建一个由ApertureDB支持的向量存储
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_texts(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)	异步运行带距离的相似性搜索。
delete([ids])	通过ID从向量存储中删除文档。
delete_vectorstore(descriptor_set)	从数据库中删除一个向量存储及其所有数据
from_documents(documents, embedding, **kwargs)	从文档列表创建一个新的向量存储
from_texts(texts, embedding[, metadatas])	从文本列表创建一个新的向量存储
get_by_ids(ids, /)	通过id在向量存储中查找文档。
list_vectorstores()	返回数据库中所有向量存储的列表
max_marginal_relevance_search(query[, k, ...])	返回与查询相似且具有多样性的文档
max_marginal_relevance_search_by_vector(...)	返回与向量相似且具有多样性的文档
search(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
similarity_search(query[, k])	使用向量存储搜索与查询相似的文档
similarity_search_by_vector(embedding[, k])	返回与给定嵌入向量最相似的k个文档
similarity_search_with_relevance_scores(query)	返回文档和相关分数，分数范围在[0, 1]之间。
similarity_search_with_score(query, *args, ...)	运行带距离的相似性搜索。
upsert(items, /, **kwargs)	插入或更新项目

__init__(embeddings: Embeddings, descriptor_set: str = 'langchain', dimensions: int | None = None, engine: str | None = None, metric: str | None = None, log_level: int = 30, properties: Dict | None = None, **kwargs: Any) → None

创建一个由ApertureDB支持的向量存储

单个ApertureDB实例可以支持许多向量存储，通过‘descriptor_set’名称进行区分。如果描述符集不存在，则会创建它。不同的描述符集可以使用不同的引擎和度量标准，由不同的嵌入模型提供，并且具有不同的维度。

请参阅ApertureDB文档中的AddDescriptorSet https://docs.aperturedata.io/query_language/Reference/descriptor_commands/desc_set_commands/AddDescriptorSet 以获取更多关于引擎和度量选项的信息。

Parameters:

• embeddings (Embeddings) – 嵌入对象

• descriptor_set (str, optional) – 描述符集名称。默认为 “langchain”。

• dimensions (可选[int], 可选) – 嵌入的维度数。默认为 None。

• engine (str, optional) – 使用的引擎。对于新的描述符集，默认为“HNSW”。

• metric (str, optional) – 使用的度量标准。对于新的描述符集，默认为“CS”。

• log_level (int, optional) – 日志级别。默认为 logging.WARN。

• properties (Dict | None)

• kwargs (Any)

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_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:

列表[str]

add_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) – 可选的与文本关联的元数据列表。

• ids (list[str] | None) – 可选的与文本关联的ID列表。

• **kwargs (Any) – 向量存储特定参数。 其中一个 kwargs 应该是 ids，这是一个与文本相关联的 ID 列表。

Returns:

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

Raises:

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

• ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

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, **kwargs: Any) → bool | None

通过ID从向量存储中删除文档。

Parameters:

• ids (List[str] | None) – 要从向量存储中删除的ID列表。

• kwargs (Any)

Returns:

如果删除成功则为True，否则为False

Return type:

布尔值 | 无

classmethod delete_vectorstore(descriptor_set: str) → None

从数据库中删除一个向量存储及其所有数据

Parameters:

descriptor_set (str) – 要删除的描述符集的名称

Return type:

无

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → ApertureDB

从文档列表创建一个新的向量存储

Parameters:

• documents (List[Document]) – Document 对象列表

• embedding (Embeddings) – 用于构建向量存储的嵌入对象

• metadatas – 可选的与文本关联的元数据列表。

• kwargs (Any) – 传递给构造函数的额外参数

Return type:

ApertureDB

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, **kwargs: Any) → ApertureDB

从文本列表创建一个新的向量存储

Parameters:

• texts (List[str]) – 文本字符串列表

• embedding (Embeddings) – 用于构建向量存储的嵌入对象

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

• kwargs (Any) – 传递给构造函数的额外参数

Return type:

ApertureDB

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

通过ID在向量存储中查找文档。

Parameters:

ids (Sequence[str]) – 要在向量存储中查找的ID列表。

Returns:

在向量存储中找到的文档对象列表。

Return type:

文档

classmethod list_vectorstores() → None

返回数据库中所有向量存储的列表

Returns:

具有属性的描述符集列表

Return type:

无

max_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) – 返回的结果数量。

• fetch_k (int) – 要获取的结果数量。

• lambda_mult (float) – MMR的Lambda乘数。

• kwargs (Any)

Returns:

按相似度/多样性递减排序的文档对象列表。

Return type:

列表[文档]

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]

返回与向量相似且具有多样性的文档

该算法在搜索结果中平衡了相关性和多样性。

Parameters:

• embedding (List[float]) – 要搜索的嵌入向量。

• k (int) – 返回的结果数量。

• fetch_k (int) – 要获取的结果数量。

• lambda_mult (float) – MMR的Lambda乘数。

• kwargs (Any)

Returns:

按相似度/多样性递减排序的文档对象列表。

Return type:

列表[文档]

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, *args: Any, **kwargs: Any) → List[Document]

使用向量存储搜索与查询相似的文档

Parameters:

• query (str) – 要搜索的查询字符串。

• k (int) – 返回的结果数量。

• args (Any)

• kwargs (Any)

Returns:

按与查询的相似度递减排序的文档对象列表。

Return type:

列表[文档]

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

返回与给定嵌入向量最相似的k个文档

Parameters:

• embedding (List[float]) – 要搜索的嵌入向量

• k (int) – 返回的相似文档数量

• kwargs (Any)

Returns:

按与查询的相似度递减排序的Document对象列表。

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, *args: Any, **kwargs: Any) → List[Tuple[Document, float]]

使用距离运行相似性搜索。

Parameters:

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

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

• query (str)

• *args

• **kwargs

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

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

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

插入或更新项目

更新文档依赖于文档的id属性。

Parameters:

• items (Sequence[Document]) – 要插入或更新的Document对象列表

• kwargs (Any)

Returns:

带有成功和失败的UpsertResponse对象

Return type:

UpsertResponse

使用 ApertureDB 的示例

• ApertureDB