You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A tool that allows the generative model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.
13
+
A tool that allows a Gemini model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.
14
14
15
-
When using Grounding with Google Search, you may receive a response with data generated from Google's search engine. This response is a "Grounded Result" subject to the Grounding with Google Search terms in the [Service Specific Terms](https://cloud.google.com/terms/service-terms)<!---->.
15
+
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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms) (see Service Terms section within the Service Specific Terms).
| [googleSearch](./ai.googlesearchtool.md#googlesearchtoolgooglesearch) | [GoogleSearch](./ai.googlesearch.md#googlesearch_interface) | SpecifiestheGoogleSearchconfiguration. Currently, thisisanemptyobject, butit'sreservedforfutureconfigurationoptions. SpecifiestheGoogleSearchconfiguration. Currently, thisisanemptyobject, butit'sreservedforfutureconfigurationoptions.<!-- -->Whenusingthisfeature, youarerequiredtocomplywiththe "GroundingwithGoogleSearch" usagerequirementsforyourchosenAPIprovider: [GeminiDeveloperAPI](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms) (see Service Terms section within the Service Specific Terms). |
Whenusingthisfeature, youarerequiredtocomplywiththe "GroundingwithGoogleSearch" usagerequirementsforyourchosenAPIprovider: [GeminiDeveloperAPI](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms) (see Service Terms section within the Service Specific Terms).
Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled.
14
14
15
-
Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Currently, the only way to use grounding is to include a [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface) in your [GenerationConfig](./ai.generationconfig.md#generationconfig_interface)<!---->.
15
+
Currently, only Grounding with Google Search is supported (see [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)<!---->).
16
16
17
-
Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms)for "Grounding with Google Search".
17
+
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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms)(see Service Terms section within the Service Specific Terms).
Important: IfusingGroundingwithGoogleSearch, youarerequiredtocomplywiththe [ServiceSpecificTerms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Important: IfusingGroundingwithGoogleSearch, youarerequiredtocomplywiththe [ServiceSpecificTerms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Important: IfusingGroundingwithGoogleSearch, youarerequiredtocomplywiththe [ServiceSpecificTerms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Important: IfusingGroundingwithGoogleSearch, youarerequiredtocomplywiththe [ServiceSpecificTerms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks.
14
14
15
-
Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
Copy file name to clipboardExpand all lines: docs-devsite/ai.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -95,12 +95,12 @@ The Firebase AI Web SDK.
95
95
|[GenerateContentStreamResult](./ai.generatecontentstreamresult.md#generatecontentstreamresult_interface)| Result object returned from [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) call. Iterate over <code>stream</code> to get chunks as they come in and/or use the <code>response</code> promise to get the aggregated response when the stream is done. |
96
96
|[GenerationConfig](./ai.generationconfig.md#generationconfig_interface)| Config options for content-related requests |
97
97
|[GenerativeContentBlob](./ai.generativecontentblob.md#generativecontentblob_interface)| Interface for sending an image. |
98
-
|[GoogleSearch](./ai.googlesearch.md#googlesearch_interface)|Configuration for the [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)<!---->. |
99
-
|[GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)| A tool that allows the generative model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.<!---->When using Grounding with Google Search, you may receive a response with data generated from Google's search engine. This response is a "Grounded Result" subject to the Grounding with Google Search terms in the [Service Specific Terms](https://cloud.google.com/terms/service-terms)<!---->. |
98
+
|[GoogleSearch](./ai.googlesearch.md#googlesearch_interface)|Specifies the Google Search configuration. |
99
+
|[GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)| A tool that allows a Gemini model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.<!---->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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms) (see Service Terms section within the Service Specific Terms). |
|[GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface)| Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled.<!---->Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".|
102
-
|[GroundingMetadata](./ai.groundingmetadata.md#groundingmetadata_interface)| Metadata returned when grounding is enabled.<!---->Currently, the only way to use grounding is to include a [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface) in your [GenerationConfig](./ai.generationconfig.md#generationconfig_interface)<!---->.<!---->Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms)for "Grounding with Google Search". |
103
-
|[GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface)| Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks.<!---->Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".|
101
+
|[GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface)| Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled. |
102
+
|[GroundingMetadata](./ai.groundingmetadata.md#groundingmetadata_interface)| Metadata returned when grounding is enabled.<!---->Currently, only Grounding with Google Search is supported (see [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)<!---->).<!---->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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or [Vertex AI Gemini API](https://cloud.google.com/terms/service-terms)(see Service Terms section within the Service Specific Terms). |
103
+
|[GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface)| Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks. |
104
104
|[ImagenGCSImage](./ai.imagengcsimage.md#imagengcsimage_interface)| An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.<!---->This feature is not available yet. |
105
105
|[ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)| <b><i>(Public Preview)</i></b> Configuration options for generating images with Imagen.<!---->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images-imagen) for more details. |
106
106
|[ImagenGenerationResponse](./ai.imagengenerationresponse.md#imagengenerationresponse_interface)| <b><i>(Public Preview)</i></b> The response from a request to generate images with Imagen. |
@@ -120,7 +120,7 @@ The Firebase AI Web SDK.
120
120
|[SchemaParams](./ai.schemaparams.md#schemaparams_interface)| Params passed to [Schema](./ai.schema.md#schema_class) static methods to create specific [Schema](./ai.schema.md#schema_class) classes. |
121
121
|[SchemaRequest](./ai.schemarequest.md#schemarequest_interface)| Final format for [Schema](./ai.schema.md#schema_class) params passed to backend requests. |
122
122
|[SchemaShared](./ai.schemashared.md#schemashared_interface)| Basic [Schema](./ai.schema.md#schema_class) properties shared across several Schema-related types. |
123
-
|[SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface)| Google search entry point.<!---->Important: If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".|
123
+
|[SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface)| Google search entry point. |
124
124
|[Segment](./ai.segment.md#segment_interface)| Represents a specific segment within a [Content](./ai.content.md#content_interface) object, often used to pinpoint the exact location of text or data that grounding information refers to. |
125
125
|[StartChatParams](./ai.startchatparams.md#startchatparams_interface)| Params for [GenerativeModel.startChat()](./ai.generativemodel.md#generativemodelstartchat)<!---->. |
126
126
|[TextPart](./ai.textpart.md#textpart_interface)| Content part interface if the part represents a text string. |
0 commit comments