Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim

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

Text and citation info for a claim in the answer candidate.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim

Returns a new instance of GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim.



2101
2102
2103
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2101

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

Instance Attribute Details

#citation_indices ⇒ Array<Fixnum>

A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[ 3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. Corresponds to the JSON property citationIndices

Returns:

  • (Array<Fixnum>) 


2068
2069
2070
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2068

def citation_indices
  @citation_indices
end

#claim_text ⇒ String

Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. Corresponds to the JSON property claimText

Returns:

  • (String) 


2074
2075
2076
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2074

def claim_text
  @claim_text
end

#end_pos ⇒ Fixnum

Position indicating the end of the claim in the answer candidate, exclusive. Corresponds to the JSON property endPos

Returns:

  • (Fixnum) 


2079
2080
2081
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2079

def end_pos
  @end_pos
end

#grounding_check_required ⇒ Boolean Also known as: grounding_check_required?

Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. Corresponds to the JSON property groundingCheckRequired

Returns:

  • (Boolean) 


2087
2088
2089
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2087

def grounding_check_required
  @grounding_check_required
end

#score ⇒ Float

Confidence score for the claim in the answer candidate, in the range of [0, 1]. Corresponds to the JSON property score

Returns:

  • (Float) 


2093
2094
2095
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2093

def score
  @score
end

#start_pos ⇒ Fixnum

Position indicating the start of the claim in the answer candidate, measured in bytes. Corresponds to the JSON property startPos

Returns:

  • (Fixnum) 


2099
2100
2101
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2099

def start_pos
  @start_pos
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2106
2107
2108
2109
2110
2111
2112
2113
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2106

def update!(**args)
  @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
  @claim_text = args[:claim_text] if args.key?(:claim_text)
  @end_pos = args[:end_pos] if args.key?(:end_pos)
  @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
  @score = args[:score] if args.key?(:score)
  @start_pos = args[:start_pos] if args.key?(:start_pos)
end