Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer

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

Overview

Defines an answer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaAnswer

Returns a new instance of GoogleCloudDiscoveryengineV1alphaAnswer.



10906
10907
10908
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10906

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

Instance Attribute Details

#answer_skipped_reasons ⇒ Array<String>

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. Corresponds to the JSON property answerSkippedReasons

Returns:

  • (Array<String>) 


10837
10838
10839
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10837

def answer_skipped_reasons
  @answer_skipped_reasons
end

#answer_text ⇒ String

The textual answer. Corresponds to the JSON property answerText

Returns:

  • (String) 


10842
10843
10844
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10842

def answer_text
  @answer_text
end

#citations ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerCitation>

Citations. Corresponds to the JSON property citations

Returns:



10847
10848
10849
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10847

def citations
  @citations
end

#complete_time ⇒ String

Output only. Answer completed timestamp. Corresponds to the JSON property completeTime

Returns:

  • (String) 


10852
10853
10854
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10852

def complete_time
  @complete_time
end

#create_time ⇒ String

Output only. Answer creation timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


10857
10858
10859
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10857

def create_time
  @create_time
end

#grounding_score ⇒ Float

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. Corresponds to the JSON property groundingScore

Returns:

  • (Float) 


10863
10864
10865
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10863

def grounding_score
  @grounding_score
end

#grounding_supports ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport>

Optional. Grounding supports. Corresponds to the JSON property groundingSupports

Returns:



10868
10869
10870
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10868

def grounding_supports
  @grounding_supports
end

#name ⇒ String

Immutable. Fully qualified name projects/project/locations/global/ collections/collection/engines/engine/sessions/*/answers/* Corresponds to the JSON property name

Returns:

  • (String) 


10874
10875
10876
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10874

def name
  @name
end

#query_understanding_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo

Query understanding information. Corresponds to the JSON property queryUnderstandingInfo

Returns:



10879
10880
10881
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10879

def query_understanding_info
  @query_understanding_info
end

#references ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerReference>

References. Corresponds to the JSON property references

Returns:



10884
10885
10886
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10884

def references
  @references
end

#related_questions ⇒ Array<String>

Suggested related questions. Corresponds to the JSON property relatedQuestions

Returns:

  • (Array<String>) 


10889
10890
10891
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10889

def related_questions
  @related_questions
end

#safety_ratings ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSafetyRating>

Optional. Safety ratings. Corresponds to the JSON property safetyRatings

Returns:



10894
10895
10896
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10894

def safety_ratings
  @safety_ratings
end

#state ⇒ String

The state of the answer generation. Corresponds to the JSON property state

Returns:

  • (String) 


10899
10900
10901
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10899

def state
  @state
end

#steps ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswerStep>

Answer generation steps. Corresponds to the JSON property steps

Returns:



10904
10905
10906
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10904

def steps
  @steps
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10911

def update!(**args)
  @answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
  @answer_text = args[:answer_text] if args.key?(:answer_text)
  @citations = args[:citations] if args.key?(:citations)
  @complete_time = args[:complete_time] if args.key?(:complete_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
  @grounding_supports = args[:grounding_supports] if args.key?(:grounding_supports)
  @name = args[:name] if args.key?(:name)
  @query_understanding_info = args[:query_understanding_info] if args.key?(:query_understanding_info)
  @references = args[:references] if args.key?(:references)
  @related_questions = args[:related_questions] if args.key?(:related_questions)
  @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
  @state = args[:state] if args.key?(:state)
  @steps = args[:steps] if args.key?(:steps)
end