VectorMatch class

A vector returned from a get, list or query operation.

data, metadata and distance are only populated when the corresponding operation was asked to return them.

Annotations
  • @experimental

Constructors

VectorMatch({required String key, List<double>? data, Map<String, dynamic>? metadata, double? distance})
const
VectorMatch.fromJson(Map<String, dynamic> json)
factory

Properties

data → List<double>?
The vector embedding, when requested.
final
distance → double?
The similarity distance from the query vector. Only present in query results when distances were requested.
final
hashCode → int
The hash code for this object.
no setterinherited
key → String
The unique key identifying the vector within its index.
final
metadata → Map<String, dynamic>?
The arbitrary metadata stored alongside the vector, when requested.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited