跳转到内容

MongoDBAtlasVectorSearch

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:71

使用MongoDB Atlas进行存储和向量搜索的向量存储库。 该存储库使用$vectorSearch聚合阶段来执行向量相似性搜索。

  • BaseVectorStore

new MongoDBAtlasVectorSearch(init): MongoDBAtlasVectorSearch

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:140

Partial<MongoDBAtlasVectorSearch> & object & VectorStoreBaseParams

MongoDBAtlasVectorSearch

BaseVectorStore.constructor

storesText: boolean = true

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:72

BaseVectorStore.storesText


flatMetadata: boolean = true

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:73


数据库名称: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:75


collectionName: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:76


autoCreateIndex: boolean

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:77


嵌入定义: Record<string, unknown>

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:78


索引元数据字段: string[]

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:79


mongodbClient: MongoClient

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:84

所使用的 MongoClient。如果未提供,将基于 MONGODB_URI 环境变量创建一个新的 MongoClient。


索引名称: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:91

向量索引的名称。如果无效,Mongo将静默忽略此问题并返回0个结果。

默认值:“default”


embeddingKey: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:98

包含嵌入向量的键名。

默认值:“embedding”


idKey: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:105

包含节点ID的键名。

默认值:“id”


textKey: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:112

包含节点文本的键名。

默认值:“text”


metadataKey: string

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:119

包含节点元数据的键名。

默认值:“metadata”


optional insertOptions: BulkWriteOptions

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:124

向插入多个节点函数传递的选项。


候选数量: (query) => number

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:137

用于确定针对给定查询需要检索的候选数量的函数。 如果结果不理想,可以调整此值。

运行向量搜索查询

使用分层可导航小世界图实现高效且稳健的近似最近邻搜索

默认值:query.similarityTopK * 10

VectorStoreQuery

number

ensureCollection(): Promise<Collection<Document>>

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:181

Promise<Collection<Document>>


add(nodes): Promise<string[]>

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:224

向向量存储中添加节点。

BaseNode<Metadata>[]

要添加到向量存储的节点

Promise<string[]>

已添加的节点ID列表

BaseVectorStore.add


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

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:265

从向量存储中删除具有指定 redDocId 的节点。

string

要删除节点的引用文档标识符

object

传递给 deleteOne 函数的选项

Promise<void>

BaseVectorStore.delete


client(): MongoClient

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:275

MongoClient

BaseVectorStore.client


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

定义于:.build/typescript/packages/providers/storage/mongodb/src/MongoDBAtlasVectorStore.ts:285

执行向量相似性搜索查询。

VectorStoreQuery

要运行的查询

object

Promise<VectorStoreQueryResult>

节点列表及其相似度

BaseVectorStore.query