Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource

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

Overview

Message to be used for grounding with Vertex AI Search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource

Returns a new instance of GoogleCloudDiscoveryengineV1GenerateGroundedContentRequestGroundingSourceSearchSource.



5604
5605
5606
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5604

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

Instance Attribute Details

#filter ⇒ String

Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. Corresponds to the JSON property filter

Returns:

  • (String) 


5583
5584
5585
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5583

def filter
  @filter
end

#max_result_count ⇒ Fixnum

Number of search results to return. The default value is 10. The maximumm allowed value is 10. Corresponds to the JSON property maxResultCount

Returns:

  • (Fixnum) 


5589
5590
5591
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5589

def max_result_count
  @max_result_count
end

#safe_search ⇒ Boolean Also known as: safe_search?

If set, safe search is enabled in Vertex AI Search requests. Corresponds to the JSON property safeSearch

Returns:

  • (Boolean) 


5594
5595
5596
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5594

def safe_search
  @safe_search
end

#serving_config ⇒ String

The resource name of the Engine to use. Format: projects/project/locations/ location/collections/collection_id/engines/engine_id/servingConfigs/ serving_config_id` Corresponds to the JSON propertyservingConfig`

Returns:

  • (String) 


5602
5603
5604
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5602

def serving_config
  @serving_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5609
5610
5611
5612
5613
5614
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5609

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @max_result_count = args[:max_result_count] if args.key?(:max_result_count)
  @safe_search = args[:safe_search] if args.key?(:safe_search)
  @serving_config = args[:serving_config] if args.key?(:serving_config)
end