Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VertexAiSearch

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1VertexAiSearch

Returns a new instance of GoogleCloudAiplatformV1VertexAiSearch.



39676
39677
39678
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39676

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

Instance Attribute Details

#data_store_specs ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VertexAiSearchDataStoreSpec>

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:



39649
39650
39651
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39649

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) 


39656
39657
39658
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39656

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) 


39663
39664
39665
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39663

def engine
  @engine
end

#filter ⇒ String

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

Returns:

  • (String) 


39668
39669
39670
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39668

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) 


39674
39675
39676
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39674

def max_results
  @max_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



39681
39682
39683
39684
39685
39686
39687
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 39681

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