public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata extends com.google.protobuf.GeneratedMessage implements GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder
Citation for the generated content.Protobuf type
google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadatacom.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
GROUNDING_SUPPORT_FIELD_NUMBER |
static int |
IMAGES_FIELD_NUMBER |
static int |
RETRIEVAL_METADATA_FIELD_NUMBER |
static int |
SEARCH_ENTRY_POINT_FIELD_NUMBER |
static int |
SUPPORT_CHUNKS_FIELD_NUMBER |
static int |
WEB_SEARCH_QUERIES_FIELD_NUMBER |
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int RETRIEVAL_METADATA_FIELD_NUMBER
public static final int SUPPORT_CHUNKS_FIELD_NUMBER
public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER
public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER
public static final int GROUNDING_SUPPORT_FIELD_NUMBER
public static final int IMAGES_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic 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;
getRetrievalMetadataList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getRetrievalMetadataOrBuilderList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getRetrievalMetadataCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getRetrievalMetadata in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getRetrievalMetadataOrBuilder in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;getSupportChunksList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;getSupportChunksOrBuilderList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;getSupportChunksCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;getSupportChunks in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;getSupportChunksOrBuilder in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic com.google.protobuf.ProtocolStringList getWebSearchQueriesList()
Web search queries for the following-up web search.
repeated string web_search_queries = 3;getWebSearchQueriesList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic int getWebSearchQueriesCount()
Web search queries for the following-up web search.
repeated string web_search_queries = 3;getWebSearchQueriesCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic String getWebSearchQueries(int index)
Web search queries for the following-up web search.
repeated string web_search_queries = 3;getWebSearchQueries in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getWebSearchQueriesBytes(int index)
Web search queries for the following-up web search.
repeated string web_search_queries = 3;getWebSearchQueriesBytes in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderindex - The index of the value to return.public boolean hasSearchEntryPoint()
Google search entry for the following-up web searches.
.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;
hasSearchEntryPoint in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getSearchEntryPoint in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getSearchEntryPointOrBuilder in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getGroundingSupportList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getGroundingSupportOrBuilderList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getGroundingSupportCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getGroundingSupport in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic 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;
getGroundingSupportOrBuilder in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic List<GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata> getImagesList()
Images from the web search.
repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata images = 9;
getImagesList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic List<? extends GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadataOrBuilder> getImagesOrBuilderList()
Images from the web search.
repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata images = 9;
getImagesOrBuilderList in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic int getImagesCount()
Images from the web search.
repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata images = 9;
getImagesCount in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata getImages(int index)
Images from the web search.
repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata images = 9;
getImages in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadataOrBuilder getImagesOrBuilder(int index)
Images from the web search.
repeated .google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.ImageMetadata images = 9;
getImagesOrBuilder in interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input) throws IOException
IOExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder()
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstance()
public static com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> parser()
public com.google.protobuf.Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.