SQLServer_VectorStore#

class langchain_sqlserver.vectorstores.SQLServer_VectorStore(*, connection: Connection | None = None, connection_string: str, db_schema: str | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, embedding_function: Embeddings, embedding_length: int, relevance_score_fn: Callable[[float], float] | None = None, table_name: str = 'sqlserver_vectorstore')[source]#

SQL Server 向量存储。

This class provides a vector store interface for adding texts and performing

在SQL Server中对文本进行相似性搜索。

初始化SQL Server向量存储。

Parameters:

  • connection (可选[Connection]) – 可选的 SQLServer 连接。

  • connection_string (str) – SQLServer 连接字符串。 如果连接字符串不包含用户名和密码 或 TrustedConnection=yes，则使用 Entra ID 认证。 SQL Server ODBC 连接字符串可以从 Azure 门户中数据库的 连接字符串 窗格中获取。 示例连接字符串格式： - “Driver=;Server=;Database=; Uid=;Pwd=;TrustServerCertificate=no;” - “mssql+pyodbc://username:password@servername/dbname?other_params”

  • db_schema (可选[str]) – 将在其中创建向量存储的模式。 此模式必须存在，并且用户必须对该模式具有权限。

  • distance_strategy (DistanceStrategy) – 用于比较嵌入的距离策略。 默认值为 COSINE。可用选项有： - COSINE - DOT - EUCLIDEAN

  • embedding_function (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。

  • embedding_length (int) – 要存储在表中的向量的长度（维度）。 请注意，只有相同大小的向量才能添加到向量存储中。

  • relevance_score_fn (Optional[Callable[[float], float]]) – 要使用的相关性评分函数。 可选参数，默认为 None。

  • table_name (str) – 用于存储嵌入的表名。 默认值为 sqlserver_vectorstore。

属性

distance_strategy

SQLServer_VectorStore 类的 distance_strategy 属性。

embeddings

SQLServer_VectorStore 类的 embeddings 属性。

方法

__init__(*[, connection, db_schema, ...])

初始化 SQL Server 向量存储。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas, ids])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas, ids])

add_texts 函数用于 SQLServer_VectorStore 类。

adelete([ids])

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

afrom_documents(documents, embedding, **kwargs)

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

afrom_texts(texts, embedding[, metadatas, ids])

异步返回从文本和嵌入初始化的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)

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

delete([ids])

通过ID删除向量存储中的嵌入。

drop()

删除在向量存储初始化期间创建的所有表。

from_documents(documents, embedding[, ...])

创建一个从文本和嵌入初始化的SQL Server向量存储。

from_texts(texts, embedding[, metadatas, ...])

从文本和嵌入初始化创建一个SQL Server向量存储。

get_by_ids(ids, /)

通过ID从向量存储中获取文档。

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_by_vector_with_score(embedding)

通过向量进行相似性搜索并返回分数。

similarity_search_with_relevance_scores(query)

返回文档和相关分数，分数范围在[0, 1]之间。

similarity_search_with_score(query[, k])

带分数的相似性搜索。
__init__(*, connection: Connection | None = None, connection_string: str, db_schema: str | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, embedding_function: Embeddings, embedding_length: int, relevance_score_fn: Callable[[float], float] | None = None, table_name: str = 'sqlserver_vectorstore') → None[source]#

初始化SQL Server向量存储。

Parameters:

  • connection (Connection | None) – 可选的 SQLServer 连接。

  • connection_string (str) – SQLServer 连接字符串。 如果连接字符串不包含用户名和密码 或 TrustedConnection=yes，则使用 Entra ID 认证。 SQL Server ODBC 连接字符串可以从 Azure 门户中数据库的 连接字符串 窗格中获取。 示例连接字符串格式： - “Driver=;Server=;Database=; Uid=;Pwd=;TrustServerCertificate=no;” - “mssql+pyodbc://username:password@servername/dbname?other_params”

  • db_schema (str | None) – 将在其中创建向量存储的模式。 此模式必须存在，并且用户必须对该模式具有权限。

  • distance_strategy (DistanceStrategy) – 用于比较嵌入的距离策略。 默认值为 COSINE。可用选项有： - COSINE - DOT - EUCLIDEAN

  • embedding_function (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。

  • embedding_length (int) – 要存储在表中的向量的长度（维度）。 请注意，只有相同大小的向量才能添加到向量存储中。

  • relevance_score_fn (Callable[[float], float] | None) – 要使用的相关性评分函数。 可选参数，默认为 None。

  • table_name (str) – 用于存储嵌入的表名。 默认值为 sqlserver_vectorstore。

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, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

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

Parameters:

  • texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

  • ids (list[str] | None) – 可选的列表

  • **kwargs (Any) – 向量存储特定参数。

Returns:

将文本添加到向量存储中后的ID列表。

Raises:

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

  • ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

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

add_texts 函数用于 SQLServer_VectorStore 类。

Compute the embeddings for the input texts and store embeddings

在向量存储中。

Parameters:

  • texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • metadatas (List[dict] | None) – 与输入文本相关联的元数据列表（python字典）。

  • ids (List[str] | None) – 输入文本的ID列表。

  • **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列表。如果为None，则删除所有。默认值为None。

  • **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, *, ids: list[str] | None = None, **kwargs: Any) → VST#

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

Parameters:

  • texts (list[str]) – 要添加到向量存储中的文本。

  • embedding (Embeddings) – 使用的嵌入函数。

  • metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

  • ids (list[str] | None) – 可选的与文本关联的ID列表。

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

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

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

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

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

Parameters:

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

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

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • kwargs (Any)

Returns:

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

Return type:

