`langchain_community.vectorstores.sqlitevss`.SQLiteVSS¶

class langchain_community.vectorstores.sqlitevss.SQLiteVSS(table: str, connection: Optional[sqlite3.Connection], embedding: Embeddings, db_file: str = 'vss.db')[source]¶

使用带有 VSS 扩展的 SQLite 作为向量数据库。

要使用，您应该安装 sqlite-vss python 包。 .. rubric:: 示例

使用带有 vss 扩展的 sqlite 客户端初始化。

属性

embeddings

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

方法

`__init__`(table, connection, embedding[, db_file])	使用带有 vss 扩展的 sqlite 客户端初始化。
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入运行更多文本并添加到向量存储中。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	向向量存储索引添加更多文本。
`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)
`create_connection`(db_file)
`create_table_if_not_exists`()
`delete`([ids])	按向量 ID 或其他标准删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的 VectorStore。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`get_dimensionality`()	执行虚拟嵌入以确定此嵌入函数返回多少维度的函数。
`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])	返回与嵌入向量最相似的文档。
`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`(items, /, **kwargs)

参数

table (str) –
connection (Optional[sqlite3.Connection]) –
embedding (Embeddings) –
db_file (str) –

__init__(table: str, connection: Optional[sqlite3.Connection], embedding: Embeddings, db_file: str = 'vss.db')[source]¶

使用带有 vss 扩展的 sqlite 客户端初始化。

参数

table (str) –
connection (Optional[sqlite3.Connection]) –
embedding (Embeddings) –
db_file (str) –

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

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

参数

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

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 数量与文档数量不匹配。

返回类型

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 列表。

引发

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

返回类型

List[str]

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

在向量存储中添加或更新文档。

参数

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

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 数量与文档数量不匹配。

返回类型

List[str]

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

向向量存储索引添加更多文本。 :param texts: 要添加到向量存储的字符串的可迭代对象。 :param metadatas: 与文本关联的可选元数据列表。 :param kwargs: 向量存储特定参数

参数

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

返回类型

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¶

异步地返回从文档和嵌入初始化的 VectorStore。

参数

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

返回

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

返回类型

VectorStore

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

异步地返回从文本和嵌入初始化的 VectorStore。

参数

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

返回

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

返回类型

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¶

返回从该 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括: search_type (Optional[str]): 定义 Retriever 应执行的搜索类型。

可以是 “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 的 Retriever 类。

返回类型

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) – 传递给搜索方法的参数。

返回

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

引发

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 不应包含 ids 以避免语义模糊。相反，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 字段，则更新功能应使用该字段。如果未提供 ID，则更新方法可以自由地为文档生成 ID。

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

参数

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

返回

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

返回类型

UpsertResponse

0.2.11 版本新增。

static create_connection(db_file: str) → sqlite3.Connection[source]¶

参数: db_file (str) –
返回类型: sqlite3.Connection

create_table_if_not_exists() → None[source]¶

返回类型: None

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

按向量 ID 或其他标准删除。

参数

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

返回

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

返回类型

Optional[bool]

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

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

参数

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

返回

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

返回类型

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, table: str = 'langchain', db_file: str = 'vss.db', **kwargs: Any) → SQLiteVSS[source]¶

返回从文本和嵌入初始化的 VectorStore。

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
table (str) –
db_file (str) –
kwargs (Any) –

返回类型

SQLiteVSS

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

通过 ID 获取文档。

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

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

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

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

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

0.2.11 版本新增。

get_dimensionality() → int[source]¶

执行虚拟嵌入以确定此嵌入函数返回多少维度的函数。虚拟表 DDL 需要它。

返回类型: int

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

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

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

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

参数

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

返回

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

返回类型

List[Document]

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

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

参数

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

返回

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

引发

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

返回类型

List[Document]

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

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

参数

query (str) –
k (int) –
kwargs (Any) –

返回类型

List[Document]

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

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

参数

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

返回

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

返回类型

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, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

参数

query (str) –
k (int) –
kwargs (Any) –

返回类型

List[Tuple[Document, float]]

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

参数

embedding (List[float]) –
k (int) –
kwargs (Any) –

返回类型

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¶

Beta

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

在向量存储中添加或更新文档。

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

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

参数

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

返回

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

返回类型

UpsertResponse

0.2.11 版本新增。

langchain_community.vectorstores.sqlitevss.SQLiteVSS¶

使用 SQLiteVSS 的示例¶

`langchain_community.vectorstores.sqlitevss`.SQLiteVSS¶