`langchain_community.vectorstores.tidb_vector`.TiDBVectorStore¶

class langchain_community.vectorstores.tidb_vector.TiDBVectorStore(connection_string: str, embedding_function: Embeddings, table_name: str = 'langchain_vector', distance_strategy: str = 'cosine', *, engine_args: Optional[Dict[str, Any]] = None, drop_existing_table: bool = False, **kwargs: Any)[source]¶

TiDB 向量存储。

在 Langchain 中初始化 TiDB 向量存储，使用灵活且标准化的表结构来存储向量数据，该结构保持固定，不受动态表名设置的影响。

向量表模式包括： - ‘id’：每个条目的 UUID。 - ‘embedding’：在 VectorType 列中存储向量数据。 - ‘document’：Text 列，用于原始数据或其他信息。 - ‘meta’：JSON 列，用于灵活的元数据存储。 - ‘create_time’ 和 ‘update_time’：时间戳列，用于跟踪数据更改。

此表结构适用于通用用例和复杂场景，其中该表充当高级数据集成和分析的语义层，利用 SQL 进行连接查询。

参数

connection_string (str) – TiDB 数据库的连接字符串，格式为：“mysql+pymysql://root@34.212.137.91:4000/test”。
embedding_function (Embeddings) – 用于生成嵌入的嵌入函数。
table_name (str, 可选) – 将用于存储向量数据的表的名称。如果您不提供表名，将自动创建一个名为 langchain_vector 的默认表。
distance_strategy (str) – 用于相似性搜索的策略，默认为 “cosine”，有效值：“l2”、“cosine”、“inner_product”。
engine_args (Optional[Dict]) – 数据库引擎的其他参数，默认为 None。
drop_existing_table (bool) – 在初始化之前删除现有的 TiDB 表，默认为 False。
**kwargs (Any) – 其他关键字参数。

示例

from langchain_community.vectorstores import TiDBVectorStore from langchain_openai import OpenAIEmbeddings

embeddingFunc = OpenAIEmbeddings() CONNECTION_STRING = “mysql+pymysql://root@34.212.137.91:4000/test”

vs = TiDBVector.from_texts(: embedding=embeddingFunc, texts = […, …], connection_string=CONNECTION_STRING, distance_strategy=”l2”, table_name=”tidb_vector_langchain”,

)

query = “What did the president say about Ketanji Brown Jackson” docs = db.similarity_search_with_score(query)

属性

`distance_strategy`	返回当前的距离策略。
`embeddings`	返回用于生成嵌入的函数。
`tidb_vector_client`	返回 TiDB 向量客户端。

方法

`__init__`(connection_string, embedding_function)	在 Langchain 中初始化 TiDB 向量存储，使用灵活且标准化的表结构来存储向量数据，该结构保持固定，不受动态表名设置的影响。
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入运行更多文本并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas, ids])	将文本添加到 TiDB 向量存储。
`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)
`delete`([ids])	从 TiDB 向量存储中删除向量数据。
`drop_vectorstore`()	从 TiDB 数据库中删除向量存储。
`from_documents`(documents, embedding, **kwargs)	从文档和嵌入初始化并返回 VectorStore。
`from_existing_vector_table`(embedding, ...[, ...])	从 TiDB 中现有的 TiDB 向量存储创建 VectorStore 实例。
`from_texts`(texts, embedding[, metadatas])	从文本列表创建 VectorStore。
`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, filter])	使用给定的查询执行相似性搜索。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回 [0, 1] 范围内的文档和相关性得分。
`similarity_search_with_score`(query[, k, filter])	使用给定的查询执行带分数的相似性搜索。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(connection_string: str, embedding_function: Embeddings, table_name: str = 'langchain_vector', distance_strategy: str = 'cosine', *, engine_args: Optional[Dict[str, Any]] = None, drop_existing_table: bool = False, **kwargs: Any) → None[source]¶

在 Langchain 中初始化 TiDB 向量存储，使用灵活且标准化的表结构来存储向量数据，该结构保持固定，不受动态表名设置的影响。

向量表模式包括： - ‘id’：每个条目的 UUID。 - ‘embedding’：在 VectorType 列中存储向量数据。 - ‘document’：Text 列，用于原始数据或其他信息。 - ‘meta’：JSON 列，用于灵活的元数据存储。 - ‘create_time’ 和 ‘update_time’：时间戳列，用于跟踪数据更改。

此表结构适用于通用用例和复杂场景，其中该表充当高级数据集成和分析的语义层，利用 SQL 进行连接查询。

参数

connection_string (str) – TiDB 数据库的连接字符串，格式为：“mysql+pymysql://root@34.212.137.91:4000/test”。
embedding_function (Embeddings) – 用于生成嵌入的嵌入函数。
table_name (str, 可选) – 将用于存储向量数据的表的名称。如果您不提供表名，将自动创建一个名为 langchain_vector 的默认表。
distance_strategy (str) – 用于相似性搜索的策略，默认为 “cosine”，有效值：“l2”、“cosine”、“inner_product”。
engine_args (Optional[Dict]) – 数据库引擎的其他参数，默认为 None。
drop_existing_table (bool) – 在初始化之前删除现有的 TiDB 表，默认为 False。
**kwargs (Any) – 其他关键字参数。

