`langchain_community.vectorstores.singlestoredb`.SingleStoreDB¶

class langchain_community.vectorstores.singlestoredb.SingleStoreDB(embedding: Embeddings, *, distance_strategy: DistanceStrategy = DistanceStrategy.DOT_PRODUCT, table_name: str = 'embeddings', content_field: str = 'content', metadata_field: str = 'metadata', vector_field: str = 'vector', id_field: str = 'id', use_vector_index: bool = False, vector_index_name: str = '', vector_index_options: Optional[dict] = None, vector_size: int = 1536, use_full_text_search: bool = False, pool_size: int = 5, max_overflow: int = 10, timeout: float = 30, **kwargs: Any)[source]¶

SingleStore DB 向量存储。

使用此类的先决条件是安装 singlestoredb Python 包。

可以通过提供嵌入函数以及与数据库连接、连接池相关的参数来创建 SingleStoreDB 向量存储，还可以选择性地提供要使用的表和字段的名称。

初始化所需的组件。

参数：

embedding (Embeddings): 文本嵌入模型。

distance_strategy (DistanceStrategy, 可选):

确定用于计算嵌入空间中向量之间距离的策略。默认为DOT_PRODUCT。可用选项为： - DOT_PRODUCT: 计算两个向量的数量积。

这是默认行为。

EUCLIDEAN_DISTANCE: 计算两个向量之间的欧氏距离。
此度量考虑向量空间中的几何距离，可能更适合依赖空间关系的嵌入。此度量不兼容WEIGHTED_SUM搜索策略。

table_name (str, 可选): 指定正在使用的表的名称。

默认为”embeddings”。

content_field (str, 可选): 指定存储内容的字段。

默认为”content”。

metadata_field (str, 可选): 指定存储元数据的字段。

默认为”metadata”。

vector_field (str, 可选): 指定存储向量的字段。

默认为”vector”。

id_field (str, 可选): 指定存储id的字段。

默认为”id”。

use_vector_index (bool, 可选): 切换使用向量索引。

仅适用于SingleStoreDB 8.5或更高版本。默认为False。如果设置为True，则需要将vector_size参数设置为适当的值。

vector_index_name (str, 可选): 指定向量索引的名称。

默认为空。如果use_vector_index设置为False，则将被忽略。

vector_index_options (dict, 可选): 指定向量索引的选项。

默认为{}。如果use_vector_index设置为False，则将被忽略。选项包括： index_type (str, 可选): 指定索引的类型。

默认为IVF_PQFS。

更多选项，请参考SingleStoreDB文档： https://docs.singlestore.com/cloud/reference/sql-reference/vector-functions/vector-indexing/

vector_size (int, 可选): 指定向量的大小。

默认为1536。如果use_vector_index设置为True，则需要此参数。应设置为与存储在vector_field中的向量大小相同的值。

use_full_text_search (bool, 可选): 切换使用文本全文索引。

默认为False。如果设置为True，表将在内容字段上创建全文索引，并且simularity_search方法将使用TEXT_ONLY、FILTER_BY_TEXT、FILTER_BY_VECTOR和WIGHTED_SUM搜索策略。如果设置为False，simularity_search方法将仅允许VECTOR_ONLY搜索策略。

以下参数与连接池有关：

pool_size (int, 可选): 确定连接池中活动连接的数量。: 默认为5。
max_overflow (int, 可选): 确定连接池大小之外允许的最大连接数。: 默认为10。
timeout (float, 可选): 指定建立连接的最大等待时间（秒）。: 默认为30。

以下参数与数据库连接有关：

host (str, 可选): 指定数据库连接的主机名、IP地址或URL。: 默认方案为”mysql”。

user (str, 可选): 数据库用户名。 password (str, 可选): 数据库密码。 port (int, 可选): 数据库端口。对于非HTTP连接，默认为3306，HTTP连接为80，HTTPS连接为443。 database (str, 可选): 数据库名称。

其他可选参数可进一步定制数据库连接：

