Interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGroundingSupport(int index)

public abstract 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

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport

getGroundingSupportCount()

public abstract 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 abstract 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;

Returns
Type	Description
List<GroundingSupport>

getGroundingSupportOrBuilder(int index)

public abstract 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

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupportOrBuilder

getGroundingSupportOrBuilderList()

public abstract 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>

getRetrievalMetadata(int index)

public abstract 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

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

getRetrievalMetadataCount()

public abstract 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 abstract 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;

Returns
Type	Description
List<RetrievalMetadata>

getRetrievalMetadataOrBuilder(int index)

public abstract 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

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadataOrBuilder

getRetrievalMetadataOrBuilderList()

public abstract 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 abstract 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;

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

getSearchEntryPointOrBuilder()

public abstract 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;

Returns
Type	Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPointOrBuilder

getSupportChunks(int index)

public abstract 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

Returns
Type	Description
FactChunk

getSupportChunksCount()

public abstract 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 abstract 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;

Returns
Type	Description
List<FactChunk>

getSupportChunksOrBuilder(int index)

public abstract 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

Returns
Type	Description
FactChunkOrBuilder

getSupportChunksOrBuilderList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getWebSearchQueriesList()

Web search queries for the following-up web search.

repeated string web_search_queries = 3;

Returns
Type	Description
List<String>	A list containing the webSearchQueries.

hasSearchEntryPoint()

public abstract 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.