Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb

Overview

An answer from Knowledge Connector.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer

Returns a new instance of GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer



4232
4233
4234
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4232

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#answerString

The piece of text from the source knowledge base document that answers this conversational query. Corresponds to the JSON property answer

Returns:

  • (String)


4195
4196
4197
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4195

def answer
  @answer
end

#faq_questionString

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise. Corresponds to the JSON property faqQuestion

Returns:

  • (String)


4201
4202
4203
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4201

def faq_question
  @faq_question
end

#match_confidenceFloat

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable. Corresponds to the JSON property matchConfidence

Returns:

  • (Float)


4212
4213
4214
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4212

def match_confidence
  @match_confidence
end

#match_confidence_levelString

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer. Corresponds to the JSON property matchConfidenceLevel

Returns:

  • (String)


4223
4224
4225
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4223

def match_confidence_level
  @match_confidence_level
end

#sourceString

Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>. Corresponds to the JSON property source

Returns:

  • (String)


4230
4231
4232
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4230

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4237
4238
4239
4240
4241
4242
4243
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4237

def update!(**args)
  @answer = args[:answer] if args.key?(:answer)
  @faq_question = args[:faq_question] if args.key?(:faq_question)
  @match_confidence = args[:match_confidence] if args.key?(:match_confidence)
  @match_confidence_level = args[:match_confidence_level] if args.key?(:match_confidence_level)
  @source = args[:source] if args.key?(:source)
end