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



3762
3763
3764
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3762

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) 


3725
3726
3727
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3725

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) 


3731
3732
3733
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3731

def faq_question
  @faq_question
end

#match_confidence ⇒ Float

The system's confidence score that this Knowledge answer is a good match for this converstational query, range 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, we may deprecate it in the future. We recommend using match_confidence_level which should be generally more stable. Corresponds to the JSON property matchConfidence

Returns:

  • (Float) 


3742
3743
3744
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3742

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) 


3753
3754
3755
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3753

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) 


3760
3761
3762
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3760

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3767
3768
3769
3770
3771
3772
3773
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3767

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