pure_python (bool, 可选): 切换连接器模式。如果为True，则以纯Python模式运行。 local_infile (bool, 可选): 允许本地文件上传。 charset (str, 可选): 指定字符串值的字符集。 ssl_key (str, 可选): 指定包含SSL密钥的文件路径。 ssl_cert (str, 可选): 指定包含SSL证书的文件路径。 ssl_ca (str, 可选): 指定包含SSL证书颁发机构的文件路径。 ssl_cipher (str, 可选): 设置SSL密码列表。 ssl_disabled (bool, 可选): 禁用SSL使用。 ssl_verify_cert (bool, 可选): 验证服务器的证书。

如果指定了``ssl_ca``，则会自动启用。

ssl_verify_identity (bool, 可选): 验证服务器的身份。 conv (dict[int, Callable], 可选): 数据转换函数的字典。 credential_type (str, 可选): 指定要使用的身份验证类型：auth.PASSWORD、auth.JWT或auth.BROWSER_SSO。 autocommit (bool, 可选): 启用自动提交。 results_type (str, 可选): 确定查询结果的结构：

元组、命名元组、字典。

results_format (str, 可选): 已弃用。此选项已更名为results_type。

示例：

基本用法：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    host="https://user:password@127.0.0.1:3306/database"
)

高级用法：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    distance_strategy=DistanceStrategy.EUCLIDEAN_DISTANCE,
    host="127.0.0.1",
    port=3306,
    user="user",
    password="password",
    database="db",
    table_name="my_custom_table",
    pool_size=10,
    timeout=60,
)

使用环境变量：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

os.environ['SINGLESTOREDB_URL'] = 'me:p455w0rd@s2-host.com/my_db'
vectorstore = SingleStoreDB(OpenAIEmbeddings())

使用向量索引：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

os.environ['SINGLESTOREDB_URL'] = 'me:p455w0rd@s2-host.com/my_db'
vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    use_vector_index=True,
)

使用全文索引：

Attributes

embeddings

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

Methods

`__init__`(embedding, *[, distance_strategy, ...])	初始化所需的组件。
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_images`(uris[, metadatas, embeddings])	将图像通过嵌入运行并添加到向量存储中。
`add_texts`(texts[, metadatas, embeddings])	将更多文本添加到向量存储中。
`adelete`([ids])	根据向量ID或其他条件进行删除。
`afrom_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	返回从文本和嵌入初始化的VectorStore。
`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或其他条件进行删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	从原始文档创建一个SingleStoreDB向量存储。这是一个用户友好的接口，可以： 1. 嵌入文档。 2. 在SingleStoreDB中为嵌入创建一个新表。 3. 将文档添加到新创建的表中。这旨在是一个快速入门的方式。参数： texts（List[str]）：要添加到向量存储中的文本列表。 embedding（Embeddings）：文本嵌入模型。 metadatas（Optional[List[dict]，可选）：元数据的可选列表。默认为None。 distance_strategy（DistanceStrategy，可选）：确定用于计算嵌入空间中向量之间距离的策略。默认为DOT_PRODUCT。可用选项包括： - DOT_PRODUCT：计算两个向量的数量积。这是默认行为。 - EUCLIDEAN_DISTANCE：计算两个向量之间的欧氏距离。此度量考虑向量空间中的几何距离，可能更适用于依赖空间关系的嵌入。此度量与WEIGHTED_SUM搜索策略不兼容。 table_name（str，可选）：指定要使用的表的名称。默认为"embeddings"。 content_field（str，可选）：指定存储内容的字段。默认为"content"。 metadata_field（str，可选）：指定存储元数据的字段。默认为"metadata"。 vector_field（str，可选）：指定存储向量的字段。默认为"vector"。 id_field（str，可选）：指定存储id的字段。默认为"id"。 use_vector_index（bool，可选）：切换使用向量索引。仅适用于SingleStoreDB 8.5或更高版本。默认为False。如果设置为True，则需要将vector_size参数设置为适当的值。 vector_index_name（str，可选）：指定向量索引的名称。默认为空。如果use_vector_index设置为False，则将被忽略。 vector_index_options（dict，可选）：指定向量索引的选项。默认为{}。如果use_vector_index设置为False，则将被忽略。选项包括： index_type（str，可选）：指定索引的类型。默认为IVF_PQFS。更多选项，请参阅SingleStoreDB文档： https://docs.singlestore.com/cloud/reference/sql-reference/vector-functions/vector-indexing/ vector_size（int，可选）：指定向量的大小。默认为1536。如果use_vector_index设置为True，则需要设置。应设置为与存储在vector_field中的向量大小相同的值。 use_full_text_search（bool，可选）：切换是否在文档内容上使用全文索引。默认为False。如果设置为True，则表将创建具有全文索引的内容字段，并且simularity_search方法将使用TEXT_ONLY、FILTER_BY_TEXT、FILTER_BY_VECTOR和WIGHTED_SUM搜索策略。如果设置为False，则simularity_search方法将仅允许VECTOR_ONLY搜索策略。.
`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, ...])	返回与查询最相似的文档。使用余弦相似度。

