@becomposable/common - npm Package Compare versions

Comparing version 0.37.0 to 0.38.0

lib/cjs/index.js

@@ -24,2 +24,3 @@ "use strict";
 __exportStar(require("./interaction.js"), exports);
+__exportStar(require("./memory.js"), exports);
 __exportStar(require("./payload.js"), exports);
@@ -26,0 +27,0 @@ __exportStar(require("./project.js"), exports);

lib/cjs/interaction.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecutionRunRefSelect = exports.RunSourceTypes = exports.MEMORY_INPUT_PREFIX = exports.ExecutionRunStatus = exports.InteractionStatus = exports.InteractionRefPopulate = void 0;
+exports.ExecutionRunRefSelect = exports.RunSourceTypes = exports.ExecutionRunStatus = exports.InteractionStatus = exports.InteractionRefPopulate = void 0;
 exports.InteractionRefPopulate = "id name description status version latest tags updated_at prompts";
@@ -18,3 +18,2 @@ var InteractionStatus;
 })(ExecutionRunStatus || (exports.ExecutionRunStatus = ExecutionRunStatus = {}));
-exports.MEMORY_INPUT_PREFIX = "memory:";
 var RunSourceTypes;
@@ -21,0 +20,0 @@ (function (RunSourceTypes) {

lib/cjs/project.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectRefPopulate = exports.ResourceVisibility = exports.ProjectRoles = void 0;
+exports.ProjectRefPopulate = exports.SupportedEmbeddingTypes = exports.ResourceVisibility = exports.ProjectRoles = void 0;
 exports.isRoleIncludedIn = isRoleIncludedIn;
@@ -37,3 +37,15 @@ var ProjectRoles;
 })(ResourceVisibility || (exports.ResourceVisibility = ResourceVisibility = {}));
+// export interface ProjectConfigurationEmbeddings {
+//     environment: string;
+//     max_tokens: number;
+//     dimensions: number;
+//     model?: string;
+// }
+var SupportedEmbeddingTypes;
+(function (SupportedEmbeddingTypes) {
+    SupportedEmbeddingTypes["text"] = "text";
+    SupportedEmbeddingTypes["image"] = "image";
+    SupportedEmbeddingTypes["properties"] = "properties";
+})(SupportedEmbeddingTypes || (exports.SupportedEmbeddingTypes = SupportedEmbeddingTypes = {}));
 exports.ProjectRefPopulate = "id name account";
 //# sourceMappingURL=project.js.map

lib/esm/index.js

@@ -8,2 +8,3 @@ export * from './access-control.js';
 export * from './interaction.js';
+export * from "./memory.js";
 export * from './payload.js';
@@ -10,0 +11,0 @@ export * from './project.js';

lib/esm/interaction.js

@@ -15,3 +15,2 @@ export const InteractionRefPopulate = "id name description status version latest tags updated_at prompts";
 })(ExecutionRunStatus || (ExecutionRunStatus = {}));
-export const MEMORY_INPUT_PREFIX = "memory:";
 export var RunSourceTypes;
@@ -18,0 +17,0 @@ (function (RunSourceTypes) {

lib/esm/project.js

@@ -33,3 +33,15 @@ export var ProjectRoles;
 })(ResourceVisibility || (ResourceVisibility = {}));
+// export interface ProjectConfigurationEmbeddings {
+//     environment: string;
+//     max_tokens: number;
+//     dimensions: number;
+//     model?: string;
+// }
+export var SupportedEmbeddingTypes;
+(function (SupportedEmbeddingTypes) {
+    SupportedEmbeddingTypes["text"] = "text";
+    SupportedEmbeddingTypes["image"] = "image";
+    SupportedEmbeddingTypes["properties"] = "properties";
+})(SupportedEmbeddingTypes || (SupportedEmbeddingTypes = {}));
 export const ProjectRefPopulate = "id name account";
 //# sourceMappingURL=project.js.map

lib/types/index.d.ts

@@ -8,2 +8,3 @@ export * from './access-control.js';
 export * from './interaction.js';
+export * from "./memory.js";
 export * from './payload.js';
