com.google.cloud.discoveryengine.v1beta

Interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Enclosing class:

GenerateGroundedContentResponse.Candidate.GroundingMetadata

public static interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getClaimText() Text for the claim in the candidate.
com.google.protobuf.ByteString	getClaimTextBytes() Text for the claim in the candidate.
int	getSupportChunkIndices(int index) A list of indices (into 'support_chunks') specifying the citations associated with the claim.
int	getSupportChunkIndicesCount() A list of indices (into 'support_chunks') specifying the citations associated with the claim.
List<Integer>	getSupportChunkIndicesList() A list of indices (into 'support_chunks') specifying the citations associated with the claim.
float	getSupportScore() A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated.
boolean	hasSupportScore() A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated.

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

getClaimText

String getClaimText()

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

string claim_text = 1;

Returns:

The claimText.

getClaimTextBytes

com.google.protobuf.ByteString getClaimTextBytes()

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

string claim_text = 1;

Returns:

The bytes for claimText.

getSupportChunkIndicesList

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:

A list containing the supportChunkIndices.

getSupportChunkIndicesCount

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:

The count of supportChunkIndices.

getSupportChunkIndices

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;

Parameters:

index - The index of the element to return.

Returns:

The supportChunkIndices at the given index.

hasSupportScore

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:

Whether the supportScore field is set.

getSupportScore

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:

The supportScore.