Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#citation_indices

def citation_indices() -> ::Array<::Integer>
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.

#citation_indices=

def citation_indices=(value) -> ::Array<::Integer>
Parameter
  • value (::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.
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.

#claim_text

def claim_text() -> ::String
Returns
  • (::String) — Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.

#claim_text=

def claim_text=(value) -> ::String
Parameter
  • value (::String) — 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.

#end_pos

def end_pos() -> ::Integer
Returns
  • (::Integer) — Position indicating the end of the claim in the answer candidate, exclusive.

#end_pos=

def end_pos=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

#grounding_check_required

def grounding_check_required() -> ::Boolean
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.

#grounding_check_required=

def grounding_check_required=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#start_pos

def start_pos() -> ::Integer
Returns
  • (::Integer) — Position indicating the start of the claim in the answer candidate, measured in bytes.

#start_pos=

def start_pos=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.