com.google.cloud.discoveryengine.v1

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 and 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, in bytes.
boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
double	getScore() Confidence score for the claim in the answer candidate, in the range of [0, 1].
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, in bytes.
boolean	hasGroundingCheckRequired() Indicates that this claim required grounding check.
boolean	hasScore() Confidence score for the claim in the answer candidate, in the range of [0, 1].
boolean	hasStartPos() Position indicating the start of the claim in the answer candidate, measured in bytes.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStartPos

boolean hasStartPos()

 Position indicating the start of the claim in the answer candidate,
 measured in bytes. Note that this is not measured in characters and,
 therefore, must be rendered in the user interface keeping in mind that
 some characters may take more than one byte. For example,
 if the claim text contains non-ASCII characters, the start and end
 positions vary when measured in characters
 (programming-language-dependent) and when measured in bytes
 (programming-language-independent).
 

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. Note that this is not measured in characters and,
 therefore, must be rendered in the user interface keeping in mind that
 some characters may take more than one byte. For example,
 if the claim text contains non-ASCII characters, the start and end
 positions vary when measured in characters
 (programming-language-dependent) and when measured in bytes
 (programming-language-independent).
 

optional int32 start_pos = 1;

Returns:

The startPos.

hasEndPos

boolean hasEndPos()

 Position indicating the end of the claim in the answer candidate,
 exclusive, in bytes. Note that this is not measured in characters and,
 therefore, must be rendered as such. For example, if the claim text
 contains non-ASCII characters, the start and end positions vary when
 measured in characters (programming-language-dependent) and when measured
 in bytes (programming-language-independent).
 

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, in bytes. Note that this is not measured in characters and,
 therefore, must be rendered as such. For example, if the claim text
 contains non-ASCII characters, the start and end positions vary when
 measured in characters (programming-language-dependent) and when measured
 in bytes (programming-language-independent).
 

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.v1.CheckGroundingResponse.Claim.citation_indices]
 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.v1.CheckGroundingResponse.Claim.citation_indices]
 should not be returned.
 

optional bool grounding_check_required = 6;

Returns:

The groundingCheckRequired.

hasScore

boolean hasScore()

 Confidence score for the claim in the answer candidate, in the range of
 [0, 1]. This is set only when
 `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
 

optional double score = 7;

Returns:

Whether the score field is set.

getScore

double getScore()

 Confidence score for the claim in the answer candidate, in the range of
 [0, 1]. This is set only when
 `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
 

optional double score = 7;

Returns:

The score.