Package com.google.genai.types

Class GroundingMetadata.Builder

java.lang.Object
com.google.genai.types.GroundingMetadata.Builder
Enclosing class:
GroundingMetadata
public abstract static class GroundingMetadata.Builder extends Object
Builder for GroundingMetadata.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • googleMapsWidgetContextToken

      public abstract GroundingMetadata.Builder googleMapsWidgetContextToken(String googleMapsWidgetContextToken)
      Setter for googleMapsWidgetContextToken.

      googleMapsWidgetContextToken: Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.

    • groundingChunks

      public abstract GroundingMetadata.Builder groundingChunks(List<GroundingChunk> groundingChunks)
      Setter for groundingChunks.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • groundingChunks

      public GroundingMetadata.Builder groundingChunks(GroundingChunk... groundingChunks)
      Setter for groundingChunks.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • groundingChunks

      public GroundingMetadata.Builder groundingChunks(GroundingChunk.Builder... groundingChunksBuilders)
      Setter for groundingChunks builder.

      groundingChunks: List of supporting references retrieved from specified grounding source.

    • groundingSupports

      public abstract GroundingMetadata.Builder groundingSupports(List<GroundingSupport> groundingSupports)
      Setter for groundingSupports.

      groundingSupports: Optional. List of grounding support.

    • groundingSupports

      public GroundingMetadata.Builder groundingSupports(GroundingSupport... groundingSupports)
      Setter for groundingSupports.

      groundingSupports: Optional. List of grounding support.

    • groundingSupports

      public GroundingMetadata.Builder groundingSupports(GroundingSupport.Builder... groundingSupportsBuilders)
      Setter for groundingSupports builder.

      groundingSupports: Optional. List of grounding support.

    • retrievalMetadata

      public abstract GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata retrievalMetadata)
      Setter for retrievalMetadata.

      retrievalMetadata: Optional. Output only. Retrieval metadata.

    • retrievalMetadata

      public GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata.Builder retrievalMetadataBuilder)
      Setter for retrievalMetadata builder.

      retrievalMetadata: Optional. Output only. Retrieval metadata.

    • retrievalQueries

      public abstract GroundingMetadata.Builder retrievalQueries(List<String> retrievalQueries)
      Setter for retrievalQueries.

      retrievalQueries: Optional. Queries executed by the retrieval tools.

    • retrievalQueries

      public GroundingMetadata.Builder retrievalQueries(String... retrievalQueries)
      Setter for retrievalQueries.

      retrievalQueries: Optional. Queries executed by the retrieval tools.

    • searchEntryPoint

      public abstract GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint searchEntryPoint)
      Setter for searchEntryPoint.

      searchEntryPoint: Optional. Google search entry for the following-up web searches.

    • searchEntryPoint

      public GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint.Builder searchEntryPointBuilder)
      Setter for searchEntryPoint builder.

      searchEntryPoint: Optional. Google search entry for the following-up web searches.

    • webSearchQueries

      public abstract GroundingMetadata.Builder webSearchQueries(List<String> webSearchQueries)
      Setter for webSearchQueries.

      webSearchQueries: Optional. Web search queries for the following-up web search.

    • webSearchQueries

      public GroundingMetadata.Builder webSearchQueries(String... webSearchQueries)
      Setter for webSearchQueries.

      webSearchQueries: Optional. Web search queries for the following-up web search.

    • build

      public abstract GroundingMetadata build()