0.20.1 (latest) 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.12 0.12.3 0.11.14 0.10.0 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.1 0.1.1

    Assistant(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Discovery Engine Assistant resource.

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `name` | `str` 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. |
| `display_name` | `str` Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. |
| `description` | `str` Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. |
| `generation_config` | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.Assistant.GenerationConfig` Optional. Configuration for the generation of the assistant response. |
| `web_grounding_type` | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.Assistant.WebGroundingType` Optional. The type of web grounding to use. |
| `default_web_grounding_toggle_off` | `bool` 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. |
| `enabled_tools` | `MutableMapping[str, https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.Assistant.ToolList]` Optional. Note: not implemented yet. Use 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"),..\] } |
| `customer_policy` | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.types.Assistant.CustomerPolicy` Optional. Customer policy for the assistant. |
| `create_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Represents the time when this Assistant was created. |
| `update_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. Represents the time when this Assistant was most recently updated. |

## Classes

### CustomerPolicy

    CustomerPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Customer-defined policy for the assistant.

### EnabledToolsEntry

    EnabledToolsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `kwargs` | `dict` Keys and values corresponding to the fields of the message. |
| `mapping` | ``Union[dict, `.Message`]`` A dictionary or message to be used to determine the values for this message. |
| `ignore_unknown_fields` | `Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters. |

### GenerationConfig

    GenerationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for the generation of the assistant response.

### ToolInfo

    ToolInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information to identify a tool.

### ToolList

    ToolList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The enabled tools on a connector

### WebGroundingType

    WebGroundingType(value)

The type of web grounding to use.