Skip to content

Commit 5748005

Browse files
authored
docs: fix doc typos found by g3 presubmit (#9166)
1 parent 9771bff commit 5748005

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs-devsite/ai.groundingmetadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface GroundingMetadata
2929
| [groundingChunks](./ai.groundingmetadata.md#groundingmetadatagroundingchunks) | [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface)<!-- -->\[\] | A list of [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) objects. Each chunk represents a piece of retrieved content (for example, from a web page). that the model used to ground its response. |
3030
| [groundingSupports](./ai.groundingmetadata.md#groundingmetadatagroundingsupports) | [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface)<!-- -->\[\] | A list of [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) objects. Each object details how specific segments of the model's response are supported by the <code>groundingChunks</code>. |
3131
| [retrievalQueries](./ai.groundingmetadata.md#groundingmetadataretrievalqueries) | string\[\] | |
32-
| [searchEntryPoint](./ai.groundingmetadata.md#groundingmetadatasearchentrypoint) | [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | Google Search entry point for web searches. This 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 a model's Grounded Response. |
32+
| [searchEntryPoint](./ai.groundingmetadata.md#groundingmetadatasearchentrypoint) | [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | Google Search entry point for web searches. This 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 a model's "Grounded Response". |
3333
| [webSearchQueries](./ai.groundingmetadata.md#groundingmetadatawebsearchqueries) | string\[\] | A list of web search queries that the model performed to gather the grounding information. These can be used to allow users to explore the search results themselves. |
3434

3535
## GroundingMetadata.groundingChunks
@@ -67,7 +67,7 @@ retrievalQueries?: string[];
6767

6868
## GroundingMetadata.searchEntryPoint
6969

70-
Google Search entry point for web searches. This 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 a model's Grounded Response.
70+
Google Search entry point for web searches. This 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 a model's "Grounded Response".
7171

7272
<b>Signature:</b>
7373

docs-devsite/ai.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The Firebase AI Web SDK.
125125
| [HarmCategory](./ai.md#harmcategory) | Harm categories that would cause prompts or candidates to be blocked. |
126126
| [HarmProbability](./ai.md#harmprobability) | Probability that a prompt or candidate matches a harm category. |
127127
| [HarmSeverity](./ai.md#harmseverity) | Harm severity levels. |
128-
| [ImagenAspectRatio](./ai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!-- -->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.<!-- -->See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios. |
128+
| [ImagenAspectRatio](./ai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!-- -->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios. |
129129
| [ImagenPersonFilterLevel](./ai.md#imagenpersonfilterlevel) | <b><i>(Public Preview)</i></b> A filter level controlling whether generation of images containing people or faces is allowed.<!-- -->See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a> documentation for more details. |
130130
| [ImagenSafetyFilterLevel](./ai.md#imagensafetyfilterlevel) | <b><i>(Public Preview)</i></b> A filter level controlling how aggressively to filter sensitive content.<!-- -->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
131131
| [Modality](./ai.md#modality) | Content part modality. |
@@ -147,7 +147,7 @@ The Firebase AI Web SDK.
147147
| [HarmCategory](./ai.md#harmcategory) | Harm categories that would cause prompts or candidates to be blocked. |
148148
| [HarmProbability](./ai.md#harmprobability) | Probability that a prompt or candidate matches a harm category. |
149149
| [HarmSeverity](./ai.md#harmseverity) | Harm severity levels. |
150-
| [ImagenAspectRatio](./ai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!-- -->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.<!-- -->See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios. |
150+
| [ImagenAspectRatio](./ai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> Aspect ratios for Imagen images.<!-- -->To specify an aspect ratio for generated images, set the <code>aspectRatio</code> property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios. |
151151
| [ImagenPersonFilterLevel](./ai.md#imagenpersonfilterlevel) | <b><i>(Public Preview)</i></b> A filter level controlling whether generation of images containing people or faces is allowed.<!-- -->See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a> documentation for more details. |
152152
| [ImagenSafetyFilterLevel](./ai.md#imagensafetyfilterlevel) | <b><i>(Public Preview)</i></b> A filter level controlling how aggressively to filter sensitive content.<!-- -->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
153153
| [Modality](./ai.md#modality) | Content part modality. |
@@ -435,7 +435,7 @@ Aspect ratios for Imagen images.
435435

436436
To specify an aspect ratio for generated images, set the `aspectRatio` property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.
437437

438-
See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios.
438+
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios.
439439

440440
<b>Signature:</b>
441441

@@ -655,7 +655,7 @@ Aspect ratios for Imagen images.
655655

656656
To specify an aspect ratio for generated images, set the `aspectRatio` property in your [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface)<!-- -->.
657657

658-
See the the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios.
658+
See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) for more details and examples of the supported aspect ratios.
659659

660660
<b>Signature:</b>
661661

docs-devsite/app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ If invoked in an unsupported non-server environment such as a browser.
148148

149149
If [FirebaseServerAppSettings.releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) is defined but the runtime doesn't provide Finalization Registry support.
150150

151-
If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project configuration required for auto-initialization.
151+
If the `FIREBASE_OPTIONS` environment variable does not contain a valid project configuration required for auto-initialization.
152152

153153
## function(libraryKeyOrName, ...)
154154

packages/ai/src/types/imagen/requests.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ export interface ImagenSafetySettings {
215215
* To specify an aspect ratio for generated images, set the `aspectRatio` property in your
216216
* {@link ImagenGenerationConfig}.
217217
*
218-
* See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
218+
* See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
219219
* for more details and examples of the supported aspect ratios.
220220
*
221221
* @beta
@@ -249,7 +249,7 @@ export const ImagenAspectRatio = {
249249
* To specify an aspect ratio for generated images, set the `aspectRatio` property in your
250250
* {@link ImagenGenerationConfig}.
251251
*
252-
* See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
252+
* See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
253253
* for more details and examples of the supported aspect ratios.
254254
*
255255
* @beta

packages/ai/src/types/responses.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ export interface GroundingMetadata {
190190
/**
191191
* Google Search entry point for web searches. This contains an HTML/CSS snippet that must be
192192
* embedded in an app to display a Google Search entry point for follow-up web searches related to
193-
* a model's Grounded Response.
193+
* a model's "Grounded Response".
194194
*/
195195
searchEntryPoint?: SearchEntrypoint;
196196
/**

packages/app/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ export function initializeServerApp(
254254
* @throws If invoked in an unsupported non-server environment such as a browser.
255255
* @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
256256
* provide Finalization Registry support.
257-
* @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
257+
* @throws If the `FIREBASE_OPTIONS` environment variable does not contain a valid project
258258
* configuration required for auto-initialization.
259259
*
260260
* @public

packages/firestore/src/local/indexeddb_persistence.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ export const MAIN_DATABASE = 'main';
127127
* `enablePersistence()` with `{synchronizeTabs:true}`.
128128
*
129129
* In multi-tab mode, if multiple clients are active at the same time, the SDK
130-
* will designate one client as the primary client. An effort is made to pick
130+
* will designate one client as the "primary client". An effort is made to pick
131131
* a visible, network-connected and active client, and this client is
132132
* responsible for letting other clients know about its presence. The primary
133133
* client writes a unique client-generated identifier (the client ID) to
134-
* IndexedDb’s owner store every 4 seconds. If the primary client fails to
134+
* IndexedDb’s "owner" store every 4 seconds. If the primary client fails to
135135
* update this entry, another client can acquire the lease and take over as
136136
* primary.
137137
*

0 commit comments

Comments
 (0)