Package version:

Interface SingleVectorFieldResult

A single vector field result. Both @search.score and vector similarity values are returned. Vector similarity is related to @search.score by an equation.

interface SingleVectorFieldResult {
    searchScore?: number;
    vectorSimilarity?: number;
}

Properties

searchScore?: number

The @search.score value that is calculated from the vector similarity score. This is the score that's visible in a pure single-field single-vector query. NOTE: This property will not be serialized. It can only be populated by the server.

vectorSimilarity?: number

The vector similarity score for this document. Note this is the canonical definition of similarity metric, not the 'distance' version. For example, cosine similarity instead of cosine distance. NOTE: This property will not be serialized. It can only be populated by the server.