View Source GoogleApi.Firestore.V1beta1.Model.FindNearest (google_api_firestore v0.27.0)

Nearest Neighbors search config.

Attributes

distanceMeasure (type: String.t, default: nil) - Required. The Distance Measure to use, required.
limit (type: integer(), default: nil) - Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
queryVector (type: GoogleApi.Firestore.V1beta1.Model.Value.t, default: nil) - Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
vectorField (type: GoogleApi.Firestore.V1beta1.Model.FieldReference.t, default: nil) - Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1beta1.Model.FindNearest{
  distanceMeasure: String.t() | nil,
  limit: integer() | nil,
  queryVector: GoogleApi.Firestore.V1beta1.Model.Value.t() | nil,
  vectorField: GoogleApi.Firestore.V1beta1.Model.FieldReference.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.