Parameters

embedding (Embeddings) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_field (str) –
metadata_field (str) –
vector_field (str) –
id_field (str) –
use_vector_index (bool) –
vector_index_name (str) –
vector_index_options (Optional[dict]) –
vector_size (int) –
use_full_text_search (bool) –
pool_size (int) –
max_overflow (int) –
timeout (float) –
kwargs (Any) –

__init__(embedding: Embeddings, *, distance_strategy: DistanceStrategy = DistanceStrategy.DOT_PRODUCT, table_name: str = 'embeddings', content_field: str = 'content', metadata_field: str = 'metadata', vector_field: str = 'vector', id_field: str = 'id', use_vector_index: bool = False, vector_index_name: str = '', vector_index_options: Optional[dict] = None, vector_size: int = 1536, use_full_text_search: bool = False, pool_size: int = 5, max_overflow: int = 10, timeout: float = 30, **kwargs: Any)[source]¶

初始化所需的组件。

参数：

embedding (Embeddings): 文本嵌入模型。

distance_strategy (DistanceStrategy, 可选):

确定用于计算嵌入空间中向量之间距离的策略。默认为DOT_PRODUCT。可用选项为： - DOT_PRODUCT: 计算两个向量的数量积。

这是默认行为。

EUCLIDEAN_DISTANCE: 计算两个向量之间的欧氏距离。
此度量考虑向量空间中的几何距离，可能更适合依赖空间关系的嵌入。此度量不兼容WEIGHTED_SUM搜索策略。

table_name (str, 可选): 指定正在使用的表的名称。

默认为”embeddings”。

content_field (str, 可选): 指定存储内容的字段。

默认为”content”。

metadata_field (str, 可选): 指定存储元数据的字段。

默认为”metadata”。

vector_field (str, 可选): 指定存储向量的字段。

默认为”vector”。

id_field (str, 可选): 指定存储id的字段。

默认为”id”。

use_vector_index (bool, 可选): 切换使用向量索引。

仅适用于SingleStoreDB 8.5或更高版本。默认为False。如果设置为True，则需要将vector_size参数设置为适当的值。

vector_index_name (str, 可选): 指定向量索引的名称。

默认为空。如果use_vector_index设置为False，则将被忽略。

vector_index_options (dict, 可选): 指定向量索引的选项。

默认为{}。如果use_vector_index设置为False，则将被忽略。选项包括： index_type (str, 可选): 指定索引的类型。

默认为IVF_PQFS。

更多选项，请参考SingleStoreDB文档： https://docs.singlestore.com/cloud/reference/sql-reference/vector-functions/vector-indexing/

vector_size (int, 可选): 指定向量的大小。

默认为1536。如果use_vector_index设置为True，则需要此参数。应设置为与存储在vector_field中的向量大小相同的值。

