Class: Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer

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

Overview

Represents a Knowledge Assist answer.

Defined Under Namespace

Classes: KnowledgeAnswer, SuggestedQuery

Instance Attribute Summary collapse

Instance Attribute Details

#answer_record ⇒ ::String

Returns The name of the answer record. Format: projects/<Project ID>/locations/<location ID>/answer Records/<Answer Record ID>.

Returns:

  • (::String) —

    The name of the answer record. Format: projects/<Project ID>/locations/<location ID>/answer Records/<Answer Record ID>.



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1094

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

  # Represents a suggested query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     Suggested query text.
  class SuggestedQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an answer from Knowledge. Currently supports FAQ and Generative
  # answers.
  # @!attribute [rw] answer_text
  #   @return [::String]
  #     The piece of text from the `source` that answers this suggested query.
  # @!attribute [rw] faq_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::FaqSource]
  #     Populated if the prediction came from FAQ.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  class KnowledgeAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Details about source of FAQ answer.
    # @!attribute [rw] question
    #   @return [::String]
    #     The corresponding FAQ question.
    class FaqSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Details about source of Generative answer.
    # @!attribute [rw] snippets
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource::Snippet>]
    #     All snippets used for this Generative Prediction, with their source URI
    #     and data.
    class GenerativeSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Snippet Source for a Generative Prediction.
      # @!attribute [rw] uri
      #   @return [::String]
      #     URI the data is sourced from.
      # @!attribute [rw] text
      #   @return [::String]
      #     Text taken from that URI.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the document.
      # @!attribute [rw] metadata
      #   @return [::Google::Protobuf::Struct]
      #     Metadata of the document.
      class Snippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#suggested_query ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::SuggestedQuery

Returns The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.

Returns:



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1094

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

  # Represents a suggested query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     Suggested query text.
  class SuggestedQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an answer from Knowledge. Currently supports FAQ and Generative
  # answers.
  # @!attribute [rw] answer_text
  #   @return [::String]
  #     The piece of text from the `source` that answers this suggested query.
  # @!attribute [rw] faq_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::FaqSource]
  #     Populated if the prediction came from FAQ.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  class KnowledgeAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Details about source of FAQ answer.
    # @!attribute [rw] question
    #   @return [::String]
    #     The corresponding FAQ question.
    class FaqSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Details about source of Generative answer.
    # @!attribute [rw] snippets
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource::Snippet>]
    #     All snippets used for this Generative Prediction, with their source URI
    #     and data.
    class GenerativeSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Snippet Source for a Generative Prediction.
      # @!attribute [rw] uri
      #   @return [::String]
      #     URI the data is sourced from.
      # @!attribute [rw] text
      #   @return [::String]
      #     Text taken from that URI.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the document.
      # @!attribute [rw] metadata
      #   @return [::Google::Protobuf::Struct]
      #     Metadata of the document.
      class Snippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#suggested_query_answer ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer

Returns The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query.

Returns:



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1094

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

  # Represents a suggested query.
  # @!attribute [rw] query_text
  #   @return [::String]
  #     Suggested query text.
  class SuggestedQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an answer from Knowledge. Currently supports FAQ and Generative
  # answers.
  # @!attribute [rw] answer_text
  #   @return [::String]
  #     The piece of text from the `source` that answers this suggested query.
  # @!attribute [rw] faq_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::FaqSource]
  #     Populated if the prediction came from FAQ.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  class KnowledgeAnswer
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Details about source of FAQ answer.
    # @!attribute [rw] question
    #   @return [::String]
    #     The corresponding FAQ question.
    class FaqSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Details about source of Generative answer.
    # @!attribute [rw] snippets
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource::Snippet>]
    #     All snippets used for this Generative Prediction, with their source URI
    #     and data.
    class GenerativeSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Snippet Source for a Generative Prediction.
      # @!attribute [rw] uri
      #   @return [::String]
      #     URI the data is sourced from.
      # @!attribute [rw] text
      #   @return [::String]
      #     Text taken from that URI.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the document.
      # @!attribute [rw] metadata
      #   @return [::Google::Protobuf::Struct]
      #     Metadata of the document.
      class Snippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end