@@ -10,0 +11,0 @@ export * from './project.js';

lib/types/interaction.d.ts

@@ -104,3 +104,2 @@ import type { JSONObject } from "@llumiverse/core";
 }
-export declare const MEMORY_INPUT_PREFIX = "memory:";
 export interface InteractionExecutionPayload {
@@ -159,3 +158,3 @@ /**
     parameters: P;
-    memory_mapping?: Record<string, string>;
+    memory_mapping?: Record<string, any>;
     tags?: string[];
@@ -162,0 +161,0 @@ interaction: Interaction;

lib/types/project.d.ts

@@ -38,11 +38,20 @@ import { AccountRef } from "./user.js";
     default_model?: string;
-    generate_embeddings: boolean;
-    embeddings?: ProjectConfigurationEmbeddings;
+    embeddings: {
+        text?: ProjectConfigurationEmbeddings;
+        image?: ProjectConfigurationEmbeddings;
+        properties?: ProjectConfigurationEmbeddings;
+    };
     datacenter?: string;
     storage_bucket?: string;
 }
+export declare enum SupportedEmbeddingTypes {
+    text = "text",
+    image = "image",
+    properties = "properties"
+}
 export interface ProjectConfigurationEmbeddings {
     environment: string;
-    max_tokens: number;
+    enabled: boolean;
     dimensions: number;
+    max_tokens?: number;
     model?: string;
@@ -76,4 +85,8 @@ }
     objectsWithEmbeddings: number;
-    [string: string]: any;
+    vectorIndex: {
+        status: "READY" | "PENDING" | "DELETING" | "ABSENT";
+        name?: string;
+        type?: string;
+    };
 }
 //# sourceMappingURL=project.d.ts.map

lib/types/query.d.ts

 import { ExecutionRunStatus } from "./interaction.js";
+import { SupportedEmbeddingTypes } from "./project.js";
 export interface RunListingQueryOptions {
@@ -27,2 +28,3 @@ project?: string;
     similarTo?: string;
+    embeddingType?: SupportedEmbeddingTypes;
     type?: string;
@@ -29,0 +31,0 @@ }

lib/types/store/store.d.ts

@@ -0,5 +1,6 @@
+import { SearchPayload } from "../payload.js";
+import { SupportedEmbeddingTypes } from "../project.js";
+import { ObjectSearchQuery } from "../query.js";
 import { BaseObject } from "./common.js";
 import { RenditionProperties } from "./index.js";
-import { ObjectSearchQuery } from "../query.js";
-import { SearchPayload } from "../payload.js";
 export declare enum ContentObjectStatus {
@@ -12,2 +13,7 @@ created = "created",
 }
+export interface Embedding {
+    model: string;
+    values: number[];
+    etag?: string;
+}
 export interface ContentObject<T = any> extends ContentObjectItem<T> {
@@ -21,7 +27,3 @@ text?: string;
     };
-    embedding?: {
-        model?: string;
-        content: number[];
-        etag: string;
-    };
+    embeddings: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
     parts?: string[];
@@ -49,2 +51,3 @@ parts_etag?: string;
     properties: T | Record<string, any>;
+    run?: string;
 }
@@ -69,3 +72,5 @@ /**
     text?: string;
+    image?: string;
     threshold?: number;
+    type: SupportedEmbeddingTypes;
 }
@@ -72,0 +77,0 @@ export interface ComplexSearchPayload extends Omit<SearchPayload, 'query'> {

lib/types/user.d.ts

@@ -37,2 +37,3 @@ import { ApiKey } from "./apikey.js";
         user: UserRef;
+        disabled: boolean;
     }[];
@@ -39,0 +40,0 @@ onboarding: {

package.json

 {
   "name": "@becomposable/common",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "type": "module",
@@ -5,0 +5,0 @@ "types": "./lib/types/index.d.ts",

src/access-control.ts

@@ -39,2 +39,3 @@ /**
     access_protected = "access_protected",
+
 }
@@ -41,0 +42,0 @@

src/index.ts

@@ -8,2 +8,3 @@ export * from './access-control.js';
 export * from './interaction.js';
+export * from "./memory.js";
 export * from './payload.js';
@@ -10,0 +11,0 @@ export * from './project.js';

src/interaction.ts

@@ -143,3 +143,3 @@ import type { JSONObject } from "@llumiverse/core";
 
-export const MEMORY_INPUT_PREFIX = "memory:";
+
 export interface InteractionExecutionPayload {
@@ -203,3 +203,3 @@ /**
     // optional memory mapping when using memory packs as input
-    memory_mapping?: Record<string, string>;
+    memory_mapping?: Record<string, any>;
     tags?: string[];
@@ -206,0 +206,0 @@ //TODO a string is returned when executing not the interaction object

src/project.ts

@@ -61,4 +61,7 @@ import { AccountRef } from "./user.js";
 
-    generate_embeddings: boolean;
-    embeddings?: ProjectConfigurationEmbeddings
+    embeddings: {
+        text?: ProjectConfigurationEmbeddings;
+        image?: ProjectConfigurationEmbeddings;
+        properties?: ProjectConfigurationEmbeddings
+    }
 
@@ -70,6 +73,20 @@ datacenter?: string;
 
+// export interface ProjectConfigurationEmbeddings {
+//     environment: string;
+//     max_tokens: number;
+//     dimensions: number;
+//     model?: string;
+// }
+
+export enum SupportedEmbeddingTypes {
+    text = "text",
+    image = "image",
+    properties = "properties"
+}
+
 export interface ProjectConfigurationEmbeddings {
     environment: string;
-    max_tokens: number;
+    enabled: boolean;
     dimensions: number;
+    max_tokens?: number;
     model?: string;
@@ -109,3 +126,7 @@ }
     objectsWithEmbeddings: number;
-    [string: string]: any;
+    vectorIndex: {
+        status: "READY" | "PENDING" | "DELETING" | "ABSENT",
+        name?: string,
+        type?: string
+    }
 }

src/query.ts

 import { ExecutionRunStatus } from "./interaction.js";
+import { SupportedEmbeddingTypes } from "./project.js";
 
@@ -31,2 +32,3 @@ export interface RunListingQueryOptions {
     similarTo?: string;
+    embeddingType?: SupportedEmbeddingTypes;
     type?: string;
@@ -33,0 +35,0 @@ }

src/store/store.ts

@@ -0,5 +1,6 @@
+import { SearchPayload } from "../payload.js";
+import { SupportedEmbeddingTypes } from "../project.js";
+import { ObjectSearchQuery } from "../query.js";
 import { BaseObject } from "./common.js";
 import { RenditionProperties } from "./index.js";
-import { ObjectSearchQuery } from "../query.js";
-import { SearchPayload } from "../payload.js";
 
@@ -14,2 +15,9 @@ export enum ContentObjectStatus {
 
+
+export interface Embedding {
+    model: string; //the model used to generate this embedding
+    values: number[];
+    etag?: string; // the etag of the text used for the embedding
+}
+
 export interface ContentObject<T = any> extends ContentObjectItem<T> {
@@ -23,7 +31,3 @@ text?: string; // the text representation of the object
     };
-    embedding?: {
-        model?: string;
-        content: number[];
-        etag: string; // the etag of the text used for the embedding
-    },
+    embeddings: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
     parts?: string[]; // the list of objectId of the parts of the object
@@ -59,2 +63,3 @@ parts_etag?: string; // the etag of the text used for the parts list
     properties: T | Record<string, any>; // a JSON object that describes the object
+    run?: string; // the ID of the interaction run that created the object
 }
@@ -85,3 +90,5 @@
     text?: string;
+    image?: string;
     threshold?: number;
+    type: SupportedEmbeddingTypes
 }
@@ -88,0 +95,0 @@

src/user.ts

@@ -42,2 +42,3 @@ import { ApiKey } from "./apikey.js";
         user: UserRef;
+        disabled: boolean;
     }[];
@@ -44,0 +45,0 @@

No alert changes

Improved metrics

Total package byte prevSize

243029

increased by2.69%

Number of package files

187

increased by3.89%

Lines of code

4493

increased by2.93%

No dependency changes