Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig (v1.18.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionConfig.

Detail human agent assistant config.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#companion_agent

def companion_agent() -> ::String
Returns
  • (::String) — 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}

#companion_agent=

def companion_agent=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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}

#disable_high_latency_features_sync_delivery

def disable_high_latency_features_sync_delivery() -> ::Boolean
Returns
  • (::Boolean) — 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

#disable_high_latency_features_sync_delivery=

def disable_high_latency_features_sync_delivery=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

#enable_async_tool_call

def enable_async_tool_call() -> ::Boolean
Returns
  • (::Boolean) — Optional. Deprecated: This field is not consulted for tool execution. Configure asynchronous execution per tool using [CesToolSpec.async_execution][google.cloud.dialogflow.v2.CesToolSpec.async_execution] or [ToolsetTool.async_execution][google.cloud.dialogflow.v2.ToolsetTool.async_execution] instead.

#enable_async_tool_call=

def enable_async_tool_call=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Deprecated: This field is not consulted for tool execution. Configure asynchronous execution per tool using [CesToolSpec.async_execution][google.cloud.dialogflow.v2.CesToolSpec.async_execution] or [ToolsetTool.async_execution][google.cloud.dialogflow.v2.ToolsetTool.async_execution] instead.
Returns
  • (::Boolean) — Optional. Deprecated: This field is not consulted for tool execution. Configure asynchronous execution per tool using [CesToolSpec.async_execution][google.cloud.dialogflow.v2.CesToolSpec.async_execution] or [ToolsetTool.async_execution][google.cloud.dialogflow.v2.ToolsetTool.async_execution] instead.

#feature_configs

def feature_configs() -> ::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>
Returns

#feature_configs=

def feature_configs=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig>
Parameter
Returns

#generators

def generators() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of various generator resource names used in the conversation profile.

#generators=

def generators=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of various generator resource names used in the conversation profile.
Returns
  • (::Array<::String>) — Optional. List of various generator resource names used in the conversation profile.

#group_suggestion_responses

def group_suggestion_responses() -> ::Boolean
Returns
  • (::Boolean) — 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.

#group_suggestion_responses=

def group_suggestion_responses=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#skip_empty_event_based_suggestion

def skip_empty_event_based_suggestion() -> ::Boolean
Returns
  • (::Boolean) — 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.

#skip_empty_event_based_suggestion=

def skip_empty_event_based_suggestion=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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

def use_unredacted_conversation_data() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)

#use_unredacted_conversation_data=

def use_unredacted_conversation_data=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)
Returns
  • (::Boolean) — Optional. If true, use unredacted transcript data (Supported features: AI_COACH) and use unredacted ingested context (Supported features: All Agent Assist features)