Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer

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

Overview

Defines an answer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaAnswer

Returns a new instance of GoogleCloudDiscoveryengineV1betaAnswer.



10095
10096
10097
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10095

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>) 


10031
10032
10033
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10031

def answer_skipped_reasons
  @answer_skipped_reasons
end

#answer_text ⇒ String

The textual answer. Corresponds to the JSON property answerText

Returns:

  • (String) 


10036
10037
10038
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10036

def answer_text
  @answer_text
end

#citations ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerCitation>

Citations. Corresponds to the JSON property citations

Returns:



10041
10042
10043
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10041

def citations
  @citations
end

#complete_time ⇒ String

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

Returns:

  • (String) 


10046
10047
10048
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10046

def complete_time
  @complete_time
end

#create_time ⇒ String

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

Returns:

  • (String) 


10051
10052
10053
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10051

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) 


10057
10058
10059
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10057

def grounding_score
  @grounding_score
end

#grounding_supports ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport>

Optional. Grounding supports. Corresponds to the JSON property groundingSupports

Returns:



10062
10063
10064
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10062

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) 


10068
10069
10070
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10068

def name
  @name
end

#query_understanding_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo

Query understanding information. Corresponds to the JSON property queryUnderstandingInfo

Returns:



10073
10074
10075
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10073

def query_understanding_info
  @query_understanding_info
end

#references ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerReference>

References. Corresponds to the JSON property references

Returns:



10078
10079
10080
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10078

def references
  @references
end

#related_questions ⇒ Array<String>

Suggested related questions. Corresponds to the JSON property relatedQuestions

Returns:

  • (Array<String>) 


10083
10084
10085
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10083

def related_questions
  @related_questions
end

#state ⇒ String

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

Returns:

  • (String) 


10088
10089
10090
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10088

def state
  @state
end

#steps ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerStep>

Answer generation steps. Corresponds to the JSON property steps

Returns:



10093
10094
10095
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10093

def steps
  @steps
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 10100

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)
  @state = args[:state] if args.key?(:state)
  @steps = args[:steps] if args.key?(:steps)
end