SurrealDBStore#

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

SurrealDB 作为向量存储。

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

Parameters:

embedding_function (Embeddings) – 使用的嵌入函数。
dburl – SurrealDB 连接网址
ns – vector store 的 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

model_name = "sentence-transformers/all-mpnet-base-v2"
embedding_function = HuggingFaceEmbeddings(model_name=model_name)
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])	异步运行相似性搜索并返回距离分数
`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])	同步运行相似性搜索并返回距离分数

__init__(embedding_function: Embeddings, **kwargs: Any) → None[源代码]#

Parameters:

embedding_function (Embeddings)
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, **kwargs: Any) → List[str][source]#

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

Parameters:

texts (Iterable[str]) – 要添加到数据库的文本集合
metadatas (列表[字典] | 无)
kwargs (Any)

Returns:

新插入文档的ID列表

Return type:

列表[str]

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_texts(texts: Iterable[str], metadatas: List[dict] | None = None, **kwargs: Any) → List[str][source]#

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

Parameters:

texts (Iterable[str]) – 要添加到数据库的文本集合
metadatas (列表[字典] | 无)
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列表。
**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, **kwargs: Any) → SurrealDBStore[source]#

从文本列表异步创建SurrealDBStore

Parameters:

texts (List[str]) – 要向量化并存储的文本列表
embedding (可选[Embeddings]) – 嵌入函数。
dburl (str) – SurrealDB 连接网址 (默认: “ws://localhost:8000/rpc”)
ns (str) – 向量存储的surrealdb命名空间。 (默认值: “langchain”)
db (str) – 用于向量存储的surrealdb数据库。 (默认值: “database”)
collection (str) – surrealdb 集合用于向量存储。 (默认: “documents”)
db_pass ((可选) db_user 和) – surrealdb 凭证
metadatas (列表[字典] | 无)
kwargs (Any)

Returns:

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

Return type:

SurrealDBStore

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, *, filter: Dict[str, str] | 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:

列表[文档]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

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

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:

列表[文档]

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, *, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Document][来源]#

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

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

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

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

Parameters:

embedding (List[float]) – 查询嵌入
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, *, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

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

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

最相似的文档列表及其相关性分数

Return type:

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

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

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

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

最相似文档列表及其相关距离分数

Return type:

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

delete(ids: List[str] | None = None, **kwargs: Any) → bool | None[来源]#

按文档ID删除。

Parameters:

ids (List[str] | None) – 要删除的ID列表。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假。

Return type:

可选[布尔]

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

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

从文本列表创建SurrealDBStore

Parameters:

texts (List[str]) – 要向量化并存储的文本列表
embedding (可选[Embeddings]) – 嵌入函数。
dburl (str) – SurrealDB 连接 URL
ns (str) – 向量存储的surrealdb命名空间。 (默认值: “langchain”)
db (str) – 用于向量存储的surrealdb数据库。 (默认值: “database”)
collection (str) – surrealdb 集合用于向量存储。 (默认: “documents”)
db_pass ((可选) db_user 和) – surrealdb 凭证
metadatas (列表[字典] | 无)
kwargs (Any)

Returns:

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

Return type:

SurrealDBStore

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

async initialize() → None[source]#

初始化连接到surrealdb数据库如果提供了凭据则进行身份验证

Return type:: 无

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

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

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 = 4, fetch_k: int = 20, lambda_mult: float = 0.5, *, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

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

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

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:

列表[文档]

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

在查询上运行相似性搜索

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

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

在查询嵌入上运行相似性搜索

Parameters:

embedding (List[float]) – 查询嵌入
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

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

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

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

最相似文档列表及相关性评分

Return type:

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

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

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

Parameters:

query (str) – 查询
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
kwargs (Any)

Returns:

最相似文档列表及其相关距离分数

Return type:

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

使用 SurrealDBStore 的示例

SurrealDB