Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class SuggestionConfig.
Detail human agent assistant config.
Generated from protobuf message google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig
Namespace
Google \ Cloud \ Dialogflow \ V2 \ HumanAgentAssistantConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ feature_configs |
array<SuggestionFeatureConfig>
Configuration of different suggestion features. One feature can have only one config. |
↳ group_suggestion_responses |
bool
If |
↳ generators |
string[]
Optional. List of various generator resource names used in the conversation profile. |
↳ disable_high_latency_features_sync_delivery |
bool
Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST |
↳ skip_empty_event_based_suggestion |
bool
Optional. Enable skipping event based suggestion if the suggestion is empty. For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation. |
↳ use_unredacted_conversation_data |
bool
Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features) |
↳ enable_async_tool_call |
bool
Optional. Deprecated: This field is not consulted for tool execution. Configure asynchronous execution per tool using CesToolSpec.async_execution or ToolsetTool.async_execution instead. |
↳ companion_agent |
string
Optional. The resource name of the companion agent to link. This is only supported for |
getFeatureConfigs
Configuration of different suggestion features. One feature can have only one config.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<SuggestionFeatureConfig> |
|
setFeatureConfigs
Configuration of different suggestion features. One feature can have only one config.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SuggestionFeatureConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroupSuggestionResponses
If group_suggestion_responses is false, and there are multiple
feature_configs in event based suggestion or
StreamingAnalyzeContent, we will try to deliver suggestions to customers
as soon as we get new suggestion. Different type of suggestions based on
the same context will be in separate Pub/Sub event or
StreamingAnalyzeContentResponse.
If group_suggestion_responses set to true. All the suggestions to the
same participant based on the same context will be grouped into a single
Pub/Sub event or StreamingAnalyzeContentResponse.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setGroupSuggestionResponses
If group_suggestion_responses is false, and there are multiple
feature_configs in event based suggestion or
StreamingAnalyzeContent, we will try to deliver suggestions to customers
as soon as we get new suggestion. Different type of suggestions based on
the same context will be in separate Pub/Sub event or
StreamingAnalyzeContentResponse.
If group_suggestion_responses set to true. All the suggestions to the
same participant based on the same context will be grouped into a single
Pub/Sub event or StreamingAnalyzeContentResponse.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGenerators
Optional. List of various generator resource names used in the conversation profile.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setGenerators
Optional. List of various generator resource names used in the conversation profile.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisableHighLatencyFeaturesSyncDelivery
Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableHighLatencyFeaturesSyncDelivery
Optional. When disable_high_latency_features_sync_delivery is true and using the AnalyzeContent API, we will not deliver the responses from high latency features in the API response. The human_agent_assistant_config.notification_config must be configured and enable_event_based_suggestion must be set to true to receive the responses from high latency features in Pub/Sub. High latency feature(s): KNOWLEDGE_ASSIST
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkipEmptyEventBasedSuggestion
Optional. Enable skipping event based suggestion if the suggestion is empty.
For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSkipEmptyEventBasedSuggestion
Optional. Enable skipping event based suggestion if the suggestion is empty.
For example, with this field disabled, Knowledge Assist feature sends a Pub/Sub message when there are no suggestions. Enabling this field will change the behavior to skip the Pub/Sub message in this situation.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseUnredactedConversationData
Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUseUnredactedConversationData
Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableAsyncToolCall
Optional. Deprecated: This field is not consulted for tool execution.
Configure asynchronous execution per tool using CesToolSpec.async_execution or ToolsetTool.async_execution instead.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableAsyncToolCall
Optional. Deprecated: This field is not consulted for tool execution.
Configure asynchronous execution per tool using CesToolSpec.async_execution or ToolsetTool.async_execution instead.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCompanionAgent
Optional. The resource name of the companion agent to link.
This is only supported for human_agent_suggestion_config.
Format:
projects/{project}/locations/{location}/companionAgents/{companion_agent}
| Returns | |
|---|---|
| Type | Description |
string |
|
setCompanionAgent
Optional. The resource name of the companion agent to link.
This is only supported for human_agent_suggestion_config.
Format:
projects/{project}/locations/{location}/companionAgents/{companion_agent}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|