Class GenerateGroundedContentResponse.Candidate.GroundingMetadata (0.51.0)

public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata extends GeneratedMessageV3 implements GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

Citation for the generated content.

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

Inheritance

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

Static Fields

GROUNDING_SUPPORT_FIELD_NUMBER

public static final int GROUNDING_SUPPORT_FIELD_NUMBER
Field Value
Type Description
int

RETRIEVAL_METADATA_FIELD_NUMBER

public static final int RETRIEVAL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_ENTRY_POINT_FIELD_NUMBER

public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER
Field Value
Type Description
int

SUPPORT_CHUNKS_FIELD_NUMBER

public static final int SUPPORT_CHUNKS_FIELD_NUMBER
Field Value
Type Description
int

WEB_SEARCH_QUERIES_FIELD_NUMBER

public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstance()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)
Parameter
Name Description
prototype GenerateGroundedContentResponse.Candidate.GroundingMetadata
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

parseDelimitedFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> parser()
Returns
Type Description
Parser<GroundingMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstanceForType()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

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

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>

getParserForType()

public Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> getParserForType()
Returns
Type Description
Parser<GroundingMetadata>
Overrides

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

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder toBuilder()
Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException