Interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder (0.49.0)

public static interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClaimText()

public abstract String getClaimText()

Text for the claim in the candidate. Always provided when a support is found.

string claim_text = 1;

Returns
Type Description
String

The claimText.

getClaimTextBytes()

public abstract ByteString getClaimTextBytes()

Text for the claim in the candidate. Always provided when a support is found.

string claim_text = 1;

Returns
Type Description
ByteString

The bytes for claimText.

getSupportChunkIndices(int index)

public abstract int getSupportChunkIndices(int index)

A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.

repeated int32 support_chunk_indices = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The supportChunkIndices at the given index.

getSupportChunkIndicesCount()

public abstract int getSupportChunkIndicesCount()

A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.

repeated int32 support_chunk_indices = 3;

Returns
Type Description
int

The count of supportChunkIndices.

getSupportChunkIndicesList()

public abstract List<Integer> getSupportChunkIndicesList()

A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.

repeated int32 support_chunk_indices = 3;

Returns
Type Description
List<Integer>

A list containing the supportChunkIndices.

getSupportScore()

public abstract float getSupportScore()

A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.

optional float support_score = 2;

Returns
Type Description
float

The supportScore.

hasSupportScore()

public abstract boolean hasSupportScore()

A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.

optional float support_score = 2;

Returns
Type Description
boolean

Whether the supportScore field is set.