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.



3428
3429
3430
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3428

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) 


3420
3421
3422
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3420

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:



3426
3427
3428
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3426

def flat
  @flat
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3433
3434
3435
3436
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3433

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