Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/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



5081
5082
5083
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5081

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

Instance Attribute Details

#answer ⇒ String

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

Returns:

  • (String) 


5044
5045
5046
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5044

def answer
  @answer
end

#faq_question ⇒ String

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

Returns:

  • (String) 


5050
5051
5052
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5050

def faq_question
  @faq_question
end

#match_confidence ⇒ Float

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) 


5061
5062
5063
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5061

def match_confidence
  @match_confidence
end

#match_confidence_level ⇒ String

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) 


5072
5073
5074
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5072

def match_confidence_level
  @match_confidence_level
end

#source ⇒ String

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) 


5079
5080
5081
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5079

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5086
5087
5088
5089
5090
5091
5092
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5086

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