`langchain_postgres.vectorstores`.PGVector¶

class langchain_postgres.vectorstores.PGVector(embeddings: Embeddings, *, connection: Union[None, Engine, str, AsyncEngine] = None, embedding_length: Optional[int] = None, collection_name: str = 'langchain', collection_metadata: Optional[dict] = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, logger: Optional[Logger] = None, relevance_score_fn: Optional[Callable[[float], float]] = None, engine_args: Optional[dict[str, Any]] = None, use_jsonb: bool = True, create_extension: bool = True, async_mode: bool = False)[source]¶

使用 Postgres 作为后端的 Vectorstore 实现。

目前，没有支持数据迁移的机制。

因此，vectorstore 模式中的重大更改将需要用户重新创建表并重新添加文档。

如果这是一个您关心的问题，请使用不同的 vectorstore。如果不是，则此实现应该适合您的用例。

要使用此 vectorstore，您需要安装 vector 扩展。vector 扩展是一个 Postgres 扩展，提供向量相似性搜索功能。

```sh docker run –name pgvector-container -e POSTGRES_PASSWORD=…

-d pgvector/pgvector:pg16

```

示例

from langchain_postgres.vectorstores import PGVector
from langchain_openai.embeddings import OpenAIEmbeddings

connection_string = "postgresql+psycopg://..."
collection_name = "state_of_the_union_test"
embeddings = OpenAIEmbeddings()
vectorstore = PGVector.from_documents(
    embedding=embeddings,
    documents=docs,
    connection=connection_string,
    collection_name=collection_name,
    use_jsonb=True,
    async_mode=False,
)

此代码已从 langchain_community 移植过来，并进行了最少的更改，以便用户可以轻松地从 langchain_community 过渡到 langchain_postgres。

进行了一些更改以解决社区实现中的问题：* langchain_postgres 现在可以与 psycopg3 一起使用。请更新您的

连接字符串从 postgresql+psycopg2://… 到 postgresql+psycopg://langchain:langchain@… （是的，驱动程序名称是 psycopg 而不是 psycopg3）

嵌入存储和集合的模式已更改，以使 add_documents 在使用用户指定的 ID 时（特别是在覆盖现有文档时）能够正确工作。如果您使用的是现有数据库，则需要重新创建表。
必须显式提供 Connection 对象。连接不会根据环境变量自动拾取。
langchain_postgres 现在接受异步连接。如果您想使用异步
版本，则需要在初始化存储时设置 async_mode=True 或使用异步引擎。

支持的过滤器运算符

$eq: 等于运算符
$ne: 不等于运算符
$lt: 小于运算符
$lte: 小于或等于运算符
$gt: 大于运算符
$gte: 大于或等于运算符
$in: In 运算符
$nin: Not in 运算符
$between: Between 运算符
$exists: Exists 运算符
$like: Like 运算符
$ilike: 不区分大小写的 Like 运算符
$and: 逻辑 AND 运算符
$or: 逻辑 OR 运算符
$not: 逻辑 NOT 运算符

示例

vectorstore.similarity_search('kitty', k=10, filter={
    'id': {'$in': [1, 5, 2, 9]}
})
#%% md

If you provide a dict with multiple fields, but no operators,
the top level will be interpreted as a logical **AND** filter

vectorstore.similarity_search('ducks', k=10, filter={
    'id': {'$in': [1, 5, 2, 9]},
    'location': {'$in': ["pond", "market"]}
})

初始化 PGVector 存储。对于异步版本，请改用 PGVector.acreate()。

参数

connection (Union[None, DBConnection, Engine, AsyncEngine, str]) – Postgres 连接字符串或（异步）引擎。
embeddings (Embeddings) – 任何实现 langchain.embeddings.base.Embeddings 接口的嵌入函数。
embedding_length (Optional[int]) – 嵌入向量的长度。（默认值：None）注意：这不是强制性的。定义它将阻止将任何其他大小的向量添加到嵌入表中，但是，如果没有它，则无法索引嵌入。
collection_name (str) – 要使用的集合的名称。（默认值：langchain）注意：这不是表的名称，而是集合的名称。表将在初始化存储时创建（如果不存在），因此，请确保用户具有创建表的正确权限。
distance_strategy (DistanceStrategy) – 要使用的距离策略。（默认值：COSINE）
pre_delete_collection (bool) – 如果为 True，将删除现有集合。（默认值：False）。用于测试很有用。
engine_args (Optional[dict[str, Any]]) – SQLAlchemy 的 create engine 参数。
use_jsonb (bool) – 使用 JSONB 而不是 JSON 作为元数据。（默认值：True）强烈建议不要使用 JSON，因为它在查询时效率不高。此处提供它是为了向后兼容旧版本，将来将被删除。
create_extension (bool) – 如果为 True，将创建向量扩展（如果不存在）。禁用创建在使用只读数据库时很有用。
collection_metadata (Optional[dict]) –
logger (Optional[logging.Logger]) –
relevance_score_fn (Optional[Callable[[float], float]]) –
async_mode (bool) –

