Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV3alpha1TurnSignals

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

Overview

Collection of all signals that were extracted for a single turn of the conversation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV3alpha1TurnSignals

Returns a new instance of GoogleCloudDialogflowV3alpha1TurnSignals.



20250
20251
20252
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20250

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

Instance Attribute Details

#agent_escalated ⇒ Boolean Also known as: agent_escalated?

Whether agent responded with LiveAgentHandoff fulfillment. Corresponds to the JSON property agentEscalated

Returns:

  • (Boolean) 


20188
20189
20190
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20188

def agent_escalated
  @agent_escalated
end

#dtmf_used ⇒ Boolean Also known as: dtmf_used?

Whether user was using DTMF input. Corresponds to the JSON property dtmfUsed

Returns:

  • (Boolean) 


20194
20195
20196
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20194

def dtmf_used
  @dtmf_used
end

#failure_reasons ⇒ Array<String>

Failure reasons of the turn. Corresponds to the JSON property failureReasons

Returns:

  • (Array<String>) 


20200
20201
20202
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20200

def failure_reasons
  @failure_reasons
end

#no_match ⇒ Boolean Also known as: no_match?

Whether NLU predicted NO_MATCH. Corresponds to the JSON property noMatch

Returns:

  • (Boolean) 


20205
20206
20207
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20205

def no_match
  @no_match
end

#no_user_input ⇒ Boolean Also known as: no_user_input?

Whether user provided no input. Corresponds to the JSON property noUserInput

Returns:

  • (Boolean) 


20211
20212
20213
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20211

def no_user_input
  @no_user_input
end

#reached_end_page ⇒ Boolean Also known as: reached_end_page?

Whether turn resulted in End Session page. Corresponds to the JSON property reachedEndPage

Returns:

  • (Boolean) 


20217
20218
20219
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20217

def reached_end_page
  @reached_end_page
end

#sentiment_magnitude ⇒ Float

Sentiment magnitude of the user utterance if sentiment was enabled. Corresponds to the JSON property sentimentMagnitude

Returns:

  • (Float) 


20224
20225
20226
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20224

def sentiment_magnitude
  @sentiment_magnitude
end

#sentiment_score ⇒ Float

Sentiment score of the user utterance if sentiment was enabled. Corresponds to the JSON property sentimentScore

Returns:

  • (Float) 


20230
20231
20232
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20230

def sentiment_score
  @sentiment_score
end

#triggered_abandonment_event ⇒ Boolean Also known as: triggered_abandonment_event?

Whether agent has triggered the event corresponding to user abandoning the conversation. Corresponds to the JSON property triggeredAbandonmentEvent

Returns:

  • (Boolean) 


20236
20237
20238
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20236

def triggered_abandonment_event
  @triggered_abandonment_event
end

#user_escalated ⇒ Boolean Also known as: user_escalated?

Whether user was specifically asking for a live agent. Corresponds to the JSON property userEscalated

Returns:

  • (Boolean) 


20242
20243
20244
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20242

def user_escalated
  @user_escalated
end

#webhook_statuses ⇒ Array<String>

Human-readable statuses of the webhooks triggered during this turn. Corresponds to the JSON property webhookStatuses

Returns:

  • (Array<String>) 


20248
20249
20250
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20248

def webhook_statuses
  @webhook_statuses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 20255

def update!(**args)
  @agent_escalated = args[:agent_escalated] if args.key?(:agent_escalated)
  @dtmf_used = args[:dtmf_used] if args.key?(:dtmf_used)
  @failure_reasons = args[:failure_reasons] if args.key?(:failure_reasons)
  @no_match = args[:no_match] if args.key?(:no_match)
  @no_user_input = args[:no_user_input] if args.key?(:no_user_input)
  @reached_end_page = args[:reached_end_page] if args.key?(:reached_end_page)
  @sentiment_magnitude = args[:sentiment_magnitude] if args.key?(:sentiment_magnitude)
  @sentiment_score = args[:sentiment_score] if args.key?(:sentiment_score)
  @triggered_abandonment_event = args[:triggered_abandonment_event] if args.key?(:triggered_abandonment_event)
  @user_escalated = args[:user_escalated] if args.key?(:user_escalated)
  @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses)
end