Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1VectorConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

The index configuration to support vector search operations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1VectorConfig

Returns a new instance of GoogleFirestoreAdminV1VectorConfig.



3581
3582
3583
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3581

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dimension ⇒ Fixnum

Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. Corresponds to the JSON property dimension

Returns:

  • (Fixnum) 


3573
3574
3575
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3573

def dimension
  @dimension
end

#flat ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1FlatIndex

An index that stores vectors in a flat data structure, and supports exhaustive search. Corresponds to the JSON property flat

Returns:



3579
3580
3581
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3579

def flat
  @flat
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3586
3587
3588
3589
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3586

def update!(**args)
  @dimension = args[:dimension] if args.key?(:dimension)
  @flat = args[:flat] if args.key?(:flat)
end