Stay organized with collections
Save and categorize content based on your preferences.
Metadata returned to the client when grounding is enabled.
Summary
Important: If using Grounding with Google Search, you are required to comply with the "Grounding with Google Search" usage requirements for your chosen API provider: Gemini Developer API or Vertex AI Gemini API (see Service Terms section within the Service Specific Terms).
Properties
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-24 UTC.
[null,null,["Last updated 2025-07-24 UTC."],[],[],null,["# Firebase.AI.GroundingMetadata Struct Reference\n\nFirebase.AI.GroundingMetadata\n=============================\n\nMetadata returned to the client when grounding is enabled.\n\nSummary\n-------\n\nImportant: If using Grounding with Google Search, you are required to comply with the \"Grounding with Google Search\" usage requirements for your chosen API provider: [Gemini Developer API](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or Vertex [AI](/docs/reference/unity/namespace/firebase/a-i#namespace_firebase_1_1_a_i) Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) section within the Service Specific Terms).\n\n| ### Properties ||\n|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [GroundingChunks](#struct_firebase_1_1_a_i_1_1_grounding_metadata_1ac10d0ba8af5e1f742a0e9978bd809ea5) | `IReadOnlyList\u003c `[GroundingChunk](/docs/reference/unity/struct/firebase/a-i/grounding-chunk#struct_firebase_1_1_a_i_1_1_grounding_chunk)` \u003e` A list of [GroundingChunk](/docs/reference/unity/struct/firebase/a-i/grounding-chunk#struct_firebase_1_1_a_i_1_1_grounding_chunk) structs. |\n| [GroundingSupports](#struct_firebase_1_1_a_i_1_1_grounding_metadata_1ae105e8e1d2a03af11eff5dbfedca6eb3) | `IReadOnlyList\u003c `[GroundingSupport](/docs/reference/unity/struct/firebase/a-i/grounding-support#struct_firebase_1_1_a_i_1_1_grounding_support)` \u003e` A list of [GroundingSupport](/docs/reference/unity/struct/firebase/a-i/grounding-support#struct_firebase_1_1_a_i_1_1_grounding_support) structs. |\n| [SearchEntryPoint](#struct_firebase_1_1_a_i_1_1_grounding_metadata_1a2cd951761d448f0cd6a4da15fde292e0) | [SearchEntryPoint](/docs/reference/unity/struct/firebase/a-i/search-entry-point#struct_firebase_1_1_a_i_1_1_search_entry_point) Google Search entry point for web searches. |\n| [WebSearchQueries](#struct_firebase_1_1_a_i_1_1_grounding_metadata_1a77c935a95b0a23ffc096575640177745) | `IReadOnlyList\u003c string \u003e` A list of web search queries that the model performed to gather the grounding information. |\n\nProperties\n----------\n\n### GroundingChunks\n\n```c#\nIReadOnlyList\u003c GroundingChunk \u003e Firebase::AI::GroundingMetadata::GroundingChunks\n``` \nA list of [GroundingChunk](/docs/reference/unity/struct/firebase/a-i/grounding-chunk#struct_firebase_1_1_a_i_1_1_grounding_chunk) structs.\n\nEach chunk represents a piece of retrieved content (e.g., from a web page) that the model used to ground its response. \n\n### GroundingSupports\n\n```c#\nIReadOnlyList\u003c GroundingSupport \u003e Firebase::AI::GroundingMetadata::GroundingSupports\n``` \nA list of [GroundingSupport](/docs/reference/unity/struct/firebase/a-i/grounding-support#struct_firebase_1_1_a_i_1_1_grounding_support) structs.\n\nEach object details how specific segments of the model's response are supported by the `groundingChunks`. \n\n### SearchEntryPoint\n\n```c#\nSearchEntryPoint Firebase::AI::GroundingMetadata::SearchEntryPoint\n``` \nGoogle Search entry point for web searches.\n\nThis contains an HTML/CSS snippet that **must** be embedded in an app to display a Google Search entry point for follow-up web searches related to the model's \"Grounded Response\". \n\n### WebSearchQueries\n\n```c#\nIReadOnlyList\u003c string \u003e Firebase::AI::GroundingMetadata::WebSearchQueries\n``` \nA list of web search queries that the model performed to gather the grounding information.\n\nThese can be used to allow users to explore the search results themselves."]]
