hollowdb vector Download - hollowdb vector Source Code Download

hollowdb vector

شفرة المصدر الأخرى

v0.1.4

تنزيل

HollowDB ناقلات

تنفيذ مؤشر عوالم صغيرة الصالحة للملاحة (HNSW) على HollowDB.

تثبيت

تثبيت الحزمة:

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 ) ;

ملحوظة

قد يزداد تعقيد إدخال نقطة مع المزيد من النقاط في DB.

جلب ناقل

يمكنك الحصول على ناقل من خلال الفهرس ، والذي يعيد قيمة نقطة وبيانات الوصفية:

 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 $ المعلمات التي يتم تحضيرها في بيثون ، ويتم مقارنتها في TypeScript. قم بإجراء الاختبارات عبر: