Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/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.



2711
2712
2713
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2711

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

Instance Attribute Details

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


2658
2659
2660
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2658

def answer_skipped_reasons
  @answer_skipped_reasons
end

#answer_textString

The textual answer. Corresponds to the JSON property answerText

Returns:

  • (String)


2663
2664
2665
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2663

def answer_text
  @answer_text
end

#citationsArray<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerCitation>

Citations. Corresponds to the JSON property citations



2668
2669
2670
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2668

def citations
  @citations
end

#complete_timeString

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

Returns:

  • (String)


2673
2674
2675
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2673

def complete_time
  @complete_time
end

#create_timeString

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

Returns:

  • (String)


2678
2679
2680
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2678

def create_time
  @create_time
end

#nameString

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

Returns:

  • (String)


2684
2685
2686
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2684

def name
  @name
end

#query_understanding_infoGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo

Query understanding information. Corresponds to the JSON property queryUnderstandingInfo



2689
2690
2691
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2689

def query_understanding_info
  @query_understanding_info
end

#referencesArray<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReference>

References. Corresponds to the JSON property references



2694
2695
2696
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2694

def references
  @references
end

Suggested related questions. Corresponds to the JSON property relatedQuestions

Returns:

  • (Array<String>)


2699
2700
2701
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2699

def related_questions
  @related_questions
end

#stateString

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

Returns:

  • (String)


2704
2705
2706
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2704

def state
  @state
end

#stepsArray<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStep>

Answer generation steps. Corresponds to the JSON property steps



2709
2710
2711
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2709

def steps
  @steps
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2716

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