Member Junction
    Preparing search index...

    Interface ColocatedQueryOptions

    Options for a colocated query — a vector component, an optional keyword component, fused together, with an optional metadata filter. Distinct from QueryOptions because it carries the keyword + fusion controls and is answered in a single server-side statement.

    interface ColocatedQueryOptions {
        filter?: object;
        fusion?: ColocatedFusion;
        includeMetadata?: boolean;
        includeValues?: boolean;
        indexName: string;
        keyword?: string;
        topK: number;
        vector?: number[];
    }
    Index

    Properties

    filter? fusion? includeMetadata? includeValues? indexName keyword? topK vector?

    Properties

    filter?: object

    Metadata filter — same shape accepted by QueryOptions.filter.

    fusion?: ColocatedFusion

    Fusion strategy. Defaults to 'rrf' when both a vector and a keyword are present, otherwise the single available component is used.

    includeMetadata?: boolean

    Include stored metadata with each match (default true).

    includeValues?: boolean

    Include raw embedding values with each match (default false).

    indexName: string

    Index (table) name.

    keyword?: string

    Keyword string for the full-text component of a hybrid query.

    topK: number

    Maximum results to return.

    vector?: number[]

    Query embedding. Optional only when keyword is supplied (keyword-only search).

    Settings

    Member Visibility

    On This Page

    Properties