Package com.google.cloud.discoveryengine.v1beta

Interface CheckGroundingResponse.ClaimOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CheckGroundingResponse.Claim, CheckGroundingResponse.Claim.Builder
Enclosing class:
CheckGroundingResponse
public static interface CheckGroundingResponse.ClaimOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCitationIndices(int index)
    A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
    int
    getCitationIndicesCount()
    A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
    List<Integer>
    getCitationIndicesList()
    A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
    String
    getClaimText()
    Text for the claim in the answer candidate.
    com.google.protobuf.ByteString
    getClaimTextBytes()
    Text for the claim in the answer candidate.
    int
    getEndPos()
    Position indicating the end of the claim in the answer candidate, exclusive.
    boolean
    getGroundingCheckRequired()
    Indicates that this claim required grounding check.
    int
    getStartPos()
    Position indicating the start of the claim in the answer candidate, measured in bytes.
    boolean
    hasEndPos()
    Position indicating the end of the claim in the answer candidate, exclusive.
    boolean
    hasGroundingCheckRequired()
    Indicates that this claim required grounding check.
    boolean
    hasStartPos()
    Position indicating the start of the claim in the answer candidate, measured in bytes.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasStartPos

      boolean hasStartPos()
       Position indicating the start of the claim in the answer candidate,
 measured in bytes.
      optional int32 start_pos = 1;
      Returns:
      Whether the startPos field is set.

    • getStartPos

      int getStartPos()
       Position indicating the start of the claim in the answer candidate,
 measured in bytes.
      optional int32 start_pos = 1;
      Returns:
      The startPos.

    • hasEndPos

      boolean hasEndPos()
       Position indicating the end of the claim in the answer candidate,
 exclusive.
      optional int32 end_pos = 2;
      Returns:
      Whether the endPos field is set.

    • getEndPos

      int getEndPos()
       Position indicating the end of the claim in the answer candidate,
 exclusive.
      optional int32 end_pos = 2;
      Returns:
      The endPos.

    • getClaimText

      String getClaimText()
       Text for the claim in the answer candidate. Always provided regardless of
 whether citations or anti-citations are found.
      string claim_text = 3;
      Returns:
      The claimText.

    • getClaimTextBytes

      com.google.protobuf.ByteString getClaimTextBytes()
       Text for the claim in the answer candidate. Always provided regardless of
 whether citations or anti-citations are found.
      string claim_text = 3;
      Returns:
      The bytes for claimText.

    • getCitationIndicesList

      List<Integer> getCitationIndicesList()
       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.
      repeated int32 citation_indices = 4;
      Returns:
      A list containing the citationIndices.

    • getCitationIndicesCount

      int getCitationIndicesCount()
       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.
      repeated int32 citation_indices = 4;
      Returns:
      The count of citationIndices.

    • getCitationIndices

      int getCitationIndices(int index)
       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.
      repeated int32 citation_indices = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The citationIndices at the given index.

    • hasGroundingCheckRequired

      boolean hasGroundingCheckRequired()
       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][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 should not be returned.
      optional bool grounding_check_required = 6;
      Returns:
      Whether the groundingCheckRequired field is set.

    • getGroundingCheckRequired

      boolean getGroundingCheckRequired()
       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][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
 [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
 and
 [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
 should not be returned.
      optional bool grounding_check_required = 6;
      Returns:
      The groundingCheckRequired.