hollowdb vector

HollowDB矢量

在HollowdB上实施层次可导航的小世界（HNSW）索引。

安装

安装软件包：

yarn add hollowdb-vector
pnpm add hollowdb-vector
npm install hollowdb-vector

用法

您可以如下创建VectordB：

 import HollowDBVector from "hollowdb-vector" ;
import { WarpFactory , defaultCacheOptions } from "warp-contracts" ;
import { SetSDK } from "hollowdb" ;
import { Redis } from "ioredis" ;
import { RedisCache } from "warp-contracts-redis" ;

// connect to Redis
const redis = new Redis ( ) ;

// create Warp instance with Redis cache
const warp = WarpFactory . forMainnet ( ) . useKVStorageFactory (
  ( contractTxId : string ) =>
    new RedisCache ( { ... defaultCacheOptions , dbLocation : ` ${ contractTxId } ` } , { client : redis } ) ,
) ;

// create HollowDB SDK
const wallet = JSON . parse ( readFileSync ( "./path/to/wallet.json" , "utf-8" ) ) ;
const contractTxId = "your-contract-tx-id" ;
const hollowdb = new SetSDK < string > ( wallet , contractTxId , warp ) ;

// create HollowDB Vector
const vectordb = new HollowDBVector ( hollowdb ) ;

插入向量

这样，您可以插入一个新观点：

 const point = [ - 0.28571999073028564 /* and many more... */ , 0.13964000344276428 ] ;

// any object
const metadata = {
  name : "My favorite vector!" ,
} ;

// insert a point
await vectordb . insert ( point , metadata ) ;

元数据是可选的，您可以在insert过程中遗漏。如果您想将其设置为以后的时间，您可以随时这样做：

 vectordb . db . set_metadata ( index , metadata ) ; 

笔记

插入一点点的复杂性可能会随着数据库的更多点而增加。

获取向量

您可以通过其索引获得一个向量，该索引返回其点值并元数据：

 const { point , metadata } = await vectordb . get_vector ( index ) ;

查询向量

您可以进行查询并返回顶级K相关结果：

 // a query point
const query = [ - 0.28571999073028564 /* and many more... */ , 0.13964000344276428 ] ;

// number of top results to return
const K = 10 ;

// make a KNN search
const results = await vectordb . knn_search ( query , K ) ;

// each result contains the vector id, its distance to query, and metadata
const { id , distance , metadata } = results [ 0 ] ;

部署自己的合同

HollowDB Vector导出一个静态功能，使您可以部署自己拥有的新合同。假设您有上述wallet和一个warp实例，则可以使用以下方式创建新合同：

 const { contractTxId } = await HollowDBVector . deploy ( wallet , warp ) ;
console . log ( "Deployed at:" , contractTxId ) ; 

设置

对于本仓库的本地设置，首先克隆它。

git clone https://github.com/firstbatchxyz/hollowdb-vector

然后，安装软件包：

pnpm install

应自动安装同伴依赖项。

原子

我们将预先编译的Protobuf包括在存储库中，但是如果您以后更改Protobuf，则可以按以下方式生成编译的代码：

 # HNSW protobufs
pnpm proto:code:hnsw # generate js code
pnpm proto:type:hnsw # generate types

# Request protobufs
pnpm proto:code:req # generate js code
pnpm proto:type:req # generate types 

测试

在几种情况下进行了测试 $ n，k $在Python中制备的参数，并在打字稿中进行比较。通过：

pnpm test 

警告

您需要一台实时Redis服务器才能进行HollowDB测试。此外，HollowDB测试可能需要一些时间。

造型

检查格式：

pnpm format

用棉布与：

pnpm lint

您还可以检查类型：

pnpm check

遗产

HollowDB Vector取代Danny，有关旧版代码，请参考此分支。

执照

HollowDB Vector在Apache 2.0下获得许可。