langchain_community.vectorstores.surrealdb.SurrealDBStore

class langchain_community.vectorstores.surrealdb.SurrealDBStore(embedding_function: Embeddings, **kwargs: Any)[source]

SurrealDB 作为向量存储。

要使用,您应该安装 surrealdb python 包。

参数
  • embedding_function (Embeddings) – 要使用的嵌入函数。

  • dburl – SurrealDB 连接 URL

  • ns – 向量存储的 surrealdb 命名空间。(默认值:“langchain”)

  • db – 向量存储的 surrealdb 数据库。(默认值:“database”)

  • collection – 向量存储的 surrealdb 集合。(默认值:“documents”)

  • db_pass ((可选) db_user 和) – surrealdb 凭据

  • kwargs (Any) –

示例

from langchain_community.vectorstores.surrealdb import SurrealDBStore
from langchain_community.embeddings import HuggingFaceEmbeddings

embedding_function = HuggingFaceEmbeddings()
dburl = "ws://localhost:8000/rpc"
ns = "langchain"
db = "docstore"
collection = "documents"
db_user = "root"
db_pass = "root"

sdb = SurrealDBStore.from_texts(
        texts=texts,
        embedding=embedding_function,
        dburl,
        ns, db, collection,
        db_user=db_user, db_pass=db_pass)

属性

embeddings

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

方法

__init__(embedding_function, **kwargs)

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

从文本列表异步创建 SurrealDBStore

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, filter])

异步运行查询的相似性搜索

asimilarity_search_by_vector(embedding[, k, ...])

异步运行查询嵌入的相似性搜索

asimilarity_search_with_relevance_scores(query)

异步运行相似性搜索并返回相关性得分

asimilarity_search_with_score(query[, k, filter])

异步运行相似性搜索并返回距离得分

astreaming_upsert(items, /, batch_size, **kwargs)

aupsert(items, /, **kwargs)

delete([ids])

按文档 ID 删除。

from_documents(documents, embedding, **kwargs)

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

from_texts(texts, embedding[, metadatas])

从文本列表创建 SurrealDBStore

get_by_ids(ids, /)

按 ID 获取文档。

initialize()

初始化与 surrealdb 数据库的连接,并在提供凭据时进行身份验证

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

similarity_search(query[, k, filter])

对查询运行相似性搜索

similarity_search_by_vector(embedding[, k, ...])

对查询嵌入运行相似性搜索

similarity_search_with_relevance_scores(query)

同步运行相似性搜索并返回相关性得分

similarity_search_with_score(query[, k, filter])

同步运行相似性搜索并返回距离得分

streaming_upsert(items, /, batch_size, **kwargs)

upsert(items, /, **kwargs)

__init__(embedding_function: Embeddings, **kwargs: Any) None[source]
参数
  • embedding_function (Embeddings) –

  • kwargs (Any) –

返回类型

None

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

异步地将文本列表及其嵌入添加到向量存储

参数
  • texts (Iterable[str]) – 要添加到数据库的文本集合

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

返回

新插入文档的 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 – 如果 ids 的数量与文档的数量不匹配。

返回类型

List[str]

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

将文本列表及其嵌入添加到向量存储

参数
  • texts (Iterable[str]) – 要添加到数据库的文本集合

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

返回

新插入文档的 ID 列表

返回类型

List[str]

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

异步地按文档 ID 删除。

参数
  • ids (Optional[List[str]]) – 要删除的 ID 列表。

  • **kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功,则为 True,否则为 False。

返回类型

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) SurrealDBStore[source]

从文本列表异步创建 SurrealDBStore

