Constructor Detail

• GroundingMetadata.Builder

  GroundingMetadata.Builder()

Method Detail

• imageSearchQueries

   abstract GroundingMetadata.Builder imageSearchQueries(List<String> imageSearchQueries)

  Setter for imageSearchQueries.

  imageSearchQueries: Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.

• imageSearchQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder imageSearchQueries(Array<String> imageSearchQueries)

  Setter for imageSearchQueries.

  imageSearchQueries: Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.

• clearImageSearchQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearImageSearchQueries()

  Clears the value of imageSearchQueries field.

• groundingChunks

   abstract GroundingMetadata.Builder groundingChunks(List<GroundingChunk> groundingChunks)

  Setter for groundingChunks.

  groundingChunks: A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

• groundingChunks

  @CanIgnoreReturnValue() GroundingMetadata.Builder groundingChunks(Array<GroundingChunk> groundingChunks)

  Setter for groundingChunks.

  groundingChunks: A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

• groundingChunks

  @CanIgnoreReturnValue() GroundingMetadata.Builder groundingChunks(Array<GroundingChunk.Builder> groundingChunksBuilders)

  Setter for groundingChunks builder.

  groundingChunks: A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

• clearGroundingChunks

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearGroundingChunks()

  Clears the value of groundingChunks field.

• groundingSupports

   abstract GroundingMetadata.Builder groundingSupports(List<GroundingSupport> groundingSupports)

  Setter for groundingSupports.

  groundingSupports: List of grounding support.

• groundingSupports

  @CanIgnoreReturnValue() GroundingMetadata.Builder groundingSupports(Array<GroundingSupport> groundingSupports)

  Setter for groundingSupports.

  groundingSupports: List of grounding support.

• groundingSupports

  @CanIgnoreReturnValue() GroundingMetadata.Builder groundingSupports(Array<GroundingSupport.Builder> groundingSupportsBuilders)

  Setter for groundingSupports builder.

  groundingSupports: List of grounding support.

• clearGroundingSupports

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearGroundingSupports()

  Clears the value of groundingSupports field.

• retrievalMetadata

   abstract GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata retrievalMetadata)

  Setter for retrievalMetadata.

  retrievalMetadata: Metadata related to retrieval in the grounding flow.

• retrievalMetadata

  @CanIgnoreReturnValue() GroundingMetadata.Builder retrievalMetadata(RetrievalMetadata.Builder retrievalMetadataBuilder)

  Setter for retrievalMetadata builder.

  retrievalMetadata: Metadata related to retrieval in the grounding flow.

• clearRetrievalMetadata

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearRetrievalMetadata()

  Clears the value of retrievalMetadata field.

• searchEntryPoint

   abstract GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint searchEntryPoint)

  Setter for searchEntryPoint.

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

• searchEntryPoint

  @CanIgnoreReturnValue() GroundingMetadata.Builder searchEntryPoint(SearchEntryPoint.Builder searchEntryPointBuilder)

  Setter for searchEntryPoint builder.

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

• clearSearchEntryPoint

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearSearchEntryPoint()

  Clears the value of searchEntryPoint field.

• webSearchQueries

   abstract GroundingMetadata.Builder webSearchQueries(List<String> webSearchQueries)

  Setter for webSearchQueries.

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

• webSearchQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder webSearchQueries(Array<String> webSearchQueries)

  Setter for webSearchQueries.

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

• clearWebSearchQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearWebSearchQueries()

  Clears the value of webSearchQueries field.

• googleMapsWidgetContextToken

   abstract GroundingMetadata.Builder googleMapsWidgetContextToken(String googleMapsWidgetContextToken)

  Setter for googleMapsWidgetContextToken.

  googleMapsWidgetContextToken: Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.

• clearGoogleMapsWidgetContextToken

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearGoogleMapsWidgetContextToken()

  Clears the value of googleMapsWidgetContextToken field.

• retrievalQueries

   abstract GroundingMetadata.Builder retrievalQueries(List<String> retrievalQueries)

  Setter for retrievalQueries.

  retrievalQueries: Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. This field is not supported in Gemini API.

• retrievalQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder retrievalQueries(Array<String> retrievalQueries)

  Setter for retrievalQueries.

  retrievalQueries: Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. This field is not supported in Gemini API.

• clearRetrievalQueries

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearRetrievalQueries()

  Clears the value of retrievalQueries field.

• sourceFlaggingUris

   abstract GroundingMetadata.Builder sourceFlaggingUris(List<GroundingMetadataSourceFlaggingUri> sourceFlaggingUris)

  Setter for sourceFlaggingUris.

  sourceFlaggingUris: Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

• sourceFlaggingUris

  @CanIgnoreReturnValue() GroundingMetadata.Builder sourceFlaggingUris(Array<GroundingMetadataSourceFlaggingUri> sourceFlaggingUris)

  Setter for sourceFlaggingUris.

  sourceFlaggingUris: Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

• sourceFlaggingUris

  @CanIgnoreReturnValue() GroundingMetadata.Builder sourceFlaggingUris(Array<GroundingMetadataSourceFlaggingUri.Builder> sourceFlaggingUrisBuilders)

  Setter for sourceFlaggingUris builder.

  sourceFlaggingUris: Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

• clearSourceFlaggingUris

  @CanIgnoreReturnValue() GroundingMetadata.Builder clearSourceFlaggingUris()

  Clears the value of sourceFlaggingUris field.

• build

   abstract GroundingMetadata build()