Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig

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 query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig

Returns a new instance of GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfig.



11134
11135
11136
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11134

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

Instance Attribute Details

#confidence_threshold ⇒ Float

Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION. Corresponds to the JSON property confidenceThreshold

Returns:

  • (Float) 


11092
11093
11094
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11092

def confidence_threshold
  @confidence_threshold
end

#context_filter_settings ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings

Settings that determine how to filter recent conversation context when generating suggestions. Corresponds to the JSON property contextFilterSettings

Returns:



11098
11099
11100
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11098

def context_filter_settings
  @context_filter_settings
end

#context_size ⇒ Fixnum

Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. Corresponds to the JSON property contextSize

Returns:

  • (Fixnum) 


11104
11105
11106
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11104

def context_size
  @context_size
end

#dialogflow_query_source ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource

Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST. Corresponds to the JSON property dialogflowQuerySource

Returns:



11109
11110
11111
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11109

def dialogflow_query_source
  @dialogflow_query_source
end

#document_query_source ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource

Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE. Corresponds to the JSON property documentQuerySource

Returns:



11114
11115
11116
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11114

def document_query_source
  @document_query_source
end

#knowledge_base_query_source ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource

Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ. Corresponds to the JSON property knowledgeBaseQuerySource

Returns:



11119
11120
11121
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11119

def knowledge_base_query_source
  @knowledge_base_query_source
end

#max_results ⇒ Fixnum

Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20. Corresponds to the JSON property maxResults

Returns:

  • (Fixnum) 


11125
11126
11127
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11125

def max_results
  @max_results
end

#sections ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigSections

Custom sections to return when requesting a summary of a conversation. This is only supported when baseline_model_version == '2.0'. Supported features: CONVERSATION_SUMMARIZATION, CONVERSATION_SUMMARIZATION_VOICE. Corresponds to the JSON property sections

Returns:



11132
11133
11134
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11132

def sections
  @sections
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11139

def update!(**args)
  @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
  @context_filter_settings = args[:context_filter_settings] if args.key?(:context_filter_settings)
  @context_size = args[:context_size] if args.key?(:context_size)
  @dialogflow_query_source = args[:dialogflow_query_source] if args.key?(:dialogflow_query_source)
  @document_query_source = args[:document_query_source] if args.key?(:document_query_source)
  @knowledge_base_query_source = args[:knowledge_base_query_source] if args.key?(:knowledge_base_query_source)
  @max_results = args[:max_results] if args.key?(:max_results)
  @sections = args[:sections] if args.key?(:sections)
end