Class: Google::Cloud::Dialogflow::CX::V3::ConversationTurn

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

Overview

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

Defined Under Namespace

Classes: UserInput, VirtualAgentOutput

Instance Attribute Summary collapse

Instance Attribute Details

#user_input ⇒ ::Google::Cloud::Dialogflow::CX::V3::ConversationTurn::UserInput

Returns The user input.

Returns:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 122

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

  # The input from the human user.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
  #     Supports {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text text input},
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryInput#event event input}, [dtmf
  #     input][google.cloud.dialogflow.cx.v3.QueryInput.dtmf] in the test case.
  # @!attribute [rw] injected_parameters
  #   @return [::Google::Protobuf::Struct]
  #     Parameters that need to be injected into the conversation during intent
  #     detection.
  # @!attribute [rw] is_webhook_enabled
  #   @return [::Boolean]
  #     If webhooks should be allowed to trigger in response to the user
  #     utterance. Often if parameters are injected, webhooks should not be
  #     enabled.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Whether sentiment analysis is enabled.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output from the virtual agent.
  # @!attribute [rw] session_parameters
  #   @return [::Google::Protobuf::Struct]
  #     The session parameters available to the bot at this point.
  # @!attribute [r] differences
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestRunDifference>]
  #     Output only. If this is part of a [result conversation
  #     turn][TestCaseResult.conversation_turns], the list of differences
  #     between the original run and the replay for this output, if any.
  # @!attribute [rw] diagnostic_info
  #   @return [::Google::Protobuf::Struct]
  #     Required. Input only. The diagnostic
  #     [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
  #     output for the turn. Required to calculate the testing coverage.
  # @!attribute [rw] triggered_intent
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that triggered the
  #     response. Only name and displayName will be set.
  # @!attribute [rw] current_page
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Page Page} on which the utterance was
  #     spoken. Only name and displayName will be set.
  # @!attribute [rw] text_responses
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text>]
  #     The {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text text} responses
  #     from the agent for the turn.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     Response error from the agent in the test result. If set, other output
  #     is empty.
  class VirtualAgentOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#virtual_agent_output ⇒ ::Google::Cloud::Dialogflow::CX::V3::ConversationTurn::VirtualAgentOutput

Returns The virtual agent output.

Returns:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb', line 122

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

  # The input from the human user.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
  #     Supports {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text text input},
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryInput#event event input}, [dtmf
  #     input][google.cloud.dialogflow.cx.v3.QueryInput.dtmf] in the test case.
  # @!attribute [rw] injected_parameters
  #   @return [::Google::Protobuf::Struct]
  #     Parameters that need to be injected into the conversation during intent
  #     detection.
  # @!attribute [rw] is_webhook_enabled
  #   @return [::Boolean]
  #     If webhooks should be allowed to trigger in response to the user
  #     utterance. Often if parameters are injected, webhooks should not be
  #     enabled.
  # @!attribute [rw] enable_sentiment_analysis
  #   @return [::Boolean]
  #     Whether sentiment analysis is enabled.
  class UserInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The output from the virtual agent.
  # @!attribute [rw] session_parameters
  #   @return [::Google::Protobuf::Struct]
  #     The session parameters available to the bot at this point.
  # @!attribute [r] differences
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestRunDifference>]
  #     Output only. If this is part of a [result conversation
  #     turn][TestCaseResult.conversation_turns], the list of differences
  #     between the original run and the replay for this output, if any.
  # @!attribute [rw] diagnostic_info
  #   @return [::Google::Protobuf::Struct]
  #     Required. Input only. The diagnostic
  #     [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
  #     output for the turn. Required to calculate the testing coverage.
  # @!attribute [rw] triggered_intent
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that triggered the
  #     response. Only name and displayName will be set.
  # @!attribute [rw] current_page
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
  #     The {::Google::Cloud::Dialogflow::CX::V3::Page Page} on which the utterance was
  #     spoken. Only name and displayName will be set.
  # @!attribute [rw] text_responses
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text>]
  #     The {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text text} responses
  #     from the agent for the turn.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     Response error from the agent in the test result. If set, other output
  #     is empty.
  class VirtualAgentOutput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end