Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Assistant.
Discovery Engine Assistant resource.
Generated from protobuf message google.cloud.discoveryengine.v1.Assistant
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Resource name of the assistant. Format: |
↳ display_name |
string
Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. |
↳ description |
string
Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. |
↳ generation_config |
Assistant\GenerationConfig
Optional. Configuration for the generation of the assistant response. |
↳ web_grounding_type |
int
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 |
↳ enabled_tools |
array|Google\Protobuf\Internal\MapField
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 |
Assistant\CustomerPolicy
Optional. Customer policy for the assistant. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Represents the time when this Assistant was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Represents the time when this Assistant was most recently updated. |
getName
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 | |
|---|---|
| Type | Description |
string |
|
setName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The assistant display name.
It must be a UTF-8 encoded string with a length limit of 128 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The assistant display name.
It must be a UTF-8 encoded string with a length limit of 128 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGenerationConfig
Optional. Configuration for the generation of the assistant response.
| Returns | |
|---|---|
| Type | Description |
Assistant\GenerationConfig|null |
|
hasGenerationConfig
clearGenerationConfig
setGenerationConfig
Optional. Configuration for the generation of the assistant response.
| Parameter | |
|---|---|
| Name | Description |
var |
Assistant\GenerationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWebGroundingType
Optional. The type of web grounding to use.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type WebGroundingType. |
setWebGroundingType
Optional. The type of web grounding to use.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type WebGroundingType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultWebGroundingToggleOff
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 | |
|---|---|
| Type | Description |
bool |
|
setDefaultWebGroundingToggleOff
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnabledTools
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"),..] }
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setEnabledTools
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"),..] }
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomerPolicy
Optional. Customer policy for the assistant.
| Returns | |
|---|---|
| Type | Description |
Assistant\CustomerPolicy|null |
|
hasCustomerPolicy
clearCustomerPolicy
setCustomerPolicy
Optional. Customer policy for the assistant.
| Parameter | |
|---|---|
| Name | Description |
var |
Assistant\CustomerPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Represents the time when this Assistant was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Represents the time when this Assistant was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Represents the time when this Assistant was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Represents the time when this Assistant was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|