Class: Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#citation_indices ⇒ ::Array<::Integer>

Returns 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.

Returns:

  • (::Array<::Integer>) —

    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.



520
521
522
523
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 520

class Claim
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#claim_text ⇒ ::String

Returns Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.

Returns:

  • (::String) —

    Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.



520
521
522
523
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 520

class Claim
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#end_pos ⇒ ::Integer

Returns Position indicating the end of the claim in the answer candidate, exclusive.

Returns:

  • (::Integer) —

    Position indicating the end of the claim in the answer candidate, exclusive.



520
521
522
523
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 520

class Claim
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#grounding_check_required ⇒ ::Boolean

Returns 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, [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices], and [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score] should not be returned.

Returns:

  • (::Boolean) —

    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, [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices], and [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score] should not be returned.



520
521
522
523
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 520

class Claim
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_pos ⇒ ::Integer

Returns Position indicating the start of the claim in the answer candidate, measured in bytes.

Returns:

  • (::Integer) —

    Position indicating the start of the claim in the answer candidate, measured in bytes.



520
521
522
523
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 520

class Claim
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end