Class GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder (0.49.0)

Version 0.49.0

• 0.50.0 (latest)
• 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.Builder extends GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder> implements GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

Citation for the generated content.

Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata

Inheritance

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

Implements

GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addAllGroundingSupport(Iterable<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> values)

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

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport>

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addAllRetrievalMetadata(Iterable<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata> values)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addAllRetrievalMetadata(Iterable<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata> values)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata>

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addAllSupportChunks(Iterable<? extends FactChunk> values)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addAllSupportChunks(Iterable<? extends FactChunk> values)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1.FactChunk>

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addAllWebSearchQueries(Iterable<String> values)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addAllWebSearchQueries(Iterable<String> values)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameter
Name	Description
values	Iterable<String> The webSearchQueries to add.

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

addGroundingSupport(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addGroundingSupport(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport value)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addGroundingSupport(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addGroundingSupport(GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport value)

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

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameters
Name	Description
index	int
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameters
Name	Description
index	int
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addGroundingSupportBuilder()

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

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

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

addGroundingSupportBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder addGroundingSupportBuilder(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
index	int

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addRetrievalMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameters
Name	Description
index	int
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameters
Name	Description
index	int
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addRetrievalMetadataBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder addRetrievalMetadataBuilder()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

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

addRetrievalMetadataBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder addRetrievalMetadataBuilder(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
index	int

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

addSupportChunks(FactChunk value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addSupportChunks(FactChunk value)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
value	FactChunk

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addSupportChunks(FactChunk.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addSupportChunks(FactChunk.Builder builderForValue)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
builderForValue	FactChunk.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addSupportChunks(int index, FactChunk value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addSupportChunks(int index, FactChunk value)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameters
Name	Description
index	int
value	FactChunk

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addSupportChunks(int index, FactChunk.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addSupportChunks(int index, FactChunk.Builder builderForValue)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameters
Name	Description
index	int
builderForValue	FactChunk.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

addSupportChunksBuilder()

public FactChunk.Builder addSupportChunksBuilder()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
FactChunk.Builder

addSupportChunksBuilder(int index)

public FactChunk.Builder addSupportChunksBuilder(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
FactChunk.Builder

addWebSearchQueries(String value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addWebSearchQueries(String value)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameter
Name	Description
value	String The webSearchQueries to add.

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

addWebSearchQueriesBytes(ByteString value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder addWebSearchQueriesBytes(ByteString value)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameter
Name	Description
value	ByteString The bytes of the webSearchQueries to add.

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

build()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata build()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

buildPartial()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata buildPartial()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

clear()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clear()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGroundingSupport()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearGroundingSupport()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRetrievalMetadata()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearRetrievalMetadata()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

clearSearchEntryPoint()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearSearchEntryPoint()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

clearSupportChunks()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearSupportChunks()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

clearWebSearchQueries()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clearWebSearchQueries()

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

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

clone()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder clone()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstanceForType()

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGroundingSupport(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport getGroundingSupport(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

getGroundingSupportBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder getGroundingSupportBuilder(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
index	int

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

getGroundingSupportBuilderList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder> getGroundingSupportBuilderList()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
List<Builder>

getGroundingSupportCount()

public int getGroundingSupportCount()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
int

getGroundingSupportList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport> getGroundingSupportList()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
List<GroundingSupport>

getGroundingSupportOrBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder getGroundingSupportOrBuilder(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

getGroundingSupportOrBuilderList()

public List<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder> getGroundingSupportOrBuilderList()

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder>

getRetrievalMetadata(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata getRetrievalMetadata(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

getRetrievalMetadataBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder getRetrievalMetadataBuilder(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
index	int

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

getRetrievalMetadataBuilderList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder> getRetrievalMetadataBuilderList()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
List<Builder>

getRetrievalMetadataCount()

public int getRetrievalMetadataCount()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
int

getRetrievalMetadataList()

public List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata> getRetrievalMetadataList()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
List<RetrievalMetadata>

getRetrievalMetadataOrBuilder(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder getRetrievalMetadataOrBuilder(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder

getRetrievalMetadataOrBuilderList()

public List<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder> getRetrievalMetadataOrBuilderList()

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder>

getSearchEntryPoint()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint getSearchEntryPoint()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint	The searchEntryPoint.

getSearchEntryPointBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint.Builder getSearchEntryPointBuilder()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

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

getSearchEntryPointOrBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder

getSupportChunks(int index)

public FactChunk getSupportChunks(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
FactChunk

getSupportChunksBuilder(int index)

public FactChunk.Builder getSupportChunksBuilder(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
FactChunk.Builder

getSupportChunksBuilderList()

public List<FactChunk.Builder> getSupportChunksBuilderList()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
List<Builder>

getSupportChunksCount()

public int getSupportChunksCount()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
int

getSupportChunksList()

public List<FactChunk> getSupportChunksList()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
List<FactChunk>

getSupportChunksOrBuilder(int index)

public FactChunkOrBuilder getSupportChunksOrBuilder(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
FactChunkOrBuilder

getSupportChunksOrBuilderList()

public List<? extends FactChunkOrBuilder> getSupportChunksOrBuilderList()

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.FactChunkOrBuilder>

getWebSearchQueries(int index)

public String getWebSearchQueries(int index)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The webSearchQueries at the given index.

getWebSearchQueriesBytes(int index)

public ByteString getWebSearchQueriesBytes(int index)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the webSearchQueries at the given index.

getWebSearchQueriesCount()

public int getWebSearchQueriesCount()

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Returns
Type	Description
int	The count of webSearchQueries.

getWebSearchQueriesList()

public ProtocolStringList getWebSearchQueriesList()

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Returns
Type	Description
ProtocolStringList	A list containing the webSearchQueries.

hasSearchEntryPoint()

public boolean hasSearchEntryPoint()

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Returns
Type	Description
boolean	Whether the searchEntryPoint field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GenerateGroundedContentResponse.Candidate.GroundingMetadata other)

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

Parameter
Name	Description
other	GenerateGroundedContentResponse.Candidate.GroundingMetadata

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

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

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

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

mergeSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder mergeSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint value)

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Parameter
Name	Description
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeGroundingSupport(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder removeGroundingSupport(int index)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

removeRetrievalMetadata(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder removeRetrievalMetadata(int index)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

removeSupportChunks(int index)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder removeSupportChunks(int index)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport value)

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

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameters
Name	Description
index	int
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setGroundingSupport(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder builderForValue)

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;

Parameters
Name	Description
index	int
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata value)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameters
Name	Description
index	int
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setRetrievalMetadata(int index, GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder builderForValue)

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;

Parameters
Name	Description
index	int
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint value)

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Parameter
Name	Description
value	GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setSearchEntryPoint(GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint.Builder builderForValue)

Google search entry for the following-up web searches.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;

Parameter
Name	Description
builderForValue	GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setSupportChunks(int index, FactChunk value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setSupportChunks(int index, FactChunk value)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameters
Name	Description
index	int
value	FactChunk

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setSupportChunks(int index, FactChunk.Builder builderForValue)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setSupportChunks(int index, FactChunk.Builder builderForValue)

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.

repeated .google.cloud.discoveryengine.v1.FactChunk support_chunks = 1;

Parameters
Name	Description
index	int
builderForValue	FactChunk.Builder

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWebSearchQueries(int index, String value)

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder setWebSearchQueries(int index, String value)

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Parameters
Name	Description
index	int The index to set the value at.
value	String The webSearchQueries to set.

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