Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder (0.83.0)

0.83.0 (latest) 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder extends GeneratedMessage.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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Implements

GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllSupportChunkIndices(Iterable<? extends Integer> values)

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;

Parameter
Name	Description
values	Iterable<? extends java.lang.Integer> The supportChunkIndices to add.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

addSupportChunkIndices(int value)

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;

Parameter
Name	Description
value	int The supportChunkIndices to add.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

build()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport build()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

buildPartial()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport buildPartial()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

clear()

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

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	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
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	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
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport other)

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

Parameter
Name	Description
other	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

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

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setClaimText(String value)

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;

Parameter
Name	Description
value	String The claimText to set.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

setClaimTextBytes(ByteString value)

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

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

string claim_text = 1;

Parameter
Name	Description
value	ByteString The bytes for claimText to set.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

setSupportChunkIndices(int index, int value)

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
Name	Description
index	int The index to set the value at.
value	int The supportChunkIndices to set.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.

setSupportScore(float value)

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;

Parameter
Name	Description
value	float The supportScore to set.

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder	This builder for chaining.