Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb

Overview

Config for suggestion features.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig

Returns a new instance of GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionFeatureConfig.



12640
12641
12642
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12640

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conversation_model_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationModelConfig

Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION Corresponds to the JSON property conversationModelConfig

Returns:



12563
12564
12565
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12563

def conversation_model_config
  @conversation_model_config
end

#conversation_process_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigConversationProcessConfig

Config to process conversation. Corresponds to the JSON property conversationProcessConfig

Returns:



12568
12569
12570
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12568

def conversation_process_config
  @conversation_process_config
end

#disable_agent_query_logging ⇒ Boolean Also known as: disable_agent_query_logging?

Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH. Corresponds to the JSON property disableAgentQueryLogging

Returns:

  • (Boolean) 


12575
12576
12577
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12575

def disable_agent_query_logging
  @disable_agent_query_logging
end

#enable_conversation_augmented_query ⇒ Boolean Also known as: enable_conversation_augmented_query?

Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH. Corresponds to the JSON property enableConversationAugmentedQuery

Returns:

  • (Boolean) 


12582
12583
12584
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12582

def enable_conversation_augmented_query
  @enable_conversation_augmented_query
end

#enable_event_based_suggestion ⇒ Boolean Also known as: enable_event_based_suggestion?

Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST. Corresponds to the JSON property enableEventBasedSuggestion

Returns:

  • (Boolean) 


12590
12591
12592
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12590

def enable_event_based_suggestion
  @enable_event_based_suggestion
end

#enable_query_suggestion_only ⇒ Boolean Also known as: enable_query_suggestion_only?

Optional. Enable query suggestion only. Supported features: KNOWLEDGE_ASSIST Corresponds to the JSON property enableQuerySuggestionOnly

Returns:

  • (Boolean) 


12596
12597
12598
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12596

def enable_query_suggestion_only
  @enable_query_suggestion_only
end

#enable_query_suggestion_when_no_answer ⇒ Boolean Also known as: enable_query_suggestion_when_no_answer?

Optional. Enable query suggestion even if we can't find its answer. By default, queries are suggested only if we find its answer. Supported features: KNOWLEDGE_ASSIST Corresponds to the JSON property enableQuerySuggestionWhenNoAnswer

Returns:

  • (Boolean) 


12604
12605
12606
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12604

def enable_query_suggestion_when_no_answer
  @enable_query_suggestion_when_no_answer
end

#enable_response_debug_info ⇒ Boolean Also known as: enable_response_debug_info?

Optional. Enable returning detailed reasons for suggestion results. For example, with this field disabled, Knowledge Search feature returns NotFound error when no answer is found for the input query. Enabling this field will change the behavior to return an OK response with detailed information indicating the lack of results. Supported features: KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST Corresponds to the JSON property enableResponseDebugInfo

Returns:

  • (Boolean) 


12615
12616
12617
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12615

def enable_response_debug_info
  @enable_response_debug_info
end

#query_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig

Config for suggestion query. Corresponds to the JSON property queryConfig

Returns:



12621
12622
12623
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12621

def query_config
  @query_config
end

#rai_settings ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RaiSettings

Settings for Responsible AI checks. Corresponds to the JSON property raiSettings

Returns:



12626
12627
12628
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12626

def rai_settings
  @rai_settings
end

#suggestion_feature ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestionFeature

The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list. Corresponds to the JSON property suggestionFeature

Returns:



12633
12634
12635
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12633

def suggestion_feature
  @suggestion_feature
end

#suggestion_trigger_settings ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionTriggerSettings

Settings of suggestion trigger. Corresponds to the JSON property suggestionTriggerSettings

Returns:



12638
12639
12640
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12638

def suggestion_trigger_settings
  @suggestion_trigger_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 12645

def update!(**args)
  @conversation_model_config = args[:conversation_model_config] if args.key?(:conversation_model_config)
  @conversation_process_config = args[:conversation_process_config] if args.key?(:conversation_process_config)
  @disable_agent_query_logging = args[:disable_agent_query_logging] if args.key?(:disable_agent_query_logging)
  @enable_conversation_augmented_query = args[:enable_conversation_augmented_query] if args.key?(:enable_conversation_augmented_query)
  @enable_event_based_suggestion = args[:enable_event_based_suggestion] if args.key?(:enable_event_based_suggestion)
  @enable_query_suggestion_only = args[:enable_query_suggestion_only] if args.key?(:enable_query_suggestion_only)
  @enable_query_suggestion_when_no_answer = args[:enable_query_suggestion_when_no_answer] if args.key?(:enable_query_suggestion_when_no_answer)
  @enable_response_debug_info = args[:enable_response_debug_info] if args.key?(:enable_response_debug_info)
  @query_config = args[:query_config] if args.key?(:query_config)
  @rai_settings = args[:rai_settings] if args.key?(:rai_settings)
  @suggestion_feature = args[:suggestion_feature] if args.key?(:suggestion_feature)
  @suggestion_trigger_settings = args[:suggestion_trigger_settings] if args.key?(:suggestion_trigger_settings)
end