Class: Google::Cloud::Dialogflow::V2::AgentAssistantFeedback

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

Overview

Detail feedback of Agent Assist result.

Defined Under Namespace

Modules: AnswerRelevance, DocumentCorrectness, DocumentEfficiency Classes: SummarizationFeedback

Instance Attribute Summary collapse

Instance Attribute Details

#answer_relevance ⇒ ::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::AnswerRelevance

Returns Optional. Whether or not the suggested answer is relevant.

For example:

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'proto_docs/google/cloud/dialogflow/v2/answer_record.rb', line 207

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

  # Feedback for conversation summarization.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when composing of the summary starts.
  # @!attribute [rw] submit_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when the summary was submitted.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     Text of actual submitted summary.
  class SummarizationFeedback
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Relevance of an answer.
  module AnswerRelevance
    # Answer relevance unspecified.
    ANSWER_RELEVANCE_UNSPECIFIED = 0

    # Answer is irrelevant to query.
    IRRELEVANT = 1

    # Answer is relevant to query.
    RELEVANT = 2
  end

  # Correctness of document.
  module DocumentCorrectness
    # Document correctness unspecified.
    DOCUMENT_CORRECTNESS_UNSPECIFIED = 0

    # Information in document is incorrect.
    INCORRECT = 1

    # Information in document is correct.
    CORRECT = 2
  end

  # Efficiency of document.
  module DocumentEfficiency
    # Document efficiency unspecified.
    DOCUMENT_EFFICIENCY_UNSPECIFIED = 0

    # Document is inefficient.
    INEFFICIENT = 1

    # Document is efficient.
    EFFICIENT = 2
  end
end

#document_correctness ⇒ ::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentCorrectness

Returns Optional. Whether or not the information in the document is correct.

For example:

  • Query: "Can I return the package in 2 days once received?"
  • Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date."
  • Ground truth: "No return or exchange is allowed."
  • [document_correctness]: INCORRECT.

Returns:

  • (::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentCorrectness) —

    Optional. Whether or not the information in the document is correct.

    For example:

    • Query: "Can I return the package in 2 days once received?"
    • Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date."
    • Ground truth: "No return or exchange is allowed."
    • [document_correctness]: INCORRECT


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'proto_docs/google/cloud/dialogflow/v2/answer_record.rb', line 207

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

  # Feedback for conversation summarization.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when composing of the summary starts.
  # @!attribute [rw] submit_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when the summary was submitted.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     Text of actual submitted summary.
  class SummarizationFeedback
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Relevance of an answer.
  module AnswerRelevance
    # Answer relevance unspecified.
    ANSWER_RELEVANCE_UNSPECIFIED = 0

    # Answer is irrelevant to query.
    IRRELEVANT = 1

    # Answer is relevant to query.
    RELEVANT = 2
  end

  # Correctness of document.
  module DocumentCorrectness
    # Document correctness unspecified.
    DOCUMENT_CORRECTNESS_UNSPECIFIED = 0

    # Information in document is incorrect.
    INCORRECT = 1

    # Information in document is correct.
    CORRECT = 2
  end

  # Efficiency of document.
  module DocumentEfficiency
    # Document efficiency unspecified.
    DOCUMENT_EFFICIENCY_UNSPECIFIED = 0

    # Document is inefficient.
    INEFFICIENT = 1

    # Document is efficient.
    EFFICIENT = 2
  end
end

#document_efficiency ⇒ ::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::DocumentEfficiency

Returns Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'proto_docs/google/cloud/dialogflow/v2/answer_record.rb', line 207

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

  # Feedback for conversation summarization.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when composing of the summary starts.
  # @!attribute [rw] submit_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when the summary was submitted.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     Text of actual submitted summary.
  class SummarizationFeedback
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Relevance of an answer.
  module AnswerRelevance
    # Answer relevance unspecified.
    ANSWER_RELEVANCE_UNSPECIFIED = 0

    # Answer is irrelevant to query.
    IRRELEVANT = 1

    # Answer is relevant to query.
    RELEVANT = 2
  end

  # Correctness of document.
  module DocumentCorrectness
    # Document correctness unspecified.
    DOCUMENT_CORRECTNESS_UNSPECIFIED = 0

    # Information in document is incorrect.
    INCORRECT = 1

    # Information in document is correct.
    CORRECT = 2
  end

  # Efficiency of document.
  module DocumentEfficiency
    # Document efficiency unspecified.
    DOCUMENT_EFFICIENCY_UNSPECIFIED = 0

    # Document is inefficient.
    INEFFICIENT = 1

    # Document is efficient.
    EFFICIENT = 2
  end
end

#summarization_feedback ⇒ ::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::SummarizationFeedback

Returns Optional. Feedback for conversation summarization.

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'proto_docs/google/cloud/dialogflow/v2/answer_record.rb', line 207

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

  # Feedback for conversation summarization.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when composing of the summary starts.
  # @!attribute [rw] submit_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Timestamp when the summary was submitted.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     Text of actual submitted summary.
  class SummarizationFeedback
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Relevance of an answer.
  module AnswerRelevance
    # Answer relevance unspecified.
    ANSWER_RELEVANCE_UNSPECIFIED = 0

    # Answer is irrelevant to query.
    IRRELEVANT = 1

    # Answer is relevant to query.
    RELEVANT = 2
  end

  # Correctness of document.
  module DocumentCorrectness
    # Document correctness unspecified.
    DOCUMENT_CORRECTNESS_UNSPECIFIED = 0

    # Information in document is incorrect.
    INCORRECT = 1

    # Information in document is correct.
    CORRECT = 2
  end

  # Efficiency of document.
  module DocumentEfficiency
    # Document efficiency unspecified.
    DOCUMENT_EFFICIENCY_UNSPECIFIED = 0

    # Document is inefficient.
    INEFFICIENT = 1

    # Document is efficient.
    EFFICIENT = 2
  end
end