use_full_text_search (bool, 可选): 切换使用文本全文索引。

以下参数与连接池有关：

pool_size (int, 可选): 确定连接池中活动连接的数量。: 默认为5。
max_overflow (int, 可选): 确定连接池大小之外允许的最大连接数。: 默认为10。
timeout (float, 可选): 指定建立连接的最大等待时间（秒）。: 默认为30。

以下参数与数据库连接有关：

host (str, 可选): 指定数据库连接的主机名、IP地址或URL。: 默认方案为”mysql”。

其他可选参数可进一步定制数据库连接：

如果指定了``ssl_ca``，则会自动启用。

元组、命名元组、字典。

results_format (str, 可选): 已弃用。此选项已更名为results_type。

示例：

基本用法：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    host="https://user:password@127.0.0.1:3306/database"
)

高级用法：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    distance_strategy=DistanceStrategy.EUCLIDEAN_DISTANCE,
    host="127.0.0.1",
    port=3306,
    user="user",
    password="password",
    database="db",
    table_name="my_custom_table",
    pool_size=10,
    timeout=60,
)

使用环境变量：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

os.environ['SINGLESTOREDB_URL'] = 'me:p455w0rd@s2-host.com/my_db'
vectorstore = SingleStoreDB(OpenAIEmbeddings())

使用向量索引：

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import SingleStoreDB

os.environ['SINGLESTOREDB_URL'] = 'me:p455w0rd@s2-host.com/my_db'
vectorstore = SingleStoreDB(
    OpenAIEmbeddings(),
    use_vector_index=True,
)

使用全文索引：

Parameters

embedding (Embeddings) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_field (str) –
metadata_field (str) –
vector_field (str) –
id_field (str) –
use_vector_index (bool) –
vector_index_name (str) –
vector_index_options (Optional[dict]) –
vector_size (int) –
use_full_text_search (bool) –
pool_size (int) –
max_overflow (int) –
timeout (float) –
kwargs (Any) –

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_images(uris: List[str], metadatas: Optional[List[dict]] = None, embeddings: Optional[List[List[float]]] = None, **kwargs: Any) → List[str][source]¶

将图像通过嵌入运行并添加到向量存储中。

参数：

uris List[str]：图像文件路径。: 每个URI将作为文档内容添加到向量存储中。
metadatas（可选[List[dict]]，可选）：元数据的可选列表。: 默认为None。
embeddings（可选[List[List[float]]]，可选）：可选的预生成的: 嵌入。默认为None。

返回：

List[str]：空列表

Parameters

uris (List[str]) –
metadatas (Optional[List[dict]]) –
embeddings (Optional[List[List[float]]]) –
kwargs (Any) –

Return type

List[str]

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

将更多文本添加到向量存储中。

参数：: texts（Iterable[str]）：要添加到向量存储中的字符串/文本的可迭代对象。 metadatas（Optional[List[dict]，可选）：元数据的可选列表。默认为None。 embeddings（Optional[List[List[float]]]，可选）：可选的预生成的嵌入。默认为None。
返回：: List[str]：空列表

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
embeddings (Optional[List[List[float]]]) –
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: VectorStoreRetriever

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) → Optional[bool]¶

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

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_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, distance_strategy: DistanceStrategy = DistanceStrategy.DOT_PRODUCT, table_name: str = 'embeddings', content_field: str = 'content', metadata_field: str = 'metadata', vector_field: str = 'vector', id_field: str = 'id', use_vector_index: bool = False, vector_index_name: str = '', vector_index_options: Optional[dict] = None, vector_size: int = 1536, use_full_text_search: bool = False, pool_size: int = 5, max_overflow: int = 10, timeout: float = 30, **kwargs: Any) → SingleStoreDB[source]¶

从原始文档创建一个SingleStoreDB向量存储。这是一个用户友好的接口，可以：

嵌入文档。

在SingleStoreDB中为嵌入创建一个新表。

将文档添加到新创建的表中。

