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:用于生成嵌入的嵌入函数。 table_name (str, 可选):用于存储向量数据的表的名称。如果不提供表名,
将自动创建一个名为`langchain_vector`的默认表。
distance_strategy:用于相似性搜索的策略,默认为”cosine”,有效值为:”l2”、”cosine”、”inner_product”。 engine_args (Optional[Dict]):数据库引擎的附加参数,默认为None。 drop_existing_table:在初始化之前删除现有的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)
Attributes
distance_strategy
返回当前的距离策略。
embeddings
返回用于生成嵌入向量的函数。
tidb_vector_client
返回 TiDB 向量客户端。
Methods
__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。
amax_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从此VectorStore初始化的VectorStoreRetriever。
asearch
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
asimilarity_search
(query[, k])返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性分数在范围[0, 1]内,异步执行。
asimilarity_search_with_score
(*args, **kwargs)使用异步方式运行相似性搜索与距离。
delete
([ids])从TiDB矢量存储中删除矢量数据。
从TiDB数据库中删除Vector Store。
from_documents
(documents, embedding, **kwargs)返回从文档和嵌入初始化的VectorStore。
from_existing_vector_table
(embedding, ...[, ...])从TiDB中的现有TiDB向量存储中创建一个VectorStore实例。
from_texts
(texts, embedding[, metadatas])从文本列表创建一个VectorStore。
max_marginal_relevance_search
(query[, k, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
search
(query, search_type, **kwargs)返回使用指定搜索类型的查询最相似的文档。
similarity_search
(query[, k, filter])使用给定的查询执行相似性搜索。
similarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关性得分在[0, 1]范围内。
similarity_search_with_score
(query[, k, filter])执行基于给定查询的相似性搜索,并基于得分进行排序。
- Parameters
connection_string (str) –
embedding_function (Embeddings) –
table_name (str) –
distance_strategy (str) –
engine_args (Optional[Dict[str, Any]]) –
drop_existing_table (bool) –
kwargs (Any) –
- Return type
None
- __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:用于生成嵌入的嵌入函数。 table_name (str, 可选):用于存储向量数据的表的名称。如果不提供表名,
将自动创建一个名为`langchain_vector`的默认表。
distance_strategy:用于相似性搜索的策略,默认为”cosine”,有效值为:”l2”、”cosine”、”inner_product”。 engine_args (Optional[Dict]):数据库引擎的附加参数,默认为None。 drop_existing_table:在初始化之前删除现有的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)
- Parameters
connection_string (str) –
embedding_function (Embeddings) –
table_name (str) –
distance_strategy (str) –
engine_args (Optional[Dict[str, Any]]) –
drop_existing_table (bool) –
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] ¶
运行更多的文本通过嵌入,并添加到向量存储中。
- 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, 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,如果未提供将生成。
- 返回:
List[str]: 分配给添加的文本的 ID。
- Parameters
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
List[str]
- async adelete(ids: Optional[List[str]] = None, **kwargs: Any) Optional[bool] ¶
根据向量ID或其他条件进行删除。
- 参数:
ids:要删除的ID列表。 **kwargs:子类可能使用的其他关键字参数。
- 返回:
Optional[bool]:如果删除成功则为True,否则为False,如果未实现则为None。
- 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
documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –
- Return type
VST
- async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) VST ¶
返回从文本和嵌入初始化的VectorStore。
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –
- Return type
VST
- async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
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
- async asearch(query: str, search_type: str, **kwargs: Any) List[Document] ¶
返回使用指定搜索类型的查询最相似的文档。
- Parameters
query (str) –
search_type (str) –
kwargs (Any) –
- Return type
List[Document]
- async asimilarity_search(query: str, k: int = 4, **kwargs: Any) List[Document] ¶
返回与查询最相似的文档。
- 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] ¶
返回与嵌入向量最相似的文档。
- 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]] ¶
返回文档和相关性分数在范围[0, 1]内,异步执行。
0表示不相似,1表示最相似。
- 参数:
query:输入文本 k:要返回的文档数量。默认为4。 **kwargs:要传递给相似性搜索的kwargs。应包括:
score_threshold:可选,介于0到1之间的浮点值,用于过滤检索到的文档集
- 返回:
元组列表(doc,相似度分数)的列表
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- async asimilarity_search_with_score(*args: Any, **kwargs: Any) List[Tuple[Document, float]] ¶
使用异步方式运行相似性搜索与距离。
- Parameters
args (Any) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]
- delete(ids: Optional[List[str]] = None, **kwargs: Any) None [source]¶
从TiDB矢量存储中删除矢量数据。
- 参数:
ids(可选[List[str]]):要删除的矢量ID列表。 **kwargs:额外的关键字参数。
- Parameters
ids (Optional[List[str]]) –
kwargs (Any) –
- Return type
None
- classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) VST ¶
返回从文档和嵌入初始化的VectorStore。
- Parameters
documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –
- Return type
VST
- 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, 可选):用于存储向量数据的表的名称,
默认为”langchain_vector”。
- distance_strategy:用于相似性搜索的距离策略,
默认为”cosine”,允许值:”l2”,”cosine”,’inner_product’。
- engine_args:底层数据库引擎的附加参数,
默认为None。
**kwargs (Any):其他关键字参数。
- 返回:
VectorStore:VectorStore实例。
- 抛出:
NoSuchTableError:如果在TiDB中指定的表不存在。
- Parameters
embedding (Embeddings) –
connection_string (str) –
table_name (str) –
distance_strategy (str) –
engine_args (Optional[Dict[str, Any]]) –
kwargs (Any) –
- Return type
- 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:与每个文本对应的元数据字典列表,默认为None。 **kwargs(Any):额外的关键字参数。
connection_string(str):TiDB数据库的连接字符串,格式为:”mysql+pymysql://root@34.212.137.91:4000/test”。 table_name(str,可选):用于存储向量数据的表的名称,默认为”langchain_vector”。 distance_strategy:用于相似性搜索的距离策略,默认为”cosine”,允许值:”l2”,”cosine”,”inner_product”。 ids(Optional[List[str]):与每个文本对应的ID列表,默认为None。 engine_args:底层数据库引擎的额外参数,默认为None。 drop_existing_table:在初始化之前删除现有的TiDB表,默认为False。
- 返回:
VectorStore:创建的TiDB Vector Store。
- Parameters
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –
- Return type
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) List[Document] ¶
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- 参数:
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]
- similarity_search(query: str, k: int = 4, filter: Optional[dict] = None, **kwargs: Any) List[Document] [source]¶
使用给定的查询执行相似性搜索。
- 参数:
query(str):查询字符串。 k(int,可选):要检索的结果数量。默认为4。 filter(dict,可选):要应用于搜索结果的过滤器。
默认为None。
**kwargs:其他关键字参数。
- 返回:
List[Document]:表示搜索结果的Document对象列表。
- Parameters
query (str) –
k (int) –
filter (Optional[dict]) –
kwargs (Any) –
- Return type
List[Document]
- similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) List[Document] ¶
返回与嵌入向量最相似的文档。
- 参数:
embedding:要查找与之相似的文档的嵌入。 k:要返回的文档数量。默认为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]] ¶
返回文档和相关性得分在[0, 1]范围内。
0表示不相似,1表示最相似。
- 参数:
query:输入文本 k:要返回的文档数量。默认为4。 **kwargs:要传递给相似性搜索的kwargs。应包括:
score_threshold:可选,介于0到1之间的浮点值,用于过滤检索到的文档集
- 返回:
元组列表(doc,相似性得分)
- Parameters
query (str) –
k (int) –
kwargs (Any) –
- Return type
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,可选):要返回的结果数量。默认为5。 filter(dict,可选):要应用于搜索结果的过滤器。默认为None。 **kwargs:其他关键字参数。
- 返回:
包含相关文档及其相似性分数的元组列表。
- Parameters
query (str) –
k (int) –
filter (Optional[dict]) –
kwargs (Any) –
- Return type
List[Tuple[Document, float]]