React Native Firebase
    Preparing search index...

    Type Alias FindNearestStageOptionsBeta

    FindNearestStageOptions: StageOptions & {
        distanceField?: string;
        distanceMeasure: "euclidean" | "cosine" | "dot_product";
        field: Field | string;
        limit?: number;
        vectorValue: VectorValue | number[];
    }

    Options for FindNearest stage (vector search).

    Type Declaration

    • Optional BetadistanceField?: string

      If set, specifies the field on the output documents that will contain the computed vector distance for the document. If not set, the computed vector distance will not be returned.

    • BetadistanceMeasure: "euclidean" | "cosine" | "dot_product"

      Specifies the method used to compute the distance between vectors. Possible values are: 'euclidean', 'cosine', 'dot_product'.

    • Betafield: Field | string

      Specifies the field to be used. This can be a string representing the field path (e.g., 'fieldName', 'nested.fieldName') or an object of type Field representing a more complex field expression.

    • Optional Betalimit?: number

      The maximum number of documents to return from the FindNearest stage.

    • BetavectorValue: VectorValue | number[]

      Specifies the query vector value, to which the vector distance will be computed.

    Settings

    Member Visibility