跳转到内容

AstraDBVectorStore

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:26

  • BaseVectorStore

new AstraDBVectorStore(init?): AstraDBVectorStore

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:37

Partial<AstraDBVectorStore> & object & VectorStoreBaseParams

AstraDBVectorStore

BaseVectorStore.constructor

storesText: boolean = true

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:27

BaseVectorStore.storesText


flatMetadata: boolean = true

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:28


idKey: string

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:30


内容键: string

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:31

createAndConnect(collection, options?): Promise<void>

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:79

在您的Astra DB向量数据库中创建一个新集合并连接到它。 在添加、删除或查询之前,您必须调用此方法或connect

string

您的新集合名称

CreateCollectionOptions<SomeDoc>

CreateCollectionOptions 用于设置向量维度和相似度度量指标

Promise<void>

如果创建过程未抛出错误,则承诺将得到解决。


connect(collection): Promise<void>

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:96

连接到您 Astra DB 向量数据库中的现有集合。 在添加、删除或查询之前,您必须调用此方法或 createAndConnect

string

您现有集合的名称

Promise<void>

如果连接未抛出错误,则承诺将得到解决。


client(): DataAPIClient

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:107

获取您的 Astra DB 客户端实例。

DataAPIClient

AstraDB 客户端

BaseVectorStore.client


add(nodes): Promise<string[]>

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:116

将您的文档添加到您的 Astra DB 集合中。

BaseNode<Metadata>[]

Promise<string[]>

一个被添加的节点ID数组

BaseVectorStore.add


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

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:156

从您的 Astra DB 集合中删除一个文档。

string

要删除的文档ID

DeleteOneOptions

传递给删除查询的DeleteOneOptions

Promise<void>

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

BaseVectorStore.delete


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

定义于:.build/typescript/packages/providers/storage/astra/src/AstraDBVectorStore.ts:181

从您的 Astra DB 集合中查询文档,以获取与您的嵌入向量最接近的匹配项。

VectorStoreQuery

VectorStoreQuery

FindOptions

FindOptions

Promise<VectorStoreQueryResult>

BaseVectorStore.query