Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3TurnSignals

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

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) ⇒ GoogleCloudDialogflowCxV3TurnSignals

Returns a new instance of GoogleCloudDialogflowCxV3TurnSignals.



2608
2609
2610
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2608

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

Instance Attribute Details

#agent_escalatedBoolean Also known as: agent_escalated?

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

Returns:

  • (Boolean)


2553
2554
2555
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2553

def agent_escalated
  @agent_escalated
end

#dtmf_usedBoolean Also known as: dtmf_used?

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

Returns:

  • (Boolean)


2559
2560
2561
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2559

def dtmf_used
  @dtmf_used
end

#failure_reasonsArray<String>

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

Returns:

  • (Array<String>)


2565
2566
2567
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2565

def failure_reasons
  @failure_reasons
end

#no_matchBoolean Also known as: no_match?

Whether NLU predicted NO_MATCH. Corresponds to the JSON property noMatch

Returns:

  • (Boolean)


2570
2571
2572
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2570

def no_match
  @no_match
end

#no_user_inputBoolean Also known as: no_user_input?

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

Returns:

  • (Boolean)


2576
2577
2578
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2576

def no_user_input
  @no_user_input
end

#reached_end_pageBoolean Also known as: reached_end_page?

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

Returns:

  • (Boolean)


2582
2583
2584
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2582

def reached_end_page
  @reached_end_page
end

#sentiment_magnitudeFloat

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

Returns:

  • (Float)


2589
2590
2591
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2589

def sentiment_magnitude
  @sentiment_magnitude
end

#sentiment_scoreFloat

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

Returns:

  • (Float)


2595
2596
2597
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2595

def sentiment_score
  @sentiment_score
end

#user_escalatedBoolean Also known as: user_escalated?

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

Returns:

  • (Boolean)


2600
2601
2602
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2600

def user_escalated
  @user_escalated
end

#webhook_statusesArray<String>

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

Returns:

  • (Array<String>)


2606
2607
2608
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2606

def webhook_statuses
  @webhook_statuses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2613

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)
  @user_escalated = args[:user_escalated] if args.key?(:user_escalated)
  @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses)
end