跳转到内容

PGVectorStore

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:155

提供对在Postgres中写入和查询向量数据的支持。 注意:无法与使用Python版本的向量存储创建的数据一起使用(https://docs.llamaindex.ai/en/stable/examples/vector_stores/postgres/

  • BaseVectorStore

new PGVectorStore(config): PGVectorStore

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:168

PGVectorStoreConfig

PGVectorStore

BaseVectorStore.constructor

storesText: boolean = true

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:156

BaseVectorStore.storesText

setCollection(coll): void

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:203

集合属性的设置器。 使用集合可以实现向量数据的简单隔离, 例如按用户、来源或访问级别进行隔离。 在查询时留空或设置为空以忽略集合值。

string

集合的名称。

void


getCollection(): string

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:214

集合属性的获取器。 使用集合可以实现向量数据的简单隔离, 例如按用户、来源或访问级别进行隔离。 在查询时留空/设置为空以忽略集合值。

string

当前设置的集合值。默认为空字符串。


client(): Promise<IsomorphicDB>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:286

连接到环境变量中指定的数据库。 此方法还会检查并创建向量扩展、 目标表以及索引(如果未找到)。

Promise<IsomorphicDB>

与数据库的连接,或在连接/设置过程中遇到的错误。

BaseVectorStore.client


clearCollection(): Promise<any[]>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:295

删除指定集合的所有向量记录。 注意:使用由 setCollection/getCollection 控制的集合属性。

Promise<any[]>

删除查询的结果。


add(embeddingResults): Promise<string[]>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:331

向表中添加向量记录。 注意:使用由 setCollection/getCollection 控制的集合属性。

BaseNode<Metadata>[]

要插入的节点,可选择性地包含元组元数据。

Promise<string[]>

所创建记录的零个或多个ID值列表。

BaseVectorStore.add


delete(refDocId, deleteKwargs?): Promise<void>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:380

根据ID从数据库中删除单条记录。 注意:使用由setCollection/getCollection控制的集合属性。

string

要删除记录的唯一标识符。

object

VectorStore 接口所需。当前被忽略。

Promise<void>

如果删除查询未抛出错误,则承诺将得到解决。

BaseVectorStore.delete


query(query, options?): Promise<VectorStoreQueryResult>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:515

在向量存储中查询与查询嵌入最匹配的数据

VectorStoreQuery

要使用的 VectorStoreQuery

object

VectorStore 接口所需。当前被忽略。

Promise<VectorStoreQueryResult>

零个或多个来自向量存储数据的文档实例。

BaseVectorStore.query


persist(persistPath): Promise<void>

定义于:.build/typescript/packages/providers/storage/postgres/src/PGVectorStore.ts:590

VectorStore接口要求。当前被忽略。

string

Promise<void>

已解决的 Promise。