Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals.
Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#answer
def answer() -> ::String
Returns
- (::String) — Optional. The final compiled answer.
#answer=
def answer=(value) -> ::String
Parameter
- value (::String) — Optional. The final compiled answer.
Returns
- (::String) — Optional. The final compiled answer.
#answer_generation_model_call_signals
def answer_generation_model_call_signals() -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals) — Optional. Diagnostic info related to the answer generation model call.
#answer_generation_model_call_signals=
def answer_generation_model_call_signals=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals) — Optional. Diagnostic info related to the answer generation model call.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals) — Optional. Diagnostic info related to the answer generation model call.
#answer_parts
def answer_parts() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>
Returns
-
(::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>) — Optional. Answer parts with relevant citations.
Concatenation of texts should add up the
answer(not counting whitespaces).
#answer_parts=
def answer_parts=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>
Parameter
-
value (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>) — Optional. Answer parts with relevant citations.
Concatenation of texts should add up the
answer(not counting whitespaces).
Returns
-
(::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>) — Optional. Answer parts with relevant citations.
Concatenation of texts should add up the
answer(not counting whitespaces).
#cited_snippets
def cited_snippets() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>) — Optional. Snippets cited by the answer generation model from the most to least relevant.
#cited_snippets=
def cited_snippets=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>) — Optional. Snippets cited by the answer generation model from the most to least relevant.
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>) — Optional. Snippets cited by the answer generation model from the most to least relevant.
#grounding_signals
def grounding_signals() -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals) — Optional. Grounding signals.
#grounding_signals=
def grounding_signals=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals) — Optional. Grounding signals.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals) — Optional. Grounding signals.
#rewriter_model_call_signals
def rewriter_model_call_signals() -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals) — Optional. Diagnostic info related to the rewriter model call.
#rewriter_model_call_signals=
def rewriter_model_call_signals=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals) — Optional. Diagnostic info related to the rewriter model call.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals) — Optional. Diagnostic info related to the rewriter model call.
#rewritten_query
def rewritten_query() -> ::String
Returns
- (::String) — Optional. Rewritten string query used for search.
#rewritten_query=
def rewritten_query=(value) -> ::String
Parameter
- value (::String) — Optional. Rewritten string query used for search.
Returns
- (::String) — Optional. Rewritten string query used for search.
#safety_signals
def safety_signals() -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals) — Optional. Safety check result.
#safety_signals=
def safety_signals=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals) — Optional. Safety check result.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals) — Optional. Safety check result.
#search_snippets
def search_snippets() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>) — Optional. Search snippets included in the answer generation prompt.
#search_snippets=
def search_snippets=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>) — Optional. Search snippets included in the answer generation prompt.
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>) — Optional. Search snippets included in the answer generation prompt.