langchain_community.vectorstores.surrealdb.SurrealDBStore

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

SurrealDB作为向量存储。

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

参数:

embedding_function: 要使用的嵌入函数。 dburl: SurrealDB连接url ns: 用于向量存储的surrealdb命名空间。 (默认值: “langchain”) db: 用于向量存储的surrealdb数据库。 (默认值: “database”) collection: 用于向量存储的surrealdb集合。

(默认值: “documents”)

(可选) db_user和db_pass: surrealdb凭据

示例:
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)

Attributes

embeddings

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

Methods

__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

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)

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

asimilarity_search_with_score(query[, k])

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

delete([ids])

根据文档ID删除。

from_documents(documents, embedding, **kwargs)

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

from_texts(texts, embedding[, metadatas])

从文本列表创建SurrealDBStore

initialize()

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

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)

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

similarity_search_with_score(query[, k])

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

  • embedding_function (Embeddings) –

  • kwargs (Any) –

Return type

None

__init__(embedding_function: Embeddings, **kwargs: Any) → None[source]
Parameters

  • embedding_function (Embeddings) –

  • kwargs (Any) –

Return type

None

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

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

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

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

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

参数：

texts (Iterable[str]): 要添加到数据库中的文本集合

返回：

新插入文档的ID列表

Parameters

  • texts (Iterable[str]) –

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

  • kwargs (Any) –

Return type

List[str]

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

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

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

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

将文本列表与嵌入一起添加到向量存储中

参数：

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

返回：

新插入文档的id列表

Parameters

  • texts (Iterable[str]) –

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

  • kwargs (Any) –

Return type

List[str]

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

异步按文档ID删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功，则为True，否则为False。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters
Return type

VST

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_user 和 db_pass: SurrealDB凭据

返回:

初始化并准备就绪的SurrealDBStore对象。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

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

  • kwargs (Any) –

Return type

SurrealDBStore

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

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]

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

参数：
search_type（可选[str]）：定义Retriever应执行的搜索类型。

可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。

search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：

k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
Parameters

kwargs (Any) –

Return type

VectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]

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

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

在查询上异步运行相似性搜索

参数:

query (str): 查询 k (int): 要返回的结果数量。默认为4。

返回:

与查询最相似的文档列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数:

embedding (List[float]): 查询嵌入 k (int): 要返回的结果数量。默认为4。

返回:

与查询最相似的文档列表

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数：

query (str): 查询 k (int): 要返回的结果数量。默认为4。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

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

参数：

query (str): 查询 k (int): 要返回的结果数量。默认为4。

返回：

最相似的文档列表以及相关性距离分数

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

根据文档ID删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters
Return type

VST

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_user 和 db_pass: SurrealDB凭据

返回:

初始化并准备就绪的SurrealDBStore对象。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

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

  • kwargs (Any) –

Return type

SurrealDBStore

async initialize() → None[source]

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

Return type

None

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

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：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

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

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

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

在查询上运行相似性搜索

参数：

query（str）：查询 k（int）：要返回的结果数量。默认为4。

返回：

与查询最相似的文档列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数:

embedding (List[float]): 查询嵌入 k (int): 要返回的结果数量。默认为4。

返回:

与查询最相似的文档列表

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

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

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

参数:

query (str): 查询 k (int): 要返回的结果数量。默认为4。

返回:

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

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

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

参数:

query (str): 查询 k (int): 要返回的结果数量。默认为4。

返回:

最相似的文档列表以及相关性距离分数

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using SurrealDBStore