com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

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

Method Summary

Modifier and Type	Method and Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	addAllSupportChunkIndices(Iterable<? extends Integer> values) A list of indices (into 'support_chunks') specifying the citations associated with the claim.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	addSupportChunkIndices(int value) A list of indices (into 'support_chunks') specifying the citations associated with the claim.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	build()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	buildPartial()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clear()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clearClaimText() Text for the claim in the candidate.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clearSupportChunkIndices() A list of indices (into 'support_chunks') specifying the citations associated with the claim.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clearSupportScore() A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	clone()
String	getClaimText() Text for the claim in the candidate.
com.google.protobuf.ByteString	getClaimTextBytes() Text for the claim in the candidate.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport other)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	mergeFrom(com.google.protobuf.Message other)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setClaimText(String value) Text for the claim in the candidate.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setClaimTextBytes(com.google.protobuf.ByteString value) Text for the claim in the candidate.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setSupportChunkIndices(int index, int value) A list of indices (into 'support_chunks') specifying the citations associated with the claim.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setSupportScore(float value) A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated.
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

clear

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

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

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

build

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

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

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

setField

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                                     Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

clearField

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

clearOneof

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

setRepeatedField

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                                             int index,
                                                                                                             Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

addRepeatedField

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                                             Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

mergeFrom

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

mergeFrom

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

Throws:

IOException

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.

setClaimText

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setClaimText(String value)

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

string claim_text = 1;

Parameters:

value - The claimText to set.

Returns:

This builder for chaining.

clearClaimText

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

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

string claim_text = 1;

Returns:

This builder for chaining.

setClaimTextBytes

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setClaimTextBytes(com.google.protobuf.ByteString value)

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

string claim_text = 1;

Parameters:

value - The bytes for claimText to set.

Returns:

This builder for chaining.

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.

setSupportChunkIndices

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setSupportChunkIndices(int index,
                                                                                                                   int value)

 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 to set the value at.

value - The supportChunkIndices to set.

Returns:

This builder for chaining.

addSupportChunkIndices

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder addSupportChunkIndices(int value)

 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:

value - The supportChunkIndices to add.

Returns:

This builder for chaining.

addAllSupportChunkIndices

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder addAllSupportChunkIndices(Iterable<? extends Integer> values)

 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:

values - The supportChunkIndices to add.

Returns:

This builder for chaining.

clearSupportChunkIndices

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

 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:

This builder for chaining.

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.

setSupportScore

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setSupportScore(float value)

 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;

Parameters:

value - The supportScore to set.

Returns:

This builder for chaining.

clearSupportScore

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

 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:

This builder for chaining.

setUnknownFields

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>

mergeUnknownFields

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder>