com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

All Implemented Interfaces:

GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

GenerateGroundedContentResponse.Candidate.GroundingMetadata

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder Grounding info for a claim in the candidate and its support.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLAIM_TEXT_FIELD_NUMBER
static int	SUPPORT_CHUNK_INDICES_FIELD_NUMBER
static int	SUPPORT_SCORE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClaimText() Text for the claim in the candidate.
com.google.protobuf.ByteString	getClaimTextBytes() Text for the claim in the candidate.
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	getDefaultInstance()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
boolean	hasSupportScore() A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	newBuilder()
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport prototype)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	newBuilderForType()
protected GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseDelimitedFrom(InputStream input)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(byte[] data)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(ByteBuffer data)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(com.google.protobuf.ByteString data)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(InputStream input)
static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport>	parser()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CLAIM_TEXT_FIELD_NUMBER

public static final int CLAIM_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

SUPPORT_CHUNK_INDICES_FIELD_NUMBER

public static final int SUPPORT_CHUNK_INDICES_FIELD_NUMBER

See Also:

Constant Field Values

SUPPORT_SCORE_FIELD_NUMBER

public static final int SUPPORT_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getClaimText

public String getClaimText()

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

string claim_text = 1;

Specified by:

getClaimText in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

The claimText.

getClaimTextBytes

public com.google.protobuf.ByteString getClaimTextBytes()

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

string claim_text = 1;

Specified by:

getClaimTextBytes in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

The bytes for claimText.

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;

Specified by:

getSupportChunkIndicesList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

A list containing the supportChunkIndices.

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;

Specified by:

getSupportChunkIndicesCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

The count of supportChunkIndices.

getSupportChunkIndices

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;

Specified by:

getSupportChunkIndices in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The supportChunkIndices at the given index.

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;

Specified by:

hasSupportScore in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

Whether the supportScore field is set.

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;

Specified by:

getSupportScore in interface GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Returns:

The supportScore.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteBuffer data)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(ByteBuffer data,
                                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(com.google.protobuf.ByteString data)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(com.google.protobuf.ByteString data,
                                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(byte[] data)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(byte[] data,
                                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(InputStream input)
                                                                                              throws IOException

Throws:

IOException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(InputStream input,
                                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseDelimitedFrom(InputStream input)
                                                                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseDelimitedFrom(InputStream input,
                                                                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                                       throws IOException

Throws:

IOException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(com.google.protobuf.CodedInputStream input)
                                                                                              throws IOException

Throws:

IOException

parseFrom

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport parseFrom(com.google.protobuf.CodedInputStream input,
                                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                              throws IOException

Throws:

IOException

newBuilderForType

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilder()

newBuilder

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport prototype)

toBuilder

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> parser()

getParserForType

public com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder