`langchain_community.vectorstores.aperturedb`.ApertureDB¶

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

创建一个由 ApertureDB 支持的向量数据库

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

有关引擎和指标选项的更多信息，请参阅 ApertureDB 文档中的 AddDescriptorSet https://docs.aperturedata.io/query_language/Reference/descriptor_commands/desc_set_commands/AddDescriptorSet。

参数

embeddings (Embeddings) – 嵌入对象
descriptor_set (str, optional) – 描述符集名称。默认为 “langchain”。
dimensions (Optional[int], optional) – 嵌入的维度数量。默认为 None。
engine (str, optional) – 要使用的引擎。对于新的描述符集，默认为 “HNSW”。
metric (str, optional) – 要使用的指标。对于新的描述符集，默认为 “CS”。
log_level (int, optional) – 日志级别。默认为 logging.WARN。
properties (Optional[Dict]) –
kwargs (Any) –

属性

embeddings

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

方法

`__init__`(embeddings[, descriptor_set, ...])	创建一个由 ApertureDB 支持的向量数据库
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量数据库。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过嵌入并添加到向量数据库。
`add_documents`(documents, **kwargs)	在向量数据库中添加或更新文档。
`add_texts`(texts[, metadatas])	运行更多文本通过嵌入并添加到向量数据库。
`adelete`([ids])	异步按向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步从文档和嵌入初始化向量数据库。
`afrom_texts`(texts, embedding[, metadatas])	异步从文本和嵌入初始化向量数据库。
`aget_by_ids`(ids, /)	异步按 ID 获取文档。
`amax_marginal_relevance_search`(query[, k, ...])	异步返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回由此向量数据库初始化的 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])	通过 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, ...)	运行带距离的相似性搜索。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)	插入或更新项目

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

创建一个由 ApertureDB 支持的向量数据库

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

有关引擎和指标选项的更多信息，请参阅 ApertureDB 文档中的 AddDescriptorSet https://docs.aperturedata.io/query_language/Reference/descriptor_commands/desc_set_commands/AddDescriptorSet。

参数

embeddings (Embeddings) – 嵌入对象
descriptor_set (str, optional) – 描述符集名称。默认为 “langchain”。
dimensions (Optional[int], optional) – 嵌入的维度数量。默认为 None。
engine (str, optional) – 要使用的引擎。对于新的描述符集，默认为 “HNSW”。
metric (str, optional) – 要使用的指标。对于新的描述符集，默认为 “CS”。
log_level (int, optional) – 日志级别。默认为 logging.WARN。
properties (Optional[Dict]) –
kwargs (Any) –

返回类型

None

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

异步运行更多文档通过嵌入并添加到向量数据库。

参数

documents (List[Document]) – 要添加到向量数据库的文档。
kwargs (Any) – 额外的关键字参数。

返回

添加的文本的 ID 列表。

Raises

ValueError – 如果 ID 的数量与文档的数量不匹配，则引发 ValueError 错误。

返回类型

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

异步运行更多文本通过嵌入并添加到向量数据库。

参数

texts (Iterable[str]) – 要添加到向量数据库的字符串迭代器。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量数据库特定的参数。

返回

从将文本添加到向量数据库中获取的 ID 列表。

Raises

ValueError – 如果元数据的数量与文本的数量不匹配，则引发 ValueError 错误。
ValueError – 如果 ID 的数量与文本的数量不匹配，则引发 ValueError 错误。

返回类型

List[str]

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

在向量数据库中添加或更新文档。

参数

documents (List[Document]) – 要添加到向量数据库的文档。
kwargs (Any) – 额外的关键字参数。如果 kwargs 包含 ids 并且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回

添加的文本的 ID 列表。

Raises

ValueError – 如果 ID 的数量与文档的数量不匹配，则引发 ValueError 错误。

返回类型

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

运行更多文本通过嵌入并添加到向量数据库。

参数

texts (Iterable[str]) – 要添加到向量数据库的字符串迭代器。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
**kwargs (Any) – 向量数据库特定的参数。其中一个 kwargs 应该是 ids，它是与文本关联的 id 列表。

返回

从将文本添加到向量数据库中获取的 ID 列表。

Raises

ValueError – 如果元数据的数量与文本的数量不匹配，则引发 ValueError 错误。
ValueError – 如果 ID 的数量与文本的数量不匹配，则引发 ValueError 错误。

返回类型

List[str]

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

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

参数

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

返回

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

返回类型

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

异步从文档和嵌入初始化向量数据库。

参数

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

返回

从文档和嵌入初始化的向量数据库。

返回类型

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

异步从文本和嵌入初始化向量数据库。

参数

texts (List[str]) – 要添加到向量数据库的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 额外的关键字参数。

返回

从文本和嵌入初始化的向量数据库。

返回类型

