dyna-record
    Preparing search index...

    Interface SearchOptions

    Options for a vector search.

    interface SearchOptions {
        filter?: SearchFilter;
        in?: string;
        scopeId?: string;
        topK?: number;
    }
    Index

    Properties

    filter?: SearchFilter

    Equality filter conditions over the index's @SearchFilterable attributes, merged into the search's single condition expression.

    in?: string

    Narrows the search to a single member entity type of the index by name. Omitted, the search spans every member entity. DynamoDB's search condition grammar is equality-only, so exactly one entity type may be named — multi-type subsets are inexpressible in one operation.

    scopeId?: string

    The scope value when searching a scopedBy vector index (EX: the parent entity's id). Required for scoped indexes — a scoped index is queryable only per scope value. Global indexes take no scope id.

    topK?: number

    The number of most similar results to return. Defaults to 10; DynamoDB supports at most 100. There is no pagination.