Class: Google::Apis::CesV1::GoogleSearchTool

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

Overview

Represents a tool to perform Google web searches for grounding. See https:// cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google- search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleSearchTool

Returns a new instance of GoogleSearchTool.



3774
3775
3776
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3774

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

Instance Attribute Details

#context_urls ⇒ Array<String>

Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed. Corresponds to the JSON property contextUrls

Returns:

  • (Array<String>) 


3744
3745
3746
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3744

def context_urls
  @context_urls
end

#description ⇒ String

Optional. Description of the tool's purpose. Corresponds to the JSON property description

Returns:

  • (String) 


3749
3750
3751
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3749

def description
  @description
end

#exclude_domains ⇒ Array<String>

Optional. List of domains to be excluded from the search results. Example: " example.com". A maximum of 2000 domains can be excluded. Corresponds to the JSON property excludeDomains

Returns:

  • (Array<String>) 


3755
3756
3757
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3755

def exclude_domains
  @exclude_domains
end

#name ⇒ String

Required. The name of the tool. Corresponds to the JSON property name

Returns:

  • (String) 


3760
3761
3762
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3760

def name
  @name
end

#preferred_domains ⇒ Array<String>

Optional. Specifies domains to restrict search results to. Example: "example. com", "another.site". A maximum of 20 domains can be specified. Corresponds to the JSON property preferredDomains

Returns:

  • (Array<String>) 


3766
3767
3768
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3766

def preferred_domains
  @preferred_domains
end

#prompt_config ⇒ Google::Apis::CesV1::GoogleSearchToolPromptConfig

Prompt settings used by the model when processing or summarizing the google search results. Corresponds to the JSON property promptConfig

Returns:



3772
3773
3774
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3772

def prompt_config
  @prompt_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3779
3780
3781
3782
3783
3784
3785
3786
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3779

def update!(**args)
  @context_urls = args[:context_urls] if args.key?(:context_urls)
  @description = args[:description] if args.key?(:description)
  @exclude_domains = args[:exclude_domains] if args.key?(:exclude_domains)
  @name = args[:name] if args.key?(:name)
  @preferred_domains = args[:preferred_domains] if args.key?(:preferred_domains)
  @prompt_config = args[:prompt_config] if args.key?(:prompt_config)
end