返回类型

None

示例

from langchain_community.vectorstores import TiDBVectorStore from langchain_openai import OpenAIEmbeddings

embeddingFunc = OpenAIEmbeddings() CONNECTION_STRING = “mysql+pymysql://root@34.212.137.91:4000/test”

vs = TiDBVector.from_texts(: embedding=embeddingFunc, texts = […, …], connection_string=CONNECTION_STRING, distance_strategy=”l2”, table_name=”tidb_vector_langchain”,

)

query = “What did the president say about Ketanji Brown Jackson” docs = db.similarity_search_with_score(query)

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

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

参数

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

返回值

添加的文本的 ID 列表。

Raises

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

Raises

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

Raises

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

返回类型

List[str]

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

将文本添加到 TiDB 向量存储。

参数

texts (Iterable[str]) – 要添加的文本。
metadatas (Optional[List[dict]]) – 与每个文本关联的元数据，默认为 None。
ids (Optional[List[str]]) – 要分配给每个文本的 ID，默认为 None，如果未提供，则会生成。
kwargs (Any) –

返回值

分配给添加的文本的 ID。

返回类型

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]): 定义检索器应执行的搜索类型。可以是 “similarity”（默认）、“mmr” 或 “similarity_score_threshold”。

检索器应执行的搜索类型。可以是 “similarity”（默认）、“mmr” 或 “similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。可以包括如下内容：

搜索函数的关键字参数。可以包括如下内容：

k: 返回的文档数量 (默认: 4) 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) – 传递给搜索方法的参数。

返回值

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

Raises

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 字段，则 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) → None[source]¶

从 TiDB 向量存储中删除向量数据。

参数

ids (Optional[List[str]]) – 要删除的向量 ID 列表。
kwargs (Any) – 其他关键字参数。

返回类型

None

drop_vectorstore() → None[source]¶

从 TiDB 数据库中删除向量存储。

返回类型: None

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

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

参数

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

返回值

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

返回类型

VectorStore

classmethod from_existing_vector_table(embedding: Embeddings, connection_string: str, table_name: str, distance_strategy: str = 'cosine', *, engine_args: Optional[Dict[str, Any]] = None, **kwargs: Any) → VectorStore[source]¶

从 TiDB 中现有的 TiDB 向量存储创建 VectorStore 实例。

参数

embedding (Embeddings) – 用于生成嵌入向量的函数。
connection_string (str) – TiDB 数据库的连接字符串，格式为：“mysql+pymysql://root@34.212.137.91:4000/test”。
table_name (str, optional) – 用于存储向量数据的表名，默认为 “langchain_vector”。
distance_strategy (str) – 用于相似性搜索的距离策略，默认为 “cosine”，允许的值为：“l2”、“cosine”、“inner_product”。
engine_args (Optional[Dict[str, Any]]) – 底层数据库引擎的附加参数，默认为 None。
**kwargs (Any) – 其他关键字参数。

返回值

VectorStore 实例。

返回类型

VectorStore

Raises

NoSuchTableError – 如果指定的表在 TiDB 中不存在。

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → TiDBVectorStore[source]¶

从文本列表创建 VectorStore。

参数

texts (List[str]) – 要添加到 TiDB Vector 的文本列表。
embedding (Embeddings) – 用于生成嵌入向量的函数。
metadatas (Optional[List[dict]]) – 与每个文本对应的元数据字典列表，默认为 None。
**kwargs (Any) –
额外的关键字参数。 connection_string (str): TiDB 数据库的连接字符串，

格式: “mysql+pymysql://root@34.212.137.91:4000/test”。

table_name (str, optional): 用于存储向量数据的表名，
默认为 “langchain_vector”。

distance_strategy: 用于相似性搜索的距离策略，
默认为 “cosine”，允许的值为：“l2”、“cosine”、“inner_product”。

ids (Optional[List[str]]): 与每个文本对应的 ID 列表，
默认为 None。

engine_args: 底层数据库引擎的附加参数，
默认为 None。

drop_existing_table: 初始化之前删除现有的 TiDB 表，
默认为 False。

返回值

创建的 TiDB Vector Store。

返回类型

VectorStore

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 版本新增。

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

返回值

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

Raises

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

返回类型

List[Document]

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

使用给定的查询执行相似性搜索。

参数

query (str) – 查询字符串。
k (int, optional) – 要检索的结果数量。默认为 4。
filter (dict, optional) – 应用于搜索结果的过滤器。默认为 None。
kwargs (Any) – 其他关键字参数。

返回值

表示搜索结果的 Document 对象列表。

返回类型

List[Document]

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

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

参数

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 = 5, filter: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

使用给定的查询执行带分数的相似性搜索。

参数

query (str) – 查询字符串。
k (int, optional) – 返回结果的数量。默认为 5。
filter (dict, optional) – 应用于搜索结果的过滤器。默认为 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 版本新增。

langchain_community.vectorstores.tidb_vector.TiDBVectorStore¶

TiDBVectorStore 的使用示例¶

`langchain_community.vectorstores.tidb_vector`.TiDBVectorStore¶