Class: Google::Cloud::Dialogflow::V2::AgentCoachingInstruction

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb

Overview

Agent Coaching instructions that customer can configure.

Defined Under Namespace

Modules: TriggerEvent Classes: DuplicateCheckResult

Instance Attribute Summary collapse

Instance Attribute Details

#agent_action ⇒ ::String

Returns Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty.

Returns:

  • (::String) —

    Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#condition ⇒ ::String

Returns Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.

Returns:

  • (::String) —

    Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#display_details ⇒ ::String

Returns Optional. The detailed description of this instruction.

Returns:

  • (::String) —

    Optional. The detailed description of this instruction.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#display_name ⇒ ::String

Returns Optional. Display name for the instruction.

Returns:

  • (::String) —

    Optional. Display name for the instruction.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#duplicate_check_result ⇒ ::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult (readonly)

Returns Output only. Duplication check for the AgentCoachingInstruction.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#system_action ⇒ ::String

Returns Optional. The action that system should take. For example, "call GetOrderTime with order_number=number provided by the customer". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty.

Returns:

  • (::String) —

    Optional. The action that system should take. For example, "call GetOrderTime with order_number=number provided by the customer". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end

#triggering_event ⇒ ::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::TriggerEvent

Returns Optional. The event that should trigger this instruction. If UNSPECIFIED, the instruction triggering will be same as the generator's trigger_event.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb', line 55

class AgentCoachingInstruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Duplication check for the suggestion.
  # @!attribute [r] duplicate_suggestions
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::AgentCoachingInstruction::DuplicateCheckResult::DuplicateSuggestion>]
  #     Output only. The duplicate suggestions.
  class DuplicateCheckResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The duplicate suggestion details.
    # @!attribute [r] answer_record
    #   @return [::String]
    #     Output only. The answer record id of the past duplicate suggestion.
    # @!attribute [r] suggestion_index
    #   @return [::Integer]
    #     Output only. The index of the duplicate suggestion in the past
    #     suggestion list.
    # @!attribute [r] similarity_score
    #   @return [::Float]
    #     Output only. The similarity score of between the past and current
    #     suggestion.
    class DuplicateSuggestion
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The event that should trigger this instruction.
  module TriggerEvent
    # Default value for TriggerEvent.
    TRIGGER_EVENT_UNSPECIFIED = 0

    # Triggers when each chat message or voice utterance ends.
    END_OF_UTTERANCE = 1

    # Triggers on the conversation manually by API calls.
    MANUAL_CALL = 2

    # Triggers after each customer message.
    CUSTOMER_MESSAGE = 3

    # Triggers after each agent message.
    AGENT_MESSAGE = 4

    # Triggers on tool call completion.
    TOOL_CALL_COMPLETION = 5
  end
end