Relyt

class langchain_community.vectorstores.relyt.Relyt(connection_string: str, embedding_function: Embeddings, embedding_dimension: int = 1536, collection_name: str = 'langchain_document', pre_delete_collection: bool = False, logger: Logger | None = None, engine_args: dict | None = None)

Relyt（分布式 PostgreSQL）向量存储。

Relyt 是一个分布式全 PostgreSQL 语法云原生数据库。 - connection_string 是一个 PostgreSQL 连接字符串。 - embedding_function 任何实现嵌入功能的函数

langchain.embeddings.base.Embeddings 接口。

• collection_name 是要使用的集合的名称。（默认值：langchain）

  • 注意：这不是表的名称，而是集合的名称。

    表将在初始化存储时创建（如果不存在） 因此，请确保用户具有创建表的正确权限。

• pre_delete_collection 如果为True，如果集合存在，将删除该集合。

  (默认值: False) - 对测试很有用。

初始化一个PGVecto_rs向量存储。

Parameters:

• embedding – 使用的嵌入。

• dimension – 嵌入的维度。

• db_url – 数据库URL。

• collection_name (str) – 集合的名称。

• new_table – 是否创建新表或连接到现有表。

• true (如果)

• exists (如果存在，表将被删除)

• 重新创建。 (然后)

• 错误。 (默认值为)

• connection_string (str)

• embedding_function (Embeddings)

• embedding_dimension (int)

• pre_delete_collection (bool)

• logger (可选[logging.Logger])

• engine_args (可选[字典])

属性

embeddings

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

方法

__init__(connection_string, embedding_function)	初始化一个PGVecto_rs向量存储。
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_texts(texts[, metadatas, ids, batch_size])	通过嵌入运行更多文本并将其添加到向量存储中。
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)	异步运行带距离的相似性搜索。
connection_string_from_db_params(driver, ...)	从数据库参数返回连接字符串。
create_collection()
create_table_if_not_exists()	表(
delete([ids])	通过向量ID删除。
delete_collection()
from_documents(documents, embedding[, ...])	返回从文档和嵌入初始化的VectorStore。
from_texts(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
get_by_ids(ids, /)	通过ID获取文档。
get_connection_string(kwargs)
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
search(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
similarity_search(query[, k, filter])	使用AnalyticDB进行带距离的相似性搜索。
similarity_search_by_vector(embedding[, k, ...])	返回与嵌入向量最相似的文档。
similarity_search_with_relevance_scores(query)	返回文档和相关度分数，范围在[0, 1]之间。
similarity_search_with_score(query[, k, filter])	返回与查询最相似的文档。
similarity_search_with_score_by_vector(embedding)

__init__(connection_string: str, embedding_function: Embeddings, embedding_dimension: int = 1536, collection_name: str = 'langchain_document', pre_delete_collection: bool = False, logger: Logger | None = None, engine_args: dict | None = None) → None

初始化一个PGVecto_rs向量存储。

Parameters:

• embedding – 使用的嵌入。

• dimension – 嵌入的维度。

• db_url – 数据库URL。

• collection_name (str) – 集合的名称。

• new_table – 是否创建新表或连接到现有表。

• true (如果)

• exists (如果存在，表将被删除)

• 重新创建。 (然后)

• 错误。 (默认值为)

• connection_string (str)

• embedding_function (Embeddings)

• embedding_dimension (int)

• pre_delete_collection (bool)

• logger (Logger | None)

• engine_args (dict | None)

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, batch_size: int = 500, **kwargs: Any) → List[str]

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

Parameters:

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

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

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

• ids (列表[字符串] | 无)

• batch_size (int)

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

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]

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

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

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]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → list[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, 浮点数]]

classmethod connection_string_from_db_params(driver: str, host: str, port: int, database: str, user: str, password: str) → str

从数据库参数返回连接字符串。

Parameters:

• driver (str)

• host (str)

• port (int)

• 数据库 (str)

• 用户 (字符串)

• password (str)

Return type:

字符串

create_collection() → None

Return type:

无

create_table_if_not_exists() → None

Table(

self.collection_name, Base.metadata, Column(“id”, TEXT, primary_key=True, default=uuid.uuid4), Column(“embedding”, Vector(self.embedding_dimension)), Column(“document”, String, nullable=True), Column(“metadata”, JSON, nullable=True), extend_existing=True,

)

Return type:

无

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

通过向量ID删除。

Parameters:

• ids (List[str] | None) – 要删除的ID列表。

• kwargs (Any)

Return type:

布尔值 | 无

delete_collection() → None

Return type:

无

classmethod from_documents(documents: List[Document], embedding: Embeddings, embedding_dimension: int = 1536, collection_name: str = 'langchain_document', ids: List[str] | None = None, pre_delete_collection: bool = False, engine_args: dict | None = None, **kwargs: Any) → Relyt

返回从文档和嵌入初始化的VectorStore。 需要Postgres连接字符串 可以将其作为参数传递 或者设置PG_CONNECTION_STRING环境变量。

Parameters:

• 文档 (列表[Document])

• embedding (Embeddings)

• embedding_dimension (int)

• collection_name (str)

• ids (列表[字符串] | 无)

• pre_delete_collection (bool)

• engine_args (dict | None)

• kwargs (Any)

Return type:

Relyt

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, embedding_dimension: int = 1536, collection_name: str = 'langchain_document', ids: List[str] | None = None, pre_delete_collection: bool = False, engine_args: dict | None = None, **kwargs: Any) → Relyt

返回从文本和嵌入初始化的VectorStore。 需要Postgres连接字符串 可以将其作为参数传递 或者设置PG_CONNECTION_STRING环境变量。

Parameters:

• 文本 (列表[字符串])

• embedding (Embeddings)

• metadatas (列表[字典] | 无)

• embedding_dimension (int)

• collection_name (str)

• ids (列表[字符串] | 无)

• pre_delete_collection (bool)

• engine_args (dict | None)

• kwargs (Any)

Return type:

Relyt

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

classmethod get_connection_string(kwargs: Dict[str, Any]) → str

Parameters:

kwargs (Dict[str, 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]

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

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

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]

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]

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

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

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]

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]

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

使用AnalyticDB进行带距离的相似性搜索。

Parameters:

• query (str) – 要搜索的查询文本。

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

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• kwargs (Any)

Returns:

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

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: dict | None = None, **kwargs: Any) → List[Document]

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

Parameters:

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

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

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

• 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, filter: dict | None = None) → List[Tuple[Document, float]]

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

Parameters:

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

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

• filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

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

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: dict | None = None) → List[Tuple[Document, float]]

Parameters:

• embedding (列表[浮点数])

• k (整数)

• filter (字典 | 无)

Return type:

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

使用 Relyt 的示例

• Relyt