属性

`distance_strategy`
`embeddings`	如果可用，请访问查询嵌入对象。

方法

`__init__`(embeddings, *[, connection, ...])	初始化 PGVector 存储。
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到 vectorstore。
`aadd_embeddings`(texts, embeddings[, ...])	异步将嵌入添加到 vectorstore。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过嵌入并添加到 vectorstore。
`acreate_collection`()
`acreate_tables_if_not_exists`()
`acreate_vector_extension`()
`add_documents`(documents, **kwargs)	在 vectorstore 中添加或更新文档。
`add_embeddings`(texts, embeddings[, ...])	将嵌入添加到 vectorstore。
`add_texts`(texts[, metadatas])	运行更多文本通过嵌入并添加到 vectorstore。
`adelete`([ids, collection_only])	通过 ID 或 UUID 异步删除向量。
`adelete_collection`()
`adrop_tables`()
`afrom_documents`(documents, embedding[, ...])	返回从文档和嵌入初始化的 VectorStore。
`afrom_embeddings`(text_embeddings, embedding)	从原始文档和预生成的嵌入构造 PGVector 包装器。
`afrom_existing_index`(embedding, *[, ...])	获取现有 PGVector 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入
`afrom_texts`(texts, embedding[, metadatas, ...])	返回从文档和嵌入初始化的 VectorStore。
`aget_by_ids`(ids, /)	按 ID 获取文档。
`aget_collection`(session)
`amax_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档
`amax_marginal_relevance_search_with_score`(query)	返回使用最大边际相关性及评分选择的文档。
`amax_marginal_relevance_search_with_score_by_vector`(...)	返回使用最大边际相关性及评分选择的文档
`as_retriever`(**kwargs)	返回从此 VectorStore 初始化的 VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	异步返回与使用指定搜索类型查询最相似的文档。
`asimilarity_search`(query[, k, filter])	使用 PGVector 和距离运行相似性搜索。
`asimilarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步返回范围在 [0, 1] 内的文档和相关性评分。
`asimilarity_search_with_score`(query[, k, filter])	返回与查询最相似的文档。
`asimilarity_search_with_score_by_vector`(...)
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)	将文档 Upsert 到 vectorstore 中。
`connection_string_from_db_params`(driver, ...)	从数据库参数返回连接字符串。
`create_collection`()
`create_tables_if_not_exists`()
`create_vector_extension`()
`delete`([ids, collection_only])	通过 ID 或 UUID 删除向量。
`delete_collection`()
`drop_tables`()
`from_documents`(documents, embedding, *[, ...])	返回从文档和嵌入初始化的 VectorStore。
`from_embeddings`(text_embeddings, embedding, *)	从原始文档和嵌入构造 PGVector 包装器。
`from_existing_index`(embedding, *[, ...])	获取现有 PGVector 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入
`from_texts`(texts, embedding[, metadatas, ...])	返回从文档和嵌入初始化的 VectorStore。
`get_by_ids`(ids, /)	按 ID 获取文档。
`get_collection`(session)
`get_connection_string`(kwargs)
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档
`max_marginal_relevance_search_with_score`(query)	返回使用最大边际相关性及评分选择的文档。
`max_marginal_relevance_search_with_score_by_vector`(...)	返回使用最大边际相关性及评分选择的文档
`search`(query, search_type, **kwargs)	返回与使用指定搜索类型查询最相似的文档。
`similarity_search`(query[, k, filter])	使用 PGVector 和距离运行相似性搜索。
`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)
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)	将文档 Upsert 到 vectorstore 中。

__init__(embeddings: Embeddings, *, connection: Union[None, Engine, str, AsyncEngine] = None, embedding_length: Optional[int] = None, collection_name: str = 'langchain', collection_metadata: Optional[dict] = None, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, logger: Optional[Logger] = None, relevance_score_fn: Optional[Callable[[float], float]] = None, engine_args: Optional[dict[str, Any]] = None, use_jsonb: bool = True, create_extension: bool = True, async_mode: bool = False) → None[source]¶

初始化 PGVector 存储。对于异步版本，请改用 PGVector.acreate()。

参数

connection (Union[None, Engine, str, AsyncEngine]) – Postgres 连接字符串或（异步）引擎。
embeddings (Embeddings) – 任何实现 langchain.embeddings.base.Embeddings 接口的嵌入函数。
embedding_length (Optional[int]) – 嵌入向量的长度。（默认值：None）注意：这不是强制性的。定义它将阻止将任何其他大小的向量添加到嵌入表中，但是，如果没有它，则无法索引嵌入。
collection_name (str) – 要使用的集合的名称。（默认值：langchain）注意：这不是表的名称，而是集合的名称。表将在初始化存储时创建（如果不存在），因此，请确保用户具有创建表的正确权限。
distance_strategy (DistanceStrategy) – 要使用的距离策略。（默认值：COSINE）
pre_delete_collection (bool) – 如果为 True，将删除现有集合。（默认值：False）。用于测试很有用。
engine_args (Optional[dict[str, Any]]) – SQLAlchemy 的 create engine 参数。
use_jsonb (bool) – 使用 JSONB 而不是 JSON 作为元数据。（默认值：True）强烈建议不要使用 JSON，因为它在查询时效率不高。此处提供它是为了向后兼容旧版本，将来将被删除。
create_extension (bool) – 如果为 True，将创建向量扩展（如果不存在）。禁用创建在使用只读数据库时很有用。
collection_metadata (Optional[dict]) –
logger (Optional[Logger]) –
relevance_score_fn (Optional[Callable[[float], float]]) –
async_mode (bool) –

返回类型

None

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

异步运行更多文档通过嵌入并添加到 vectorstore。

参数

documents (List[Document]) – 要添加到 vectorstore 的文档。
kwargs (Any) – 附加的关键字参数。

返回值

添加的文本的 ID 列表。

引发

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

返回类型

List[str]

async aadd_embeddings(texts: Sequence[str], embeddings: List[List[float]], metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, **kwargs: Any) → List[str][source]¶

异步将嵌入添加到 vectorstore。

参数

texts (Sequence[str]) – 要添加到向量存储中的字符串的可迭代序列。
embeddings (List[List[float]]) – 嵌入向量的列表的列表。
metadatas (Optional[List[dict]]) – 与文本关联的元数据列表。
ids (Optional[List[str]]) – 文本的可选 ID 列表。如果未提供，将为每个文本生成新的 ID。
kwargs (Any) – 向量存储特定的参数

返回类型

List[str]

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

异步运行更多文本通过嵌入并添加到 vectorstore。

参数

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代序列。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回值

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

引发

ValueError – 如果元数据的数量与文本的数量不匹配，则抛出此异常。
ValueError – 如果 ID 的数量与文本的数量不匹配，则抛出此异常。

返回类型

List[str]

async acreate_collection() → None[source]¶

返回类型: None

async acreate_tables_if_not_exists() → None[source]¶

返回类型: None

async acreate_vector_extension() → None[source]¶

返回类型: None

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

在 vectorstore 中添加或更新文档。

参数

documents (List[Document]) – 要添加到 vectorstore 的文档。
kwargs (Any) – 额外的关键字参数。如果 kwargs 包含 ids 并且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回值

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 的数量与文档的数量不匹配，则抛出此异常。

返回类型

List[str]

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

将嵌入添加到 vectorstore。

参数

texts (Sequence[str]) – 要添加到向量存储中的字符串的可迭代序列。
embeddings (List[List[float]]) – 嵌入向量的列表的列表。
metadatas (Optional[List[dict]]) – 与文本关联的元数据列表。
ids (Optional[List[str]]) – 文档的可选 ID 列表。如果未提供，将为每个文档生成新的 ID。
kwargs (Any) – 向量存储特定的参数

返回类型

List[str]

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

运行更多文本通过嵌入并添加到 vectorstore。

参数

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代序列。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
**kwargs (Any) – 向量存储特定的参数。kwargs 之一应该是 ids，它是与文本关联的 id 列表。

返回值

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

引发

ValueError – 如果元数据的数量与文本的数量不匹配，则抛出此异常。
ValueError – 如果 ID 的数量与文本的数量不匹配，则抛出此异常。

返回类型

List[str]

async adelete(ids: Optional[List[str]] = None, collection_only: bool = False, **kwargs: Any) → None[source]¶

通过 ID 或 UUID 异步删除向量。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。
collection_only (bool) – 仅删除集合中的 ID。
kwargs (Any) –

返回类型

None

async adelete_collection() → None[source]¶

返回类型: None

async adrop_tables() → None[source]¶

返回类型: None

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, *, use_jsonb: bool = True, **kwargs: Any) → PGVector[source]¶

从文档和嵌入初始化 VectorStore。需要 Postgres 连接字符串“可以将其作为参数传递，也可以设置 PGVECTOR_CONNECTION_STRING 环境变量。

参数

documents (List[Document]) –
embedding (Embeddings) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
use_jsonb (bool) –
kwargs (Any) –

返回类型

PGVector

async classmethod afrom_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: Optional[List[dict]] = None, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, **kwargs: Any) → PGVector[source]¶

从原始文档和预生成的嵌入构造 PGVector 包装器。

从文档和嵌入初始化 VectorStore。需要 Postgres 连接字符串“可以将其作为参数传递，也可以设置 PGVECTOR_CONNECTION_STRING 环境变量。

示例

from langchain_community.vectorstores import PGVector
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
faiss = PGVector.from_embeddings(text_embedding_pairs, embeddings)

参数

text_embeddings (List[Tuple[str, List[float]]]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
kwargs (Any) –

返回类型

PGVector

async classmethod afrom_existing_index(embedding: Embeddings, *, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, connection: Optional[Union[Engine, str]] = None, **kwargs: Any) → PGVector[source]¶

获取现有 PGVector 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入

参数

embedding (Embeddings) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
pre_delete_collection (bool) –
connection (Optional[Union[Engine, str]]) –
kwargs (Any) –

返回类型

PGVector

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, *, use_jsonb: bool = True, **kwargs: Any) → PGVector[source]¶

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

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
use_jsonb (bool) –
kwargs (Any) –

返回类型

PGVector

async aget_by_ids(ids: Sequence[str], /) → List[Document][source]¶

按 ID 获取文档。

参数: ids (Sequence[str]) –
返回类型: List[Document]

async aget_collection(session: AsyncSession) → Any[source]¶

参数: session (AsyncSession) –
返回类型: Any

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
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, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

返回使用最大边际相关性选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

embedding (str) – 查找与文本相似的文档。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

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

返回类型

List[Document]

async amax_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

根据最大边际相关性选择的文档列表: 以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

async amax_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回使用最大边际相关性及评分选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

根据最大边际相关性选择的文档列表: 以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。可以是 “similarity” (默认), “mmr”, 或 “similarity_score_threshold”。

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): 传递给

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

k: 要返回的文档数量 (默认: 4) score_threshold: 相似度分数阈值的最小相关性阈值

for similarity_score_threshold

fetch_k: 传递给 MMR 算法的文档数量: (默认: 20)
lambda_mult: MMR 返回结果的多样性；: 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) – 传递给搜索方法的参数。

返回值

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

引发

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

返回类型

List[Document]

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

使用 PGVector 和距离运行相似性搜索。

参数

query (str) – 要搜索的查询文本。
k (int) – 要返回的结果数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

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

返回类型

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
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 之间的浮点值，用于

过滤检索到的文档结果集

返回值

由 (doc, similarity_score) 元组组成的列表

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score(query: str, k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。

返回值

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

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

参数

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式 Upsert 文档。 streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量数据库的文档迭代器。
batch_size (int) – 每次 upsert 的批次大小。
kwargs (Any) – 额外的关键字参数。kwargs 应该只包含所有文档共有的参数。（例如，索引超时时间、重试策略等）kwargs 不应包含 ids，以避免语义模糊。ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加或更新到向量数据库的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse[source]¶

将文档 Upsert 到 vectorstore 中。

参数

items (Sequence[Document]) – 要 upsert 的文档序列。
kwargs (Any) – 向量存储特定的参数

返回值

UpsertResponse

返回类型

UpsertResponse

classmethod connection_string_from_db_params(driver: str, host: str, port: int, database: str, user: str, password: str) → str[source]¶

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

参数

driver (str) –
host (str) –
port (int) –
database (str) –
user (str) –
password (str) –

返回类型

str

create_collection() → None[source]¶

返回类型: None

create_tables_if_not_exists() → None[source]¶

返回类型: None

create_vector_extension() → None[source]¶

返回类型: None

delete(ids: Optional[List[str]] = None, collection_only: bool = False, **kwargs: Any) → None[source]¶

通过 ID 或 UUID 删除向量。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。
collection_only (bool) – 仅删除集合中的 ID。
kwargs (Any) –

返回类型

None

delete_collection() → None[source]¶

返回类型: None

drop_tables() → None[source]¶

返回类型: None

classmethod from_documents(documents: List[Document], embedding: Embeddings, *, connection: Optional[Union[Engine, str]] = None, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, use_jsonb: bool = True, **kwargs: Any) → PGVector[source]¶

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

参数

documents (List[Document]) –
embedding (Embeddings) –
connection (Optional[Union[Engine, str]]) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
use_jsonb (bool) –
kwargs (Any) –

返回类型

PGVector

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, *, metadatas: Optional[List[dict]] = None, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, **kwargs: Any) → PGVector[source]¶

从原始文档和嵌入构造 PGVector 包装器。

参数

text_embeddings (List[Tuple[str, List[float]]]) – 文本和嵌入的元组列表。
embedding (Embeddings) – 嵌入对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
collection_name (str) – 集合的名称。
distance_strategy (DistanceStrategy) – 使用的距离策略。
ids (Optional[List[str]]) – 文档的可选 ID 列表。如果未提供，将为每个文档生成新的 ID。
pre_delete_collection (bool) – 如果为 True，则将删除现有集合（如果存在）。注意：这将删除现有集合中的所有文档。
kwargs (Any) – 附加参数。

返回值

PGVector 实例。

返回类型

PGVector

示例

from langchain_postgres.vectorstores import PGVector
from langchain_openai.embeddings import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
vectorstore = PGVector.from_embeddings(text_embedding_pairs, embeddings)

classmethod from_existing_index(embedding: Embeddings, *, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, connection: Optional[Union[Engine, str]] = None, **kwargs: Any) → PGVector[source]¶

获取现有 PGVector 存储的实例。此方法将返回存储的实例，而无需插入任何新的嵌入

参数

embedding (Embeddings) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
pre_delete_collection (bool) –
connection (Optional[Union[Engine, str]]) –
kwargs (Any) –

返回类型

PGVector

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, *, collection_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, use_jsonb: bool = True, **kwargs: Any) → PGVector[source]¶

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

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
use_jsonb (bool) –
kwargs (Any) –

返回类型

PGVector

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

按 ID 获取文档。

参数: ids (Sequence[str]) –
返回类型: List[Document]

get_collection(session: Session) → Any[source]¶

参数: session (Session) –
返回类型: Any

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

参数: kwargs (Dict[str, Any]) –
返回类型: str

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
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, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

返回使用最大边际相关性选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

embedding (str) – 查找与文本相似的文档。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

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

返回类型

List[Document]

max_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

根据最大边际相关性选择的文档列表: 以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回使用最大边际相关性及评分选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和多样性: 在选定的文档中。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取以传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

根据最大边际相关性选择的文档列表: 以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

返回与使用指定搜索类型查询最相似的文档。

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”, “mmr”, 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

引发

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]¶

使用 PGVector 和距离运行相似性搜索。

参数

query (str) – 要搜索的查询文本。
k (int) – 要返回的结果数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
kwargs (Any) –

返回值

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

返回类型

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。
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 = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据筛选。默认为 None。

返回值

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

返回类型

List[Tuple[Document, float]]

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

参数

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –

返回类型

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次 upsert 的批次大小。
kwargs (Any) – 附加的关键词参数。kwargs 应该只包含所有文档通用的参数。（例如，索引超时时间、重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加或更新到向量数据库的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse[source]¶

将文档 Upsert 到 vectorstore 中。

参数

items (Sequence[Document]) – 要 upsert 的文档序列。
kwargs (Any) – 向量存储特定的参数

返回值

UpsertResponse

返回类型

UpsertResponse

langchain_postgres.vectorstores.PGVector¶

PGVector 示例¶

`langchain_postgres.vectorstores`.PGVector¶