这旨在是一个快速入门的方式。参数：

texts（List[str]）：要添加到向量存储中的文本列表。 embedding（Embeddings）：文本嵌入模型。 metadatas（Optional[List[dict]，可选）：元数据的可选列表。

默认为None。

distance_strategy（DistanceStrategy，可选）：
确定用于计算嵌入空间中向量之间距离的策略。默认为DOT_PRODUCT。可用选项包括： - DOT_PRODUCT：计算两个向量的数量积。

这是默认行为。

EUCLIDEAN_DISTANCE：计算两个向量之间的欧氏距离。
此度量考虑向量空间中的几何距离，可能更适用于依赖空间关系的嵌入。此度量与WEIGHTED_SUM搜索策略不兼容。

table_name（str，可选）：指定要使用的表的名称。
默认为”embeddings”。

content_field（str，可选）：指定存储内容的字段。
默认为”content”。

metadata_field（str，可选）：指定存储元数据的字段。
默认为”metadata”。

vector_field（str，可选）：指定存储向量的字段。
默认为”vector”。

id_field（str，可选）：指定存储id的字段。
默认为”id”。

use_vector_index（bool，可选）：切换使用向量索引。
仅适用于SingleStoreDB 8.5或更高版本。默认为False。如果设置为True，则需要将vector_size参数设置为适当的值。

vector_index_name（str，可选）：指定向量索引的名称。
默认为空。如果use_vector_index设置为False，则将被忽略。

vector_index_options（dict，可选）：指定向量索引的选项。
默认为{}。如果use_vector_index设置为False，则将被忽略。选项包括： index_type（str，可选）：指定索引的类型。

默认为IVF_PQFS。

更多选项，请参阅SingleStoreDB文档： https://docs.singlestore.com/cloud/reference/sql-reference/vector-functions/vector-indexing/

vector_size（int，可选）：指定向量的大小。
默认为1536。如果use_vector_index设置为True，则需要设置。应设置为与存储在vector_field中的向量大小相同的值。

use_full_text_search（bool，可选）：切换是否在文档内容上使用全文索引。
默认为False。如果设置为True，则表将创建具有全文索引的内容字段，并且simularity_search方法将使用TEXT_ONLY、FILTER_BY_TEXT、FILTER_BY_VECTOR和WIGHTED_SUM搜索策略。如果设置为False，则simularity_search方法将仅允许VECTOR_ONLY搜索策略。

pool_size（int，可选）：确定池中活动连接的数量。
默认为5。

max_overflow（int，可选）：确定池大小之外允许的最大连接数。
默认为10。

timeout（float，可选）：指定建立连接的最大等待时间（秒）。
默认为30。

其他可选参数可进一步定制数据库连接：

pure_python（bool，可选）：切换连接器模式。如果为True，则以纯Python模式运行。 local_infile（bool，可选）：允许本地文件上传。 charset（str，可选）：指定字符串值的字符集。 ssl_key（str，可选）：指定包含SSL密钥的文件路径。 ssl_cert（str，可选）：指定包含SSL证书的文件路径。 ssl_ca（str，可选）：指定包含SSL证书颁发机构的文件路径。 ssl_cipher（str，可选）：设置SSL密码列表。 ssl_disabled（bool，可选）：禁用SSL使用。 ssl_verify_cert（bool，可选）：验证服务器的证书。

如果指定了``ssl_ca``，则自动启用。

ssl_verify_identity（bool，可选）：验证服务器的身份。 conv（dict[int，Callable]，可选）：数据转换函数的字典。 credential_type（str，可选）：指定要使用的身份验证类型：auth.PASSWORD、auth.JWT或auth.BROWSER_SSO。 autocommit（bool，可选）：启用自动提交。 results_type（str，可选）：确定查询结果的结构：元组、命名元组、字典。 results_format（str，可选）：已弃用。此选项已更名为results_type。

示例：

from langchain_community.vectorstores import SingleStoreDB
from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_texts(
    texts,
    OpenAIEmbeddings(),
    host="username:password@localhost:3306/database"
)

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
distance_strategy (DistanceStrategy) –
table_name (str) –
content_field (str) –
metadata_field (str) –
vector_field (str) –
id_field (str) –
use_vector_index (bool) –
vector_index_name (str) –
vector_index_options (Optional[dict]) –
vector_size (int) –
use_full_text_search (bool) –
pool_size (int) –
max_overflow (int) –
timeout (float) –
kwargs (Any) –

Return type

SingleStoreDB

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, search_strategy: SearchStrategy = SearchStrategy.VECTOR_ONLY, filter_threshold: float = 0, text_weight: float = 0.5, vector_weight: float = 0.5, vector_select_count_multiplier: int = 10, **kwargs: Any) → List[Document][source]¶