VectorStore

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

异步按 ID 获取文档。

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

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
返回类型: 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]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
kwargs (Any) –

返回

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

返回类型

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]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回由此向量数据库初始化的 VectorStoreRetriever。

参数

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

返回

VectorStore 的检索器类。

返回类型

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]¶

异步返回使用指定搜索类型与查询最相似的文档。

参数

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

ValueError – 如果 search_type 不是“similarity”、“mmr”或“similarity_score_threshold”之一。

返回类型

List[Document]

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

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

参数

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

返回

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

返回类型

List[Document]

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

异步返回与嵌入向量最相似的文档。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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

异步返回范围在 [0, 1] 内的文档和相关性得分。

0 表示不相似，1 表示最相似。

参数

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

过滤检索到的文档结果集

返回

（文档，相似度分数）元组的列表

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回

（文档，相似度分数）元组的列表。

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

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

以流式方式更新文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次更新批次的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引的超时时间，重试策略等）kwargs 不应包含 ID 以避免语义不明确。而应将 ID 作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

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

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

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

参数

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

返回

一个响应对象，其中包含已成功添加到或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

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

通过 ID 从向量数据库中删除文档。

参数

ids (Optional[List[str]]) – 要从向量存储中删除的 ID 列表。
kwargs (Any) –

返回

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

返回类型

Optional[bool]

classmethod delete_vectorstore(descriptor_set: str) → None[source]¶

从数据库中删除向量数据库及其所有数据

参数: descriptor_set (str) – 要删除的描述符集的名称
返回类型: None

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

从文档列表创建新的向量数据库

参数

documents (List[Document]) – Document 对象列表
embedding (Embeddings) – 用于构建向量存储的 Embeddings 对象
metadatas – 与文本关联的可选元数据列表。
kwargs (Any) – 传递给构造函数的其他参数

返回类型

ApertureDB

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

从文本列表创建新的向量数据库

参数

texts (List[str]) – 文本字符串列表
embedding (Embeddings) – 用于构建向量存储的 Embeddings 对象
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
kwargs (Any) – 传递给构造函数的其他参数

返回类型

ApertureDB

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

通过 ID 在向量数据库中查找文档。

参数: ids (Sequence[str]) – 要在向量存储中查找的 ID 列表。
返回: 在向量存储中找到的 Document 对象列表。
返回类型: documents

classmethod list_vectorstores() → None[source]¶

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

返回: 具有属性的描述符集列表
返回类型: None

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document][source]¶

返回与查询相似且具有多样性的文档

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

参数

query (str) – 要搜索的查询字符串。
k (int) – 要返回的结果数。
fetch_k (int) – 要提取的结果数。
lambda_mult (float) – MMR 的 Lambda 乘数。
kwargs (Any) –

返回

按相似度/多样性降序排列的 Document 对象列表。

返回类型

List[Document]

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

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

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

参数

embedding (List[float]) – 要搜索的嵌入向量。
k (int) – 要返回的结果数。
fetch_k (int) – 要提取的结果数。
lambda_mult (float) – MMR 的 Lambda 乘数。
kwargs (Any) –

返回

按相似度/多样性降序排列的 Document 对象列表。

返回类型

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

返回使用指定搜索类型与查询最相似的文档。

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

ValueError – 如果 search_type 不是“similarity”、“mmr”或“similarity_score_threshold”之一。

返回类型

List[Document]

similarity_search(query: str, k: int = 4, *args: Any, **kwargs: Any) → List[Document][source]¶

使用向量数据库搜索与查询相似的文档

参数

query (str) – 要搜索的查询字符串。
k (int) – 要返回的结果数。
args (Any) –
kwargs (Any) –

返回

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

返回类型

List[Document]

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

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

参数

embedding (List[float]) – 用于搜索的嵌入向量
k (int) – 返回的相似文档数量
kwargs (Any) –

返回

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

返回类型

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回范围在 [0, 1] 内的文档和相关性得分。

0 表示不相似，1 表示最相似。

参数

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

过滤检索到的文档结果集。

返回

（文档，相似度分数）元组的列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, *args: Any, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

参数

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

返回

（文档，相似度分数）元组的列表。

返回类型

List[Tuple[Document, float]]

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

Beta

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

以流式方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次更新批次的大小。
kwargs (Any) – 额外的关键字参数。kwargs 应该只包含所有文档通用的参数。（例如，索引的超时时间，重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

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

插入或更新项目

文档更新取决于文档的 id 属性。

参数

items (Sequence[Document]) – 要更新的 Document 对象列表
kwargs (Any) –

返回

包含成功和失败信息的 UpsertResponse 对象

返回类型

UpsertResponse

langchain_community.vectorstores.aperturedb.ApertureDB¶

`langchain_community.vectorstores.aperturedb`.ApertureDB¶