public static final class GenerateGroundedContentResponse.Candidate.GroundingMetadata extends GeneratedMessageV3 implements GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder
Citation for the generated content.
Protobuf type
google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder()
newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilder(GenerateGroundedContentResponse.Candidate.GroundingMetadata prototype)
parseDelimitedFrom(InputStream input)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentResponse.Candidate.GroundingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata getDefaultInstanceForType()
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport grounding_support = 2;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder> |
|
getParserForType()
public Parser<GenerateGroundedContentResponse.Candidate.GroundingMetadata> getParserForType()
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata retrieval_metadata = 5;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder> |
|
getSearchEntryPoint()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint getSearchEntryPoint()
Google search entry for the following-up web searches.
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;
getSearchEntryPointOrBuilder()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()
Google search entry for the following-up web searches.
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;
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.v1beta.FactChunk support_chunks = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.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.v1beta.FactChunk support_chunks = 1;
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.v1beta.FactChunk support_chunks = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta.FactChunk support_chunks = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.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;
hasSearchEntryPoint()
public boolean hasSearchEntryPoint()
Google search entry for the following-up web searches.
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;
| Returns |
| Type |
Description |
boolean |
Whether the searchEntryPoint field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
