Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer

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

Overview

An answer from Knowledge Connector.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer

Returns a new instance of GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer.



14761
14762
14763
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14761

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) 


14728
14729
14730
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14728

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) 


14734
14735
14736
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14734

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) 


14744
14745
14746
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14744

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 `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 propertymatchConfidenceLevel`

Returns:

  • (String) 


14753
14754
14755
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14753

def match_confidence_level
  @match_confidence_level
end

#source ⇒ String

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

Returns:

  • (String) 


14759
14760
14761
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14759

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14766
14767
14768
14769
14770
14771
14772
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14766

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