Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig

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

Overview

Config for suggestion query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig

Returns a new instance of GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig.



14192
14193
14194
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14192

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 is default 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) 


14149
14150
14151
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14149

def confidence_threshold
  @confidence_threshold
end

#context_filter_settings ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings

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

Returns:



14155
14156
14157
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14155

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) 


14161
14162
14163
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14161

def context_size
  @context_size
end

#dialogflow_query_source ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource

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

Returns:



14167
14168
14169
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14167

def dialogflow_query_source
  @dialogflow_query_source
end

#document_query_source ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource

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

Returns:



14172
14173
14174
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14172

def document_query_source
  @document_query_source
end

#knowledge_base_query_source ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource

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

Returns:



14177
14178
14179
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14177

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) 


14183
14184
14185
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14183

def max_results
  @max_results
end

#sections ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigSections

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:



14190
14191
14192
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14190

def sections
  @sections
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 14197

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