Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignals

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

Overview

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, ...

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3DataStoreConnectionSignals

Returns a new instance of GoogleCloudDialogflowCxV3DataStoreConnectionSignals.



1424
1425
1426
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1424

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

Instance Attribute Details

#answer ⇒ String

Optional. The final compiled answer. Corresponds to the JSON property answer

Returns:

  • (String) 


1380
1381
1382
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1380

def answer
  @answer
end

#answer_generation_model_call_signals ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals

Diagnostic info related to the answer generation model call. Corresponds to the JSON property answerGenerationModelCallSignals

Returns:



1385
1386
1387
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1385

def answer_generation_model_call_signals
  @answer_generation_model_call_signals
end

#answer_parts ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart>

Optional. Answer parts with relevant citations. Concatenation of texts should add up the answer (not counting whitespaces). Corresponds to the JSON property answerParts

Returns:



1391
1392
1393
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1391

def answer_parts
  @answer_parts
end

#cited_snippets ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet>

Optional. Snippets cited by the answer generation model from the most to least relevant. Corresponds to the JSON property citedSnippets

Returns:



1397
1398
1399
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1397

def cited_snippets
  @cited_snippets
end

#grounding_signals ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals

Grounding signals. Corresponds to the JSON property groundingSignals

Returns:



1402
1403
1404
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1402

def grounding_signals
  @grounding_signals
end

#rewriter_model_call_signals ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals

Diagnostic info related to the rewriter model call. Corresponds to the JSON property rewriterModelCallSignals

Returns:



1407
1408
1409
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1407

def rewriter_model_call_signals
  @rewriter_model_call_signals
end

#rewritten_query ⇒ String

Optional. Rewritten string query used for search. Corresponds to the JSON property rewrittenQuery

Returns:

  • (String) 


1412
1413
1414
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1412

def rewritten_query
  @rewritten_query
end

#safety_signals ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals

Safety check results. Corresponds to the JSON property safetySignals

Returns:



1417
1418
1419
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1417

def safety_signals
  @safety_signals
end

#search_snippets ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet>

Optional. Search snippets included in the answer generation prompt. Corresponds to the JSON property searchSnippets

Returns:



1422
1423
1424
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1422

def search_snippets
  @search_snippets
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1429

def update!(**args)
  @answer = args[:answer] if args.key?(:answer)
  @answer_generation_model_call_signals = args[:answer_generation_model_call_signals] if args.key?(:answer_generation_model_call_signals)
  @answer_parts = args[:answer_parts] if args.key?(:answer_parts)
  @cited_snippets = args[:cited_snippets] if args.key?(:cited_snippets)
  @grounding_signals = args[:grounding_signals] if args.key?(:grounding_signals)
  @rewriter_model_call_signals = args[:rewriter_model_call_signals] if args.key?(:rewriter_model_call_signals)
  @rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
  @safety_signals = args[:safety_signals] if args.key?(:safety_signals)
  @search_snippets = args[:search_snippets] if args.key?(:search_snippets)
end