@weaviate
    Preparing search index...

    Type Alias HybridSearchOptions<T, V>

    Options available to the hybrid search type only

    type HybridSearchOptions<T, V> = {
        alpha?: number;
        bm25Operator?: Bm25OperatorOptions;
        diversity?: DiversityConfig;
        fusionType?: "Ranked" | "RelativeScore";
        maxVectorDistance?: number;
        queryProperties?: (PrimitiveKeys<T> | Bm25QueryProperty<T>)[];
        targetVector?: TargetVectorInputType<V>;
        vector?:
            | NearVectorInputType
            | HybridNearTextSubSearch
            | HybridNearVectorSubSearch;
    }

    Type Parameters

    • T
    • V
    Index
    alpha? bm25Operator? diversity? fusionType? maxVectorDistance? queryProperties? targetVector? vector?
    alpha?: number

    The weight of the vector score. If not specified, the default weight specified by the server is used.

    bm25Operator?: Bm25OperatorOptions
    diversity?: DiversityConfig

    Specify diversity selection algorithm.

    fusionType?: "Ranked" | "RelativeScore"

    The type of fusion to apply. If not specified, the default fusion type specified by the server is used.

    maxVectorDistance?: number

    The maximum tolerated similarity in the vector search before the results are cutoff from the result set.

    queryProperties?: (PrimitiveKeys<T> | Bm25QueryProperty<T>)[]

    The properties to search in. If not specified, all properties are searched.

    targetVector?: TargetVectorInputType<V>

    Specify which vector(s) to search on if using named vectors.

    vector?:
        | NearVectorInputType
        | HybridNearTextSubSearch
        | HybridNearVectorSubSearch

    The specific vector to search for or a specific vector subsearch. If not specified, the query is vectorized and used in the similarity search.

    Settings
    Member Visibility

    On This Page
    Properties