sst/dist/vector/index.d.ts

import { Resource } from "../resource.js";
export interface PutEvent {
    /**
     * The vector to store in the database.
     * @example
     * ```js
     * {
     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9]
     * }
     * ```
     */
    vector: number[];
    /**
     * Metadata for the event as JSON.
     * This will be used to filter when querying and removing vectors.
     * @example
     * ```js
     * {
     *   metadata: {
     *     type: "movie",
     *     id: "movie-123",
     *     name: "Spiderman"
     *   }
     * }
     * ```
     */
    metadata: Record<string, any>;
}
export interface QueryEvent {
    /**
     * The vector used to query the database.
     * @example
     * ```js
     * {
     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9]
     * }
     * ```
     */
    vector: number[];
    /**
     * The metadata used to filter the vectors.
     * Only vectors that match the provided fields will be returned.
     * @example
     * Given this filter.
     * ```js
     * {
     *   include: {
     *     type: "movie",
     *     release: "2001"
     *   }
     * }
     * ```
     * It will match a vector with the metadata:
     * ```js
     * {
     *   type: "movie",
     *   name: "Spiderman",
     *   release: "2001"
     * }
     * ```
     *
     * But not a vector with this metadata:
     * ```js
     *  {
     *    type: "book",
     *    name: "Spiderman",
     *    release: "2001"
     *  }
     * ```
     */
    include: Record<string, any>;
    /**
     * Exclude vectors with metadata that match the provided fields.
     * @example
     * Given this filter.
     * ```js
     * {
     *   include: {
     *     type: "movie",
     *     release: "2001"
     *   },
     *   exclude: {
     *     name: "Spiderman"
     *   }
     * }
     * ```
     * This will match a vector with metadata:
     * ```js
     *  {
     *    type: "movie",
     *    name: "A Beautiful Mind",
     *    release: "2001"
     *  }
     * ```
     *
     * But not a vector with the metadata:
     * ```js
     *  {
     *    type: "book",
     *    name: "Spiderman",
     *    release: "2001"
     *  }
     * ```
     */
    exclude?: Record<string, any>;
    /**
     * The threshold of similarity between the prompt and the queried vectors.
     * Only vectors with a similarity score higher than the threshold will be returned.
     *
     * This will return values is between 0 and 1.
     * - `0` means the prompt and the queried vectors are completely different.
     * - `1` means the prompt and the queried vectors are identical.
     *
     * @default `0`
     * @example
     * ```js
     * {
     *   threshold: 0.5
     * }
     * ```
     */
    threshold?: number;
    /**
     * The number of results to return.
     * @default `10`
     * @example
     * ```js
     * {
     *   count: 10
     * }
     * ```
     */
    count?: number;
}
export interface RemoveEvent {
    /**
     * The metadata used to filter the removal of vectors.
     * Only vectors with metadata that match the provided fields will be removed.
     * @example
     * To remove vectors for movie with id `movie-123`:
     * ```js
     * {
     *   include: {
     *     id: "movie-123",
     *   }
     * }
     * ```
     * To remove vectors for all _movies_:
     * ```js
     *  {
     *   include: {
     *    type: "movie",
     *   }
     *  }
     * ```
     */
    include: Record<string, any>;
}
export interface QueryResponse {
    /**
     * List of results matching the query.
     */
    results: {
        /**
         * Metadata for the event that was provided when storing the vector.
         */
        metadata: Record<string, any>;
        /**
         * The similarity score between the prompt and the queried vector.
         */
        score: number;
    }[];
}
export interface VectorClientResponse {
    /**
     * Store a vector into the database.
     * @example
     * ```ts title="src/lambda.ts"
     * await client.put({
     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
     *   metadata: { type: "movie", genre: "comedy" },
     * });
     * ```
     */
    put: (event: PutEvent) => Promise<void>;
    /**
     * Query vectors that are similar to the given vector
     * @example
     * ```ts title="src/lambda.ts"
     * const result = await client.query({
     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
     *   include: { type: "movie" },
     *   exclude: { genre: "thriller" },
     * });
     * ```
     */
    query: (event: QueryEvent) => Promise<QueryResponse>;
    /**
     * Remove vectors from the database.
     * @example
     * ```ts title="src/lambda.ts"
     * await client.remove({
     *   include: { type: "movie" },
     * });
     * ```
     */
    remove: (event: RemoveEvent) => Promise<void>;
}
/**
 * Create a client to interact with the Vector database.
 * @example
 * ```ts title="src/lambda.ts"
 * import { VectorClient } from "sst";
 * const client = VectorClient("MyVectorDB");
 * ```
 *
 * Store a vector into the db
 *
 * ```ts title="src/lambda.ts"
 * await client.put({
 *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
 *   metadata: { type: "movie", genre: "comedy" },
 * });
 * ```
 *
 * Query vectors that are similar to the given vector
 *
 * ```ts title="src/lambda.ts"
 * const result = await client.query({
 *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
 *   include: { type: "movie" },
 *   exclude: { genre: "thriller" },
 * });
 * ```
 */
export declare function VectorClient<T extends keyof {
    [key in keyof Resource as "sst.aws.Vector" extends Resource[key]["type"] ? string extends key ? never : key : never]: Resource[key];
}>(name: T): VectorClientResponse;