Reference documentation and code samples for the Google Cloud Ces V1 Client class GoogleSearchTool.
Represents a tool to perform Google web searches for grounding.
See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search .
Generated from protobuf message google.cloud.ces.v1.GoogleSearchTool
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the tool.
↳ description
string
Optional. Description of the tool's purpose.
↳ context_urls
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.
↳ preferred_domains
string[]
Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
↳ exclude_domains
string[]
Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
↳ prompt_config
GoogleSearchTool\PromptConfig
Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
getName
Required. The name of the tool.
string
setName
Required. The name of the tool.
var
string
$this
getDescription
Optional. Description of the tool's purpose.
string
setDescription
Optional. Description of the tool's purpose.
var
string
$this
getContextUrls
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.
setContextUrls
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.
var
string[]
$this
getPreferredDomains
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be specified.
setPreferredDomains
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be specified.
var
string[]
$this
getExcludeDomains
Optional. List of domains to be excluded from the search results.
Example: "example.com". A maximum of 2000 domains can be excluded.
setExcludeDomains
Optional. List of domains to be excluded from the search results.
Example: "example.com". A maximum of 2000 domains can be excluded.
var
string[]
$this
getPromptConfig
Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
hasPromptConfig
clearPromptConfig
setPromptConfig
Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
$this
