Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer
- 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
-
#answer ⇒ String
The piece of text from the
source
knowledge base document that answers this conversational query. -
#faq_question ⇒ String
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
-
#match_confidence ⇒ Float
The system's confidence score that this Knowledge answer is a good match for this conversational query.
-
#match_confidence_level ⇒ String
The system's confidence level that this knowledge answer is a good match for this conversational query.
-
#source ⇒ String
Indicates which Knowledge Document this answer was extracted from.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer
constructor
A new instance of GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer
Returns a new instance of GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer
4619 4620 4621 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4619 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
4582 4583 4584 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4582 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
4588 4589 4590 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4588 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
4599 4600 4601 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4599 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
4610 4611 4612 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4610 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
4617 4618 4619 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4617 def source @source end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4624 4625 4626 4627 4628 4629 4630 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4624 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 |