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>.



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1254

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.
  #
  #     Note: The following fields are mutually exclusive: `faq_source`, `generative_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  #
  #     Note: The following fields are mutually exclusive: `generative_source`, `faq_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1254

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.
  #
  #     Note: The following fields are mutually exclusive: `faq_source`, `generative_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  #
  #     Note: The following fields are mutually exclusive: `generative_source`, `faq_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1254

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.
  #
  #     Note: The following fields are mutually exclusive: `faq_source`, `generative_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] generative_source
  #   @return [::Google::Cloud::Dialogflow::V2::KnowledgeAssistAnswer::KnowledgeAnswer::GenerativeSource]
  #     Populated if the prediction was Generative.
  #
  #     Note: The following fields are mutually exclusive: `generative_source`, `faq_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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