Package com.google.cloud.discoveryengine.v1beta

Interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateGroundedContentResponse.Candidate.GroundingMetadata, GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder
Enclosing class:
GenerateGroundedContentResponse.Candidate
public static interface GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getRetrievalMetadataList

      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;

    • getRetrievalMetadata

      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;

    • getRetrievalMetadataCount

      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;

    • getRetrievalMetadataOrBuilderList

      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;

    • getRetrievalMetadataOrBuilder

      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;

    • getSupportChunksList

      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;

    • getSupportChunks

      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;

    • getSupportChunksCount

      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;

    • getSupportChunksOrBuilderList

      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;

    • getSupportChunksOrBuilder

      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;

    • getWebSearchQueriesList

      List<String> getWebSearchQueriesList()
       Web search queries for the following-up web search.
      repeated string web_search_queries = 3;
      Returns:
      A list containing the webSearchQueries.

    • getWebSearchQueriesCount

      int getWebSearchQueriesCount()
       Web search queries for the following-up web search.
      repeated string web_search_queries = 3;
      Returns:
      The count of webSearchQueries.

    • getWebSearchQueries

      String getWebSearchQueries(int index)
       Web search queries for the following-up web search.
      repeated string web_search_queries = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The webSearchQueries at the given index.

    • getWebSearchQueriesBytes

      com.google.protobuf.ByteString getWebSearchQueriesBytes(int index)
       Web search queries for the following-up web search.
      repeated string web_search_queries = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the webSearchQueries at the given index.

    • hasSearchEntryPoint

      boolean hasSearchEntryPoint()
       Google search entry for the following-up web searches.
      .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint search_entry_point = 4;
      Returns:
      Whether the searchEntryPoint field is set.

    • getSearchEntryPoint

      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:
      The searchEntryPoint.

    • getSearchEntryPointOrBuilder

      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;

    • getGroundingSupportList

      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;

    • getGroundingSupport

      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;

    • getGroundingSupportCount

      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;

    • getGroundingSupportOrBuilderList

      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;

    • getGroundingSupportOrBuilder

      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;