ToolGoogleSearchTool class
Constructors
-
ToolGoogleSearchTool({Input<List<String>?>? contextUrls, Input<String?>? description, Input<List<String>?>? excludeDomains, required Input<String> name, Input<List<String>?>? preferredDomains, Input<ToolGoogleSearchToolPromptConfig?>? promptConfig})
-
Creates a new ToolGoogleSearchTool.
contextUrls Content will be fetched directly from these URLs for context and grounding.
description Description of the tool's purpose.
excludeDomains List of domains to be excluded from the search results.
name The name of the tool.
preferredDomains Specifies domain names to guide the search.
promptConfig Optional. Prompt instructions passed to planner on how the search results should be
const
-
ToolGoogleSearchTool.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
contextUrls
→ Input<List<String>?>?
-
Content will be fetched directly from these URLs for context and grounding.
More details: https://cloud.google.com/vertex-ai/generative-ai/docs/url-context.
Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
final
-
description
→ Input<String?>?
-
Description of the tool's purpose.
final
-
excludeDomains
→ Input<List<String>?>?
-
List of domains to be excluded from the search results.
Example: "example.com".
A maximum of 2000 domains can be excluded.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
name
→ Input<String>
-
The name of the tool.
final
-
preferredDomains
→ Input<List<String>?>?
-
Specifies domain names to guide the search.
The model will be instructed to prioritize these domains
when formulating queries for google search.
This is a best-effort hint and these domains may or may
not be exclusively reflected in the final search results.
Example: "example.com", "another.site".
A maximum of 20 domains can be specified.
final
-
promptConfig
→ Input<ToolGoogleSearchToolPromptConfig?>?
-
Optional. Prompt instructions passed to planner on how the search results should be
processed for text and voice.
Structure is documented below.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited