sst 3.0.1-12 → 3.0.1-16

package/dist/vector-client.d.ts

@@ -35,7 +35,7 @@ export type IngestEvent = {
      * }
      * ```
      */
-    metadata: any;
+    metadata: Record<string, any>;
 };
 export type RetrieveEvent = {
     /**
@@ -66,9 +66,9 @@ export type RetrieveEvent = {
      * @example
      * ```js
      * {
-     *   metadata: {
+     *   include: {
      *     type: "movie",
-     *     name: "Spiderman",
+     *     release: "2001",
      *   }
      * }
      * ```
@@ -83,10 +83,39 @@ export type RetrieveEvent = {
      *  {
      *    type: "book",
      *    name: "Spiderman",
-     *    release: "1962",
+     *    release: "2001",
+     *  }
+     */
+    include: Record<string, any>;
+    /**
+     * Exclude embeddings with metadata that match the provided fields.
+     * @example
+     * ```js
+     * {
+     *   include: {
+     *     type: "movie",
+     *     release: "2001",
+     *   },
+     *   exclude: {
+     *     name: "Spiderman",
+     *   }
+     * }
+     * ```
+     * This will match the embedding with metadata:
+     *  {
+     *    type: "movie",
+     *    name: "A Beautiful Mind",
+     *    release: "2001",
+     *  }
+     *
+     * But not the embedding with metadata:
+     *  {
+     *    type: "book",
+     *    name: "Spiderman",
+     *    release: "2001",
      *  }
      */
-    metadata: any;
+    exclude?: Record<string, any>;
     /**
      * The threshold of similarity between the prompt and the retrieved embeddings.
      * Only embeddings with a similarity score higher than the threshold will be returned.
@@ -122,22 +151,33 @@ export type RemoveEvent = {
      * To remove embeddings for movie with id "movie-123":
      * ```js
      * {
-     *   metadata: {
+     *   include: {
      *     id: "movie-123",
      *   }
      * }
      * ```
      * To remove embeddings for all movies:
      *  {
-     *   metadata: {
+     *   include: {
      *    type: "movie",
      *   }
      *  }
      */
-    metadata: any;
+    include: Record<string, any>;
+};
+type RetriveResponse = {
+    /**
+     * Metadata for the event in JSON format that was provided when ingesting the embedding.
+     */
+    metadata: Record<string, any>;
+    /**
+     * The similarity score between the prompt and the retrieved embedding.
+     */
+    score: number;
 };
 export declare const VectorClient: (name: string) => {
-    ingest: (event: IngestEvent) => Promise<any>;
-    retrieve: (event: RetrieveEvent) => Promise<any>;
-    remove: (event: RemoveEvent) => Promise<any>;
+    ingest: (event: IngestEvent) => Promise<void>;
+    retrieve: (event: RetrieveEvent) => Promise<RetriveResponse>;
+    remove: (event: RemoveEvent) => Promise<void>;
 };
+export {};

package/dist/vector-client.js

@@ -8,7 +8,7 @@ export const VectorClient = (name) => {
                 FunctionName: Resource[name].ingestorFunctionName,
                 Payload: JSON.stringify(event),
             }));
-            return parsePayload(ret, "Failed to ingest into the vector db");
+            parsePayload(ret, "Failed to ingest into the vector db");
         },
         retrieve: async (event) => {
             const ret = await lambda.send(new InvokeCommand({
@@ -22,7 +22,7 @@ export const VectorClient = (name) => {
                 FunctionName: Resource[name].removerFunctionName,
                 Payload: JSON.stringify(event),
             }));
-            return parsePayload(ret, "Failed to remove from the vector db");
+            parsePayload(ret, "Failed to remove from the vector db");
         },
     };
 };

package/package.json

@@ -2,7 +2,8 @@
   "$schema": "https://json.schemastore.org/package.json",
   "name": "sst",
   "type": "module",
-  "version": "3.0.1-12",
+  "sideEffects": false,
+  "version": "3.0.1-16",
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",