列表[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) – 返回的文档数量。默认为4。

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

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

Returns:

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

Return type:

列表[Document]

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]

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

Parameters:

  • query (str) – 输入文本。

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

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

Returns:

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

Return type:

列表[Document]

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

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

Parameters:

  • embedding (list[float]) – 用于查找相似文档的嵌入。

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

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

Returns:

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

Return type:

列表[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

异步返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

  • query (str) – 输入文本。

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

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

    过滤检索到的文档集

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

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

Parameters:

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

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

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

通过ID删除向量存储中的嵌入。

Parameters:

  • ids (List[str] | None) – 要删除的ID列表。如果为None，则删除所有。默认值为None。 如果提供空列表，则不会删除任何数据。

  • kwargs (Any) – 向量存储特定参数。

Returns:

可选[布尔]

Return type:

布尔值 | 无

drop() → None[source]#

删除在向量存储初始化期间创建的每个表。

Return type:

无

classmethod from_documents(documents: List[Document], embedding: Embeddings, connection_string: str = '', embedding_length: int = 0, table_name: str = 'sqlserver_vectorstore', db_schema: str | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, **kwargs: Any) → SQLServer_VectorStore[source]#

创建一个从文本和嵌入初始化的SQL Server向量存储。

Parameters:

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

  • embedding (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。

  • connection_string (str) – SQLServer 连接字符串。 如果连接字符串不包含用户名和密码 或 TrustedConnection=yes，则使用 Entra ID 认证。 SQL Server ODBC 连接字符串可以从 Azure 门户中数据库的 连接字符串 窗格中获取。 示例连接字符串格式： - “Driver=;Server=;Database=; Uid=;Pwd=;TrustServerCertificate=no;” - “mssql+pyodbc://username:password@servername/dbname?other_params”

  • embedding_length (int) – 要存储在表中的向量的长度（维度）。 请注意，只有相同大小的向量才能添加到向量存储中。

  • table_name (str) – 用于存储嵌入的表名。 默认值为 sqlserver_vectorstore。

  • db_schema (str | None) – 将在其中创建向量存储的模式。 此模式必须存在，并且用户必须对该模式具有权限。

  • distance_strategy (DistanceStrategy) – 用于比较嵌入的距离策略。 默认值为 COSINE。可用选项有： - COSINE - DOT - EUCLIDEAN

  • ids (List[str] | None) – 输入文本的可选ID列表。

  • **kwargs (Any) – 向量存储特定参数。

Returns:

一个SQL Server向量存储。

Return type:

SQLServer_VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, connection_string: str = '', embedding_length: int = 0, table_name: str = 'sqlserver_vectorstore', db_schema: str | None = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, **kwargs: Any) → SQLServer_VectorStore[来源]#

创建一个从文本和嵌入初始化的SQL Server向量存储。

Parameters:

  • texts (List[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • embedding (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。

  • metadatas (List[dict] | None) – 可选的与输入文本相关联的元数据列表（python字典）。

  • connection_string (str) – SQLServer 连接字符串。 如果连接字符串不包含用户名和密码 或 TrustedConnection=yes，则使用 Entra ID 认证。 SQL Server ODBC 连接字符串可以从 Azure 门户中数据库的 连接字符串 窗格中获取。 示例连接字符串格式： - “Driver=;Server=;Database=; Uid=;Pwd=;TrustServerCertificate=no;” - “mssql+pyodbc://username:password@servername/dbname?other_params”

  • embedding_length (int) – 要存储在表中的向量的长度（维度）。 请注意，只有相同大小的向量才能添加到向量存储中。

  • table_name (str) – 用于存储嵌入的表名。

  • db_schema (str | None) – 将在其中创建向量存储的模式。 此模式必须存在，并且用户必须对该模式具有权限。

  • distance_strategy (DistanceStrategy) – 用于比较嵌入的距离策略。 默认值为 COSINE。可用选项有： - COSINE - DOT - EUCLIDEAN

  • ids (List[str] | None) – 输入文本的可选ID列表。

  • **kwargs (Any) – 向量存储特定参数。

Returns:

一个SQL Server向量存储。

Return type:

SQLServer_VectorStore

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

通过ID从向量存储中获取文档。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表

Return type:

列表[文档]

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

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

Parameters:

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

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

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • **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, **kwargs: Any) → List[Document][source]#

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

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

Parameters:

  • embedding (list[float]) – 用于查找相似文档的嵌入。

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

  • fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

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

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

Parameters:

  • query (str) – 要查找最相似嵌入的文本。

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

  • **kwargs (Any) – 用于在相似性搜索期间根据元数据进行过滤的值。

Returns:

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

Return type:

列表[文档]

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

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

Parameters:

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

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

  • **kwargs (Any) – 用于在相似性搜索期间根据元数据进行过滤的值。

Returns:

与提供的嵌入最相似的文档列表。

Return type:

列表[文档]

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

通过向量进行相似性搜索并评分。

Run similarity search with distance, given an embedding

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

Parameters:

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

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

  • **kwargs (Any) – 用于在相似性搜索期间根据元数据进行过滤的值。

Returns:

文档及其伴随分数的元组列表，按与提供的嵌入的相似度排序。 请注意，分数越小表示相似度越高。

Return type:

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

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

  • query (str) – 输入文本。

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

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

    用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

带分数的相似性搜索。

Run similarity search with distance and

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

Parameters:

  • query (str) – 要查找最相似嵌入的文本。

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

  • **kwargs (Any) – 用于在相似性搜索期间根据元数据进行过滤的值。

Returns:

文档及其伴随分数的元组列表，按与提供的查询的相似度排序。 请注意，分数越小意味着相似度越高。

Return type:

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