返回与查询文本最相似的索引文档。

使用余弦相似度。

参数：

query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。 filter（dict）：要按元数据字段和值进行过滤的字典。默认为None。 search_strategy（SearchStrategy）：要使用的搜索策略。

默认为SearchStrategy.VECTOR_ONLY。可用选项包括： - SearchStrategy.VECTOR_ONLY：仅按矢量相似性搜索。 - SearchStrategy.TEXT_ONLY：仅按文本相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.FILTER_BY_TEXT：按文本相似性过滤并按矢量相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.FILTER_BY_VECTOR：按矢量相似性过滤并按文本相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.WEIGHTED_SUM：按文本和矢量相似性的加权和搜索。仅当use_full_text_search为True且distance_strategy为DOT_PRODUCT时才可用。

filter_threshold（float）：按文本或矢量相似性进行过滤的阈值。默认为0。仅当search_strategy为SearchStrategy.FILTER_BY_TEXT或SearchStrategy.FILTER_BY_VECTOR时才有效。 text_weight（float）：加权和搜索策略中文本相似性的权重。默认为0.5。仅当search_strategy为SearchStrategy.WEIGHTED_SUM时才有效。 vector_weight（float）：加权和搜索策略中矢量相似性的权重。默认为0.5。仅当search_strategy为SearchStrategy.WEIGHTED_SUM时才有效。 vector_select_count_multiplier（int）：在使用矢量索引时选择矢量数量的乘数。默认为10。

仅当use_vector_index为True且search_strategy为SearchStrategy.WEIGHTED_SUM或SearchStrategy.FILTER_BY_TEXT时才有效。选择的矢量数量将为k * vector_select_count_multiplier。这是由于矢量索引的限制而需要的。

返回：

List[Document]：与查询文本最相似的文档列表。

示例：

基本用法： .. code-block:: python

from langchain_community.vectorstores import SingleStoreDB from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
docs, OpenAIEmbeddings(), host=”username:password@localhost:3306/database”

) results = s2.similarity_search(“query text”, 1,

{“metadata_field”: “metadata_value”})

不同的搜索策略： .. code-block:: python

from langchain_community.vectorstores import SingleStoreDB from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
docs, OpenAIEmbeddings(), host=”username:password@localhost:3306/database”, use_full_text_search=True, use_vector_index=True,

) results = s2.similarity_search(“query text”, 1,

search_strategy=SingleStoreDB.SearchStrategy.FILTER_BY_TEXT, filter_threshold=0.5)

加权和搜索策略： .. code-block:: python

from langchain_community.vectorstores import SingleStoreDB from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
docs, OpenAIEmbeddings(), host=”username:password@localhost:3306/database”, use_full_text_search=True, use_vector_index=True,

) results = s2.similarity_search(“query text”, 1,

search_strategy=SingleStoreDB.SearchStrategy.WEIGHTED_SUM, text_weight=0.3, vector_weight=0.7)

Parameters