参数
  • texts (List[str]) – 要向量化和存储的文本列表

  • embedding (Optional[Embeddings]) – 嵌入函数。

  • dburl (str) – SurrealDB 连接 URL(默认值:“ws://localhost:8000/rpc”)

  • ns (str) – 向量存储的 surrealdb 命名空间。(默认值:“langchain”)

  • db (str) – 向量存储的 surrealdb 数据库。(默认值:“database”)

  • collection (str) – 向量存储的 surrealdb 集合。(默认值:“documents”)

  • db_pass ((可选) db_user 和) – surrealdb 凭据

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

返回

SurrealDBStore 对象已初始化并准备使用。

返回类型

SurrealDBStore

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 版本中的新功能。

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

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

参数
  • query (str) – 用于查找相似文档的文本。

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

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

  • lambda_mult (float) – 介于 0 和 1 之间的数字,用于确定结果之间多样性的程度,其中 0 对应于最大多样性,1 对应于最小多样性。 默认为 0.5。

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • 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, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Document][source]

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

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

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

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

  • lambda_mult (float) – 介于 0 和 1 之间的数字,用于确定结果之间多样性的程度,其中 0 对应于最大多样性,1 对应于最小多样性。 默认为 0.5。

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

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

返回类型

List[Document]

as_retriever(**kwargs: Any) VectorStoreRetriever

返回从此 VectorStore 初始化的 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)

(默认: 20)

lambda_mult: MMR 返回结果的多样性;1 代表最小多样性,0 代表最大多样性。(默认: 0.5)

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

返回

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

引发

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

返回类型

List[Document]

异步运行查询的相似性搜索

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表

返回类型

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Document][source]

异步运行查询嵌入的相似性搜索

参数
  • embedding (List[float]) – 查询嵌入向量

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表

返回类型

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Tuple[Document, float]][source]

异步运行相似性搜索并返回相关性得分

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表, साथ ही प्रासंगिकता स्कोर

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score(query: str, k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Tuple[Document, float]][source]

异步运行相似性搜索并返回距离得分

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • 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 字段,则 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 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, **kwargs: Any) SurrealDBStore[source]

从文本列表创建 SurrealDBStore

参数
  • texts (List[str]) – 要向量化和存储的文本列表

  • embedding (Optional[Embeddings]) – 嵌入函数。

  • dburl (str) – SurrealDB 连接 URL

  • ns (str) – 向量存储的 surrealdb 命名空间。(默认值:“langchain”)

  • db (str) – 向量存储的 surrealdb 数据库。(默认值:“database”)

  • collection (str) – 向量存储的 surrealdb 集合。(默认值:“documents”)

  • db_pass ((可选) db_user 和) – surrealdb 凭据

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

返回

SurrealDBStore 对象已初始化并准备使用。

返回类型

SurrealDBStore

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 版本中的新功能。

async initialize() None[source]

初始化与 surrealdb 数据库的连接,并在提供凭据时进行身份验证

返回类型

None

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

参数
  • query (str) – 用于查找相似文档的文本。

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

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

  • lambda_mult (float) – 介于 0 和 1 之间的数字,用于确定结果之间多样性的程度,其中 0 对应于最大多样性,1 对应于最小多样性。 默认为 0.5。

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • 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, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Document][source]

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

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

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

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

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

  • lambda_mult (float) – 介于 0 和 1 之间的数字,用于确定结果之间多样性的程度,其中 0 对应于最大多样性,1 对应于最小多样性。 默认为 0.5。

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

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

对查询运行相似性搜索

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Document][source]

对查询嵌入运行相似性搜索

参数
  • embedding (List[float]) – 查询嵌入向量

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表

返回类型

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Tuple[Document, float]][source]

同步运行相似性搜索并返回相关性得分

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • kwargs (Any) –

返回

与查询最相似的文档列表, साथ ही प्रासंगिकता स्कोर

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, *, filter: Optional[Dict[str, str]] = None, **kwargs: Any) List[Tuple[Document, float]][source]

同步运行相似性搜索并返回距离得分

参数
  • query (str) – 查询

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

  • filter (Optional[Dict[str, str]]) – 按元数据过滤。 默认为 None。

  • 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]) – 要添加到向量数据库的可迭代 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 字段,则 upsert 功能应使用该字段。如果未提供 ID,则 upsert 方法可以自由地为文档生成 ID。

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

参数
  • items (Sequence[Document]) – 要添加到向量存储的文档序列。

  • kwargs (Any) – 额外的关键字参数。

返回

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

返回类型

UpsertResponse

0.2.11 版本中的新功能。

使用 SurrealDBStore 的示例