# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Assistant (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Assistant.

Discovery Engine Assistant resource.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Protobuf-Timestamp)) --- Output only. Represents the time when this Assistant was created.

### #customer_policy

    def customer_policy() -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::CustomerPolicy

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::CustomerPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-CustomerPolicy)) --- Optional. Customer policy for the assistant.

### #customer_policy=

    def customer_policy=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::CustomerPolicy

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::CustomerPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-CustomerPolicy)) --- Optional. Customer policy for the assistant.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::CustomerPolicy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-CustomerPolicy)) --- Optional. Customer policy for the assistant.

### #default_web_grounding_toggle_off

    def default_web_grounding_toggle_off() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

### #default_web_grounding_toggle_off=

    def default_web_grounding_toggle_off=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
**Returns**

- (::Boolean) --- Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
**Returns**

- (::String) --- Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- Required. The assistant display name.

  It must be a UTF-8 encoded string with a length limit of 128 characters.

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The assistant display name.


  It must be a UTF-8 encoded string with a length limit of 128 characters.
**Returns**

- (::String) --- Required. The assistant display name.

  It must be a UTF-8 encoded string with a length limit of 128 characters.

### #enabled_tools

    def enabled_tools() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::ToolList}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::ToolList}) --- Optional. Note: not implemented yet. Use \[enabled_actions\]\[google.cloud.discoveryengine.v1beta.Assistant.enabled_actions\] instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": \[(toolId1, "createTicket"), (toolId2, "transferTicket")\], "gmail1ConnectorName": \[(toolId3, "sendEmail"),..\] }

### #enabled_tools=

    def enabled_tools=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::ToolList}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::ToolList}) --- Optional. Note: not implemented yet. Use \[enabled_actions\]\[google.cloud.discoveryengine.v1beta.Assistant.enabled_actions\] instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": \[(toolId1, "createTicket"), (toolId2, "transferTicket")\], "gmail1ConnectorName": \[(toolId3, "sendEmail"),..\] }
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::ToolList}) --- Optional. Note: not implemented yet. Use \[enabled_actions\]\[google.cloud.discoveryengine.v1beta.Assistant.enabled_actions\] instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": \[(toolId1, "createTicket"), (toolId2, "transferTicket")\], "gmail1ConnectorName": \[(toolId3, "sendEmail"),..\] }

### #generation_config

    def generation_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::GenerationConfig

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::GenerationConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-GenerationConfig)) --- Optional. Configuration for the generation of the assistant response.

### #generation_config=

    def generation_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::GenerationConfig

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::GenerationConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-GenerationConfig)) --- Optional. Configuration for the generation of the assistant response.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::GenerationConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-GenerationConfig)) --- Optional. Configuration for the generation of the assistant response.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`


  It must be a UTF-8 encoded string with a length limit of 1024 characters.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`


  It must be a UTF-8 encoded string with a length limit of 1024 characters.
**Returns**

- (::String) --- Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`


  It must be a UTF-8 encoded string with a length limit of 1024 characters.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Protobuf-Timestamp)) --- Output only. Represents the time when this Assistant was most recently updated.

### #web_grounding_type

    def web_grounding_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::WebGroundingType

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::WebGroundingType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-WebGroundingType)) --- Optional. The type of web grounding to use.

### #web_grounding_type=

    def web_grounding_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Assistant::WebGroundingType

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::WebGroundingType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-WebGroundingType)) --- Optional. The type of web grounding to use.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::Assistant::WebGroundingType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Assistant-WebGroundingType)) --- Optional. The type of web grounding to use.