query (str) –
k (int) –
filter (Optional[dict]) –
search_strategy (SearchStrategy) –
filter_threshold (float) –
text_weight (float) –
vector_weight (float) –
vector_select_count_multiplier (int) –
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 = 4, filter: Optional[dict] = None, search_strategy: SearchStrategy = SearchStrategy.VECTOR_ONLY, filter_threshold: float = 1, text_weight: float = 0.5, vector_weight: float = 0.5, vector_select_count_multiplier: int = 10, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与查询最相似的文档。使用余弦相似度。

参数：

query：要查找相似文档的文本。 k：要返回的文档数量。默认为4。 filter：要按元数据字段和值进行过滤的字典。默认为None。 search_strategy（SearchStrategy）：要使用的搜索策略。

默认为SearchStrategy.VECTOR_ONLY。可用选项包括： - SearchStrategy.VECTOR_ONLY：仅按矢量相似性搜索。 - SearchStrategy.TEXT_ONLY：仅按文本相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.FILTER_BY_TEXT：按文本相似性过滤并按矢量相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.FILTER_BY_VECTOR：按矢量相似性过滤并按文本相似性搜索。仅当use_full_text_search为True时才可用。 - SearchStrategy.WEIGHTED_SUM：按文本和矢量相似性的加权和搜索。仅当use_full_text_search为True且distance_strategy为DOT_PRODUCT时才可用。

filter_threshold（float）：按文本或矢量相似性过滤的阈值。默认为0。仅当search_strategy为SearchStrategy.FILTER_BY_TEXT或SearchStrategy.FILTER_BY_VECTOR时才生效。 text_weight（float）：加权和搜索策略中文本相似性的权重。默认为0.5。仅当search_strategy为SearchStrategy.WEIGHTED_SUM时才生效。 vector_weight（float）：加权和搜索策略中矢量相似性的权重。默认为0.5。仅当search_strategy为SearchStrategy.WEIGHTED_SUM时才生效。 vector_select_count_multiplier（int）：在使用矢量索引时选择矢量数量的乘数。默认为10。

该参数仅在use_vector_index为True且search_strategy为SearchStrategy.WEIGHTED_SUM或SearchStrategy.FILTER_BY_TEXT时生效。选择的矢量数量将为k * vector_select_count_multiplier。这是由于矢量索引的限制而需要的。

返回：

返回与查询最相似的文档列表，以及每个文档的分数。

异常：

ValueError：如果搜索策略与距离策略不受支持。

示例：

基本用法： .. code-block:: python

from langchain_community.vectorstores import SingleStoreDB from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
docs, OpenAIEmbeddings(), host=”username:password@localhost:3306/database”

) results = s2.similarity_search_with_score(“query text”, 1,

{“metadata_field”: “metadata_value”})

不同的搜索策略：

from langchain_community.vectorstores import SingleStoreDB
from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
    docs,
    OpenAIEmbeddings(),
    host="username:password@localhost:3306/database",
    use_full_text_search=True,
    use_vector_index=True,
)
results = s2.similarity_search_with_score("query text", 1,
        search_strategy=SingleStoreDB.SearchStrategy.FILTER_BY_VECTOR,
        filter_threshold=0.5)

加权和搜索策略： .. code-block:: python

from langchain_community.vectorstores import SingleStoreDB from langchain_openai import OpenAIEmbeddings

s2 = SingleStoreDB.from_documents(
docs, OpenAIEmbeddings(), host=”username:password@localhost:3306/database”, use_full_text_search=True, use_vector_index=True,

) results = s2.similarity_search_with_score(“query text”, 1,

search_strategy=SingleStoreDB.SearchStrategy.WEIGHTED_SUM, text_weight=0.3, vector_weight=0.7)

Parameters

query (str) –
k (int) –
filter (Optional[dict]) –
search_strategy (SearchStrategy) –
filter_threshold (float) –
text_weight (float) –
vector_weight (float) –
vector_select_count_multiplier (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using SingleStoreDB¶

langchain_community.vectorstores.singlestoredb.SingleStoreDB¶

Examples using SingleStoreDB¶

`langchain_community.vectorstores.singlestoredb`.SingleStoreDB¶