Class: Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VertexAiSearch

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

Overview

Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent- builder

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1VertexAiSearch

Returns a new instance of GoogleCloudAiplatformV1beta1VertexAiSearch.



3713
3714
3715
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3713

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

Instance Attribute Details

#data_store_specs ⇒ Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VertexAiSearchDataStoreSpec>

Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. Corresponds to the JSON property dataStoreSpecs

Returns:



3686
3687
3688
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3686

def data_store_specs
  @data_store_specs
end

#datastore ⇒ String

Optional. Fully-qualified Vertex AI Search data store resource ID. Format: projects/project/locations/location/collections/collection/dataStores/ dataStore` Corresponds to the JSON propertydatastore`

Returns:

  • (String) 


3693
3694
3695
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3693

def datastore
  @datastore
end

#engine ⇒ String

Optional. Fully-qualified Vertex AI Search engine resource ID. Format: projects/project/locations/location/collections/collection/engines/ engine` Corresponds to the JSON propertyengine`

Returns:

  • (String) 


3700
3701
3702
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3700

def engine
  @engine
end

#filter ⇒ String

Optional. Filter strings to be passed to the search API. Corresponds to the JSON property filter

Returns:

  • (String) 


3705
3706
3707
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3705

def filter
  @filter
end

#max_results ⇒ Fixnum

Optional. Number of search results to return per query. The default value is

  1. The maximumm allowed value is 10. Corresponds to the JSON property maxResults

Returns:

  • (Fixnum) 


3711
3712
3713
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3711

def max_results
  @max_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3718
3719
3720
3721
3722
3723
3724
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 3718

def update!(**args)
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
  @datastore = args[:datastore] if args.key?(:datastore)
  @engine = args[:engine] if args.key?(:engine)
  @filter = args[:filter] if args.key?(:filter)
  @max_results = args[:max_results] if args.key?(:max_results)
end