VectorIndex class

Metadata describing a vector index within a bucket.

Annotations
  • @experimental

Constructors

VectorIndex({required String name, String? bucketName, VectorDataType? dataType, int? dimension, DistanceMetric? distanceMetric, List<String>? nonFilterableMetadataKeys, DateTime? creationTime})
const
VectorIndex.fromJson(Map<String, dynamic> json)
factory

Properties

bucketName → String?
The name of the parent vector bucket. null when the server does not include it (for example in list responses).
final
creationTime → DateTime?
When the index was created, in UTC. null when the server does not include it.
final
dataType → VectorDataType?
The data type of the vector components. null for values the client does not recognize.
final
dimension → int?
The dimensionality of the vectors stored in this index.
final
distanceMetric → DistanceMetric?
The distance metric used for similarity queries. null for values the client does not recognize.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String
The unique name of the index within its bucket.
final
nonFilterableMetadataKeys → List<String>?
Metadata keys that are stored but cannot be used in query filters.
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