@memberjunction/ai-vectordb 0.9.3

package/dist/generic/VectorDBBase.d.ts

@@ -0,0 +1,21 @@
+import { BaseRequestParams, BaseResponse, CreateIndexParams, EditIndexParams, IndexList, UpdateOptions, VectorRecord } from "./record";
+import { QueryOptions } from './query.types';
+export declare abstract class VectorDBBase {
+    private _apiKey;
+    protected get apiKey(): string;
+    constructor(apiKey: string);
+    abstract listIndexes(): IndexList | Promise<IndexList>;
+    abstract getIndex(params: BaseRequestParams): BaseResponse | Promise<BaseResponse>;
+    abstract createIndex(params: CreateIndexParams): BaseResponse | Promise<BaseResponse>;
+    abstract deleteIndex(params: BaseRequestParams): BaseResponse | Promise<BaseResponse>;
+    abstract editIndex(params: EditIndexParams): BaseResponse | Promise<BaseResponse>;
+    abstract queryIndex(params: QueryOptions): BaseResponse | Promise<BaseResponse>;
+    abstract createRecord(record: VectorRecord): BaseResponse | Promise<BaseResponse>;
+    abstract createRecords(record: VectorRecord[]): BaseResponse | Promise<BaseResponse>;
+    abstract getRecord(param: BaseRequestParams): BaseResponse | Promise<BaseResponse>;
+    abstract getRecords(params: BaseRequestParams): BaseResponse | Promise<BaseResponse>;
+    abstract updateRecord(record: UpdateOptions): BaseResponse | Promise<BaseResponse>;
+    abstract updateRecords(records: UpdateOptions): BaseResponse | Promise<BaseResponse>;
+    abstract deleteRecord(record: VectorRecord): BaseResponse | Promise<BaseResponse>;
+    abstract deleteRecords(records: VectorRecord[]): BaseResponse | Promise<BaseResponse>;
+}

package/dist/generic/VectorDBBase.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorDBBase = void 0;
+class VectorDBBase {
+    get apiKey() {
+        return this._apiKey;
+    }
+    constructor(apiKey) {
+        if (!apiKey || apiKey.trim().length === 0)
+            throw new Error('API key cannot be empty');
+        this._apiKey = apiKey;
+    }
+}
+exports.VectorDBBase = VectorDBBase;
+//# sourceMappingURL=VectorDBBase.js.map

package/dist/generic/VectorDBBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VectorDBBase.js","sourceRoot":"","sources":["../../src/generic/VectorDBBase.ts"],"names":[],"mappings":";;;AAGA,MAAsB,YAAY;IAK9B,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,YAAa,MAAc;QACvB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAE/C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;CAkBJ;AAhCD,oCAgCC"}

package/dist/generic/query.types.d.ts

@@ -0,0 +1,25 @@
+import { RecordMetadata, RecordValues, VectorRecord } from './record';
+export type QueryParamsBase = {
+    topK: number;
+    includeValues?: boolean;
+    includeMetadata?: boolean;
+    filter?: object;
+};
+export type QueryByRecordId = QueryParamsBase & {
+    id: string;
+};
+export type QueryByVectorValues = QueryParamsBase & {
+    vector: RecordValues;
+};
+export type QueryOptions = QueryByRecordId | QueryByVectorValues;
+export interface ScoredRecord<T extends RecordMetadata = RecordMetadata> extends VectorRecord<T> {
+    score?: number;
+}
+export type QueryResponse<T extends RecordMetadata = RecordMetadata> = {
+    matches: Array<ScoredRecord<T>>;
+    namespace: string;
+    usage?: OperationUsage;
+};
+export type OperationUsage = {
+    readUnits?: number;
+};

package/dist/generic/query.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=query.types.js.map

package/dist/generic/query.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.types.js","sourceRoot":"","sources":["../../src/generic/query.types.ts"],"names":[],"mappings":""}

package/dist/generic/record.d.ts

@@ -0,0 +1,49 @@
+export type IndexDescription = {
+    name: string;
+    dimension: number;
+    metric: IndexModelMetricEnum;
+    host: string;
+};
+export declare const IndexModelMetricEnum: {
+    readonly Cosine: "cosine";
+    readonly Euclidean: "euclidean";
+    readonly Dotproduct: "dotproduct";
+};
+export type IndexModelMetricEnum = typeof IndexModelMetricEnum[keyof typeof IndexModelMetricEnum];
+export interface IndexList {
+    indexes?: Array<IndexDescription>;
+}
+export type RecordValues = Array<number>;
+export type RecordSparseValues = {
+    indices: Array<number>;
+    values: Array<number>;
+};
+export type RecordMetadataValue = string | boolean | number | Array<string>;
+export type RecordMetadata = Record<string, RecordMetadataValue>;
+export type VectorRecord<T extends RecordMetadata = RecordMetadata> = {
+    id: string;
+    values: RecordValues;
+    sparseValues?: RecordSparseValues;
+    metadata?: T;
+};
+export type BaseRequestParams = {
+    id: string;
+    data?: any;
+};
+export type CreateIndexParams = BaseRequestParams & {
+    dimension: number;
+    metric: IndexModelMetricEnum;
+    additionalParams?: any;
+};
+export type EditIndexParams = BaseRequestParams & {};
+export type UpdateOptions<T extends RecordMetadata = RecordMetadata> = {
+    id: string;
+    values?: RecordValues;
+    sparseValues?: RecordSparseValues;
+    metadata?: T;
+};
+export type BaseResponse = {
+    success: boolean;
+    message: string;
+    data: any;
+};

package/dist/generic/record.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=record.js.map

package/dist/generic/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../src/generic/record.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './generic/record';
+export * from './generic/VectorDBBase';
+export * from './generic/query.types';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generic/record"), exports);
+__exportStar(require("./generic/VectorDBBase"), exports);
+__exportStar(require("./generic/query.types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,yDAAuC;AACvC,wDAAsC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@memberjunction/ai-vectordb",
+  "version": "0.9.3",
+  "description": "MemberJunction: AI Vector Database Module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "dependencies": {
+    "@langchain/mistralai": "^0.0.7",
+    "@memberjunction/core": "^0.9.171",
+    "@memberjunction/global": "^0.9.152",
+    "dotenv": "^16.0.3",
+    "openai": "^3.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.1.7",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.3.3"
+  }
+}