@gensx/storage/dist/cjs/search/types.d.ts

Cloud storage, blobs, sqlite, and vector database providers/hooks for GenSX.

import type { AggregateBy, DistanceMetric, Filter, ID, RankBy, Row } from "@turbopuffer/turbopuffer/resources";
/**
 * Query results response structure
 */
export interface QueryResults {
    /** Array of result rows */
    rows?: Row[];
    /** Aggregation results if requested */
    aggregations?: Record<string, unknown>;
}
/**
 * Schema type for TurboPuffer fields
 */
export type SchemaType = "string" | "int" | "uint" | "uuid" | "datetime" | "bool" | "[]string" | "[]int" | "[]uint" | "[]uuid" | `[${number}]f16` | `[${number}]f32`;
/**
 * Consistency requirements for queries
 */
export interface Consistency {
    /**
     * The query's consistency level.
     *
     * - `strong` - Strong consistency. Requires a round-trip to object storage to
     *   fetch the latest writes.
     * - `eventual` - Eventual consistency. Does not require a round-trip to object
     *   storage, but may not see the latest writes.
     */
    level?: "strong" | "eventual";
}
/**
 * Column-based upsert format
 */
export interface UpsertColumns {
    id: (string | number)[];
    vector?: number[][];
    [key: string]: unknown;
}
/**
 * Row-based upsert format
 */
export type UpsertRows = {
    id: string | number;
    vector?: number[];
    [key: string]: unknown;
}[];
/**
 * Column-based patch format
 */
export interface PatchColumns {
    id: (string | number)[];
    [key: string]: unknown;
}
/**
 * Row-based patch format
 */
export type PatchRows = {
    id: string | number;
    [key: string]: unknown;
}[];
/**
 * Options for namespace operations
 */
export interface NamespaceOptions {
    /**
     * Distance metric to use for vector similarity
     */
    distanceMetric?: DistanceMetric;
    /**
     * Schema for the namespace
     */
    schema?: Schema;
}
export interface WriteParams {
    /** Upserts documents in a column-based format. */
    upsertColumns?: UpsertColumns;
    /** Upserts documents in a row-based format. */
    upsertRows?: UpsertRows;
    /**
     * Patches documents in a column-based format. Identical to `upsert_columns`, but
     * instead of overwriting entire documents, only the specified keys are written.
     */
    patchColumns?: PatchColumns;
    /**
     * Patches documents in a row-based format. Identical to `upsert_rows`, but
     * instead of overwriting entire documents, only the specified keys are written.
     */
    patchRows?: PatchRows;
    /** Deletes documents by ID. */
    deletes?: ID[];
    /** Deletes documents that match a filter. */
    deleteByFilter?: Filter;
    distanceMetric?: DistanceMetric;
    schema?: Schema;
}
/**
 * Options for query operations
 */
export interface QueryOptions {
    /**
     * Number of results to return
     */
    topK?: number;
    /**
     * Whether to include attributes in results
     */
    includeAttributes?: boolean | string[];
    /**
     * Filter results by attribute values
     */
    filters?: Filter;
    /**
     * How to rank results
     */
    rankBy?: RankBy;
    /**
     * Aggregate results by specified fields
     * The key is the aggregation name, the value is an AggregateBy tuple.
     * Example: { myCount: ["Count", "id"] }
     */
    aggregateBy?: Record<string, AggregateBy>;
    /**
     * Consistency requirements for the query
     */
    consistency?: Consistency;
}
/**
 * Schema interface with camelCasing
 */
export type Schema = Record<string, {
    type?: SchemaType;
    filterable?: boolean;
    fullTextSearch?: boolean | Partial<{
        k1: number;
        b: number;
        language: string;
        stemming: boolean;
        removeStopwords: boolean;
        caseSensitive: boolean;
        tokenizer: string;
    }>;
    ann?: boolean;
}>;
/**
 * Result of ensuring a namespace exists
 */
export interface EnsureNamespaceResult {
    exists: boolean;
    created: boolean;
}
/**
 * Result of deleting a namespace
 */
export interface DeleteNamespaceResult {
    deleted: boolean;
}
/**
 * Interface for a vector namespace
 */
export interface Namespace {
    /**
     * Get the namespace ID
     */
    namespaceId: string;
    /**
     * Upsert vectors into the namespace
     * @param vectors The vectors to upsert
     * @returns Promise that resolves when the operation is complete
     */
    /**
     * Upsert vectors into the namespace
     * @param vectors The vectors to upsert
     * @returns Promise that resolves when the operation is complete
     */
    write({ upsertColumns, upsertRows, patchColumns, patchRows, deletes, deleteByFilter, distanceMetric, schema, }: WriteParams): Promise<{
        message: string;
        rowsAffected: number;
    }>;
    /**
     * Query vectors by similarity
     * @param options Query options
     * @returns Promise with query results
     */
    query({ topK, includeAttributes, filters, rankBy, aggregateBy, consistency, }: QueryOptions): Promise<QueryResults>;
    /**
     * Get the current schema for the namespace
     * @returns Promise with the current schema
     */
    getSchema(): Promise<Schema>;
    /**
     * Update the schema for the namespace
     * @param schema The new schema
     * @returns Promise with the updated schema
     */
    updateSchema({ schema }: {
        schema: Schema;
    }): Promise<Schema>;
}
/**
 * Interface for vector search
 */
export interface SearchStorage {
    /**
     * Get a namespace object for a specific namespace ID
     * @param name The namespace name
     * @returns A namespace object
     */
    getNamespace(name: string): Namespace;
    /**
     * List all namespaces
     * @param options Options for listing namespaces
     * @returns Promise with array of namespace IDs and optional next cursor for pagination
     */
    listNamespaces(options?: {
        prefix?: string;
        limit?: number;
        cursor?: string;
    }): Promise<{
        namespaces: {
            name: string;
            createdAt: Date;
        }[];
        nextCursor?: string;
    }>;
    /**
     * Delete a namespace
     * @param name The namespace name
     * @returns Promise with the delete result
     */
    deleteNamespace(name: string): Promise<DeleteNamespaceResult>;
    /**
     * Check if a namespace exists
     * @param name The namespace name
     * @returns Promise that resolves to true if the namespace exists
     */
    namespaceExists(name: string): Promise<boolean>;
    /**
     * Ensure a namespace exists
     * @param name The namespace name
     * @returns Promise with the ensure result
     */
    ensureNamespace(name: string): Promise<EnsureNamespaceResult>;
    /**
     * Check if a namespace has been ensured
     */
    hasEnsuredNamespace(name: string): boolean;
}
/**
 * Storage configuration for search
 */
export interface SearchStorageOptions {
    /**
     * Optional project name. By default, the GENSX_PROJECT environment variable will be used then the projectName from the gensx.yaml file.
     */
    project?: string;
    /**
     * Optional environment name. By default, the GENSX_ENV environment variable will be used then the currently selected environment in the CLI (e.g. `gensx env select`).
     */
    environment?: string;
}
//# sourceMappingURL=types.d.ts.map