Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport (0.51.0)

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport extends GeneratedMessageV3 implements GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Grounding info for a claim in the candidate and its support.

Protobuf type google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Static Fields

CLAIM_TEXT_FIELD_NUMBER

public static final int CLAIM_TEXT_FIELD_NUMBER
Field Value
Type Description
int

SUPPORT_CHUNK_INDICES_FIELD_NUMBER

public static final int SUPPORT_CHUNK_INDICES_FIELD_NUMBER
Field Value
Type Description
int

SUPPORT_SCORE_FIELD_NUMBER

public static final int SUPPORT_SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getDefaultInstance()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilder()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport prototype)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport prototype)
Parameter
Name Description
prototype GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

parseDelimitedFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> parser()
Returns
Type Description
Parser<GroundingSupport>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClaimText()

public 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 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.

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getDefaultInstanceForType()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

getParserForType()

public Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> getParserForType()
Returns
Type Description
Parser<GroundingSupport>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSupportChunkIndices(int index)

public 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilderForType()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder toBuilder()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException