sst 3.0.1-11 → 3.0.1-12

package/dist/vector-client.d.ts

@@ -1,16 +1,7 @@
 export type IngestEvent = {
-    /**
-     * The external ID of the event.
-     * If the external ID already exists, the embedding and metadata will be updated.
-     * @example
-     * ```js
-     * {
-     *   externalId: "37043bc3-2166-437d-bbf8-a2238d7a5796"
-     * }
-     */
-    externalId: string;
     /**
      * The text used to generate the embedding vector.
+     * At least one of `text` or `image` must be provided.
      * @example
      * ```js
      * {
@@ -18,9 +9,10 @@ export type IngestEvent = {
      * }
      * ```
      */
-    text: string;
+    text?: string;
     /**
      * The base64 representation of the image used to generate the embedding vector.
+     * At least one of `text` or `image` must be provided.
      * @example
      * ```js
      * {
@@ -30,14 +22,15 @@ export type IngestEvent = {
      */
     image?: string;
     /**
-     * Additional metadata for the event in JSON format.
-     * This metadata will be used to filter the retrieval of events.
+     * Metadata for the event in JSON format.
+     * This metadata will be used to filter when retrieving and removing embeddings.
      * @example
      * ```js
      * {
      *   metadata: {
-     *     key1: "value1",
-     *     key2: "value2"
+     *     type: "movie",
+     *     id: "movie-123",
+     *     name: "Spiderman",
      *   }
      * }
      * ```
@@ -46,18 +39,30 @@ export type IngestEvent = {
 };
 export type RetrieveEvent = {
     /**
-     * The prompt used to retrieve events.
+     * The text prompt used to retrieve embeddings.
+     * At least one of `text` or `image` must be provided.
      * @example
      * ```js
      * {
-     *   prompt: "This is an example text.",
+     *   text: "This is an example text.",
      * }
      * ```
      */
-    prompt: string;
+    text?: string;
     /**
-     * The metadata used to filter the retrieval of events.
-     * Only events with metadata that match the provided fields will be returned.
+     * The base64 representation of the image prompt used to retrive embeddings.
+     * At least one of `text` or `image` must be provided.
+     * @example
+     * ```js
+     * {
+     *   image: await fs.readFile("./file.jpg").toString("base64"),
+     * }
+     * ```
+     */
+    image?: string;
+    /**
+     * The metadata used to filter the retrieval of embeddings.
+     * Only embeddings with metadata that match the provided fields will be returned.
      * @example
      * ```js
      * {
@@ -67,13 +72,14 @@ export type RetrieveEvent = {
      *   }
      * }
      * ```
-     * This will match event with metadata:
+     * This will match the embedding with metadata:
      *  {
      *    type: "movie",
      *    name: "Spiderman",
      *    release: "2001",
      *  }
-     * But this will not match event with metadata:
+     *
+     * But not the embedding with metadata:
      *  {
      *    type: "book",
      *    name: "Spiderman",
@@ -82,11 +88,11 @@ export type RetrieveEvent = {
      */
     metadata: any;
     /**
-     * The threshold of similarity between the prompt and the retrieved events.
-     * Only events with a similarity score higher than the threshold will be returned.
+     * The threshold of similarity between the prompt and the retrieved embeddings.
+     * Only embeddings with a similarity score higher than the threshold will be returned.
      * Expected value is between 0 and 1.
-     * - 0 means the prompt and the retrieved events are completely different.
-     * - 1 means the prompt and the retrieved events are identical.
+     * - 0 means the prompt and the retrieved embeddings are completely different.
+     * - 1 means the prompt and the retrieved embeddings are identical.
      * @default 0
      * @example
      * ```js
@@ -110,17 +116,28 @@ export type RetrieveEvent = {
 };
 export type RemoveEvent = {
     /**
-     * The external ID of the event to remove.
+     * The metadata used to filter the removal of embeddings.
+     * Only embeddings with metadata that match the provided fields will be removed.
      * @example
+     * To remove embeddings for movie with id "movie-123":
      * ```js
      * {
-     *   externalId: "37043bc3-2166-437d-bbf8-a2238d7a5796"
+     *   metadata: {
+     *     id: "movie-123",
+     *   }
      * }
+     * ```
+     * To remove embeddings for all movies:
+     *  {
+     *   metadata: {
+     *    type: "movie",
+     *   }
+     *  }
      */
-    externalId: string;
+    metadata: any;
 };
 export declare const VectorClient: (name: string) => {
     ingest: (event: IngestEvent) => Promise<any>;
     retrieve: (event: RetrieveEvent) => Promise<any>;
-    delete: (event: RemoveEvent) => Promise<any>;
+    remove: (event: RemoveEvent) => Promise<any>;
 };

package/dist/vector-client.js

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

package/package.json

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