Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerGroundingSupport

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

Grounding support for a claim in answer_text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1AnswerGroundingSupport

Returns a new instance of GoogleCloudDiscoveryengineV1AnswerGroundingSupport.



945
946
947
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 945

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

Instance Attribute Details

#end_index ⇒ Fixnum

Required. End of the claim, exclusive. Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


916
917
918
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 916

def end_index
  @end_index
end

#grounding_check_required ⇒ Boolean Also known as: grounding_check_required?

Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore grounding_score, sources is not returned. Corresponds to the JSON property groundingCheckRequired

Returns:

  • (Boolean) 


924
925
926
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 924

def grounding_check_required
  @grounding_check_required
end

#grounding_score ⇒ Float

A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. Corresponds to the JSON property groundingScore

Returns:

  • (Float) 


932
933
934
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 932

def grounding_score
  @grounding_score
end

#sources ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerCitationSource>

Optional. Citation sources for the claim. Corresponds to the JSON property sources

Returns:



937
938
939
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 937

def sources
  @sources
end

#start_index ⇒ Fixnum

Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


943
944
945
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 943

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



950
951
952
953
954
955
956
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 950

def update!(**args)
  @end_index = args[:end_index] if args.key?(:end_index)
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
  @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
  @sources = args[:sources] if args.key?(:sources)
  @start_index = args[:start_index] if args.key?(:start_index)
end