dyna-record
    Preparing search index...

    Interface VectorIndexOptions

    Options for defining a vector index through the static vectorIndex factory on a table class.

    interface VectorIndexOptions {
        include?: (() => EntityClass<default>)[];
        model: EmbeddingModelDescriptor;
        name: string;
        provider: EmbeddingProvider;
        scopedBy?: () => EntityClass<default>;
    }
    Index

    Properties

    include? model name provider scopedBy?

    Properties

    include?: (() => EntityClass<default>)[]

    Optional entity thunks adding FK-only members to a scoped index — searchable entities that carry the scoping foreign key but have no declared inverse relationship on the scope parent.

    model: EmbeddingModelDescriptor

    The embedding model descriptor (EX: TitanTextEmbedV2), carrying the dimensions and distance function the index is provisioned with.

    name: string

    The DynamoDB IndexName of the vector index.

    provider: EmbeddingProvider

    The embed function used to generate vectors. Required — dyna-record ships no embedding implementation; the provider owns credentials, region, retry, and timeout posture.

    scopedBy?: () => EntityClass<default>

    Optional entity thunk selecting the scope parent. The foreign key attribute referencing this entity becomes the index HASH, making the index queryable only per scope value. Without scopedBy the index compiles to no HASH and its searches are global.

    Settings

    Member Visibility

    On This Page

    Properties