0.3.1 (latest) 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::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>.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #context_urls

    def context_urls() -> ::Array<::String>

**Returns**

- (::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.

### #context_urls=

    def context_urls=(value) -> ::Array<::String>

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. Description of the tool's purpose.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Description of the tool's purpose.
**Returns**

- (::String) --- Optional. Description of the tool's purpose.

### #exclude_domains

    def exclude_domains() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.

### #exclude_domains=

    def exclude_domains=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
**Returns**

- (::Array\<::String\>) --- Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. The name of the tool.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The name of the tool.
**Returns**

- (::String) --- Required. The name of the tool.

### #preferred_domains

    def preferred_domains() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.

### #preferred_domains=

    def preferred_domains=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
**Returns**

- (::Array\<::String\>) --- Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.

### #prompt_config

    def prompt_config() -> ::Google::Cloud::Ces::V1beta::GoogleSearchTool::PromptConfig

**Returns**

- ([::Google::Cloud::Ces::V1beta::GoogleSearchTool::PromptConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-GoogleSearchTool-PromptConfig)) --- Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.

### #prompt_config=

    def prompt_config=(value) -> ::Google::Cloud::Ces::V1beta::GoogleSearchTool::PromptConfig

**Parameter**

- **value** ([::Google::Cloud::Ces::V1beta::GoogleSearchTool::PromptConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-GoogleSearchTool-PromptConfig)) --- Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
**Returns**

- ([::Google::Cloud::Ces::V1beta::GoogleSearchTool::PromptConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-ces-v1beta/latest/Google-Cloud-Ces-V1beta-GoogleSearchTool-PromptConfig)) --- Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.