Type alias BaseHybridOptions<T>

BaseHybridOptions<T>: SearchOptions<T> & {
    alpha?: number;
    fusionType?: "Ranked" | "RelativeScore";
    maxVectorDistance?: number;
    queryProperties?: (PrimitiveKeys<T> | Bm25QueryProperty<T>)[];
    targetVector?: TargetVectorInputType;
    vector?: NearVectorInputType | HybridNearTextSubSearch | HybridNearVectorSubSearch;
}

Base options available in the query.hybrid method

Type Parameters

  • T

Type declaration

  • Optional alpha?: number

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

  • Optional fusionType?: "Ranked" | "RelativeScore"

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

  • Optional maxVectorDistance?: number

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

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

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

  • Optional targetVector?: TargetVectorInputType

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

  • Optional 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

Theme