Skip to content

Commit 1a41a92

Browse files
committed
Use Gemini Developer API and Gemini API in Vertex AI naming in docs
1 parent 4b6ab32 commit 1a41a92

29 files changed

+151
-95
lines changed

docs-devsite/vertexai.ai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface AI
2525
| Property | Type | Description |
2626
| --- | --- | --- |
2727
| [app](./vertexai.ai.md#aiapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [AI](./vertexai.ai.md#ai_interface) instance is associated with. |
28-
| [backend](./vertexai.ai.md#aibackend) | [Backend](./vertexai.backend.md#backend_class) | A [Backend](./vertexai.backend.md#backend_class) instance that specifies the backend configuration. |
28+
| [backend](./vertexai.ai.md#aibackend) | [Backend](./vertexai.backend.md#backend_class) | A [Backend](./vertexai.backend.md#backend_class) instance that specifies the configuration for the target backend, either the Gemini Developer API (using [GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->) or the Gemini API in Vertex AI (using [VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->). |
2929
| [location](./vertexai.ai.md#ailocation) | string | The location configured for this AI service instance, relevant for Vertex AI backends. |
3030

3131
## AI.app
@@ -40,7 +40,7 @@ app: FirebaseApp;
4040

4141
## AI.backend
4242

43-
A [Backend](./vertexai.backend.md#backend_class) instance that specifies the backend configuration.
43+
A [Backend](./vertexai.backend.md#backend_class) instance that specifies the configuration for the target backend, either the Gemini Developer API (using [GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->) or the Gemini API in Vertex AI (using [VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->).
4444

4545
<b>Signature:</b>
4646

docs-devsite/vertexai.aimodel.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
1212
# AIModel class
1313
Base class for Firebase AI model APIs.
1414

15+
Instances of this class are associated with a specific Firebase AI backend (either the Gemini API in Vertex AI or the Gemini Developer API via Google AI) and provide methods for interacting with the configured generative model.
16+
1517
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AIModel` class.
1618

1719
<b>Signature:</b>

docs-devsite/vertexai.aioptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# AIOptions interface
13-
Options interface for initializing the AI service using [getAI()](./vertexai.md#getai_a94a413)<!-- -->.
13+
Options for initializing the AI service using [getAI()](./vertexai.md#getai_a94a413)<!-- -->. This allows specifying which backend to use (Gemini API in Vertex AI or Gemini Developer API) and configuring its specific options (like location for Vertex AI).
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# Backend class
13-
Abstract base class representing the configuration for an AI service backend. This class should not be instantiated directly. Use its subclasses [GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class) or [VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->.
13+
Abstract base class representing the configuration for an AI service backend, determining whether to use the Gemini Developer API (via Google AI) or the Gemini API in Vertex AI. This class should not be instantiated directly. Use its subclasses: - [GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->: For the Gemini Developer API (via Google AI). - [VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->: For the Gemini API in Vertex AI.
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.citation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ export interface Citation
2424
| --- | --- | --- |
2525
| [endIndex](./vertexai.citation.md#citationendindex) | number | |
2626
| [license](./vertexai.citation.md#citationlicense) | string | |
27-
| [publicationDate](./vertexai.citation.md#citationpublicationdate) | Date | This field is not supported in Google AI. |
27+
| [publicationDate](./vertexai.citation.md#citationpublicationdate) | Date | The publication date of the cited source, if available.<!-- -->This property is only supported in the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->). |
2828
| [startIndex](./vertexai.citation.md#citationstartindex) | number | |
29-
| [title](./vertexai.citation.md#citationtitle) | string | This field is not supported in Google AI. |
29+
| [title](./vertexai.citation.md#citationtitle) | string | The title of the cited source, if available.<!-- -->This property is only supported in the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->). |
3030
| [uri](./vertexai.citation.md#citationuri) | string | |
3131

3232
## Citation.endIndex
@@ -47,7 +47,9 @@ license?: string;
4747

4848
## Citation.publicationDate
4949

50-
This field is not supported in Google AI.
50+
The publication date of the cited source, if available.
51+
52+
This property is only supported in the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->).
5153

5254
<b>Signature:</b>
5355

@@ -65,7 +67,9 @@ startIndex?: number;
6567

6668
## Citation.title
6769

68-
This field is not supported in Google AI.
70+
The title of the cited source, if available.
71+
72+
This property is only supported in the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->).
6973

7074
<b>Signature:</b>
7175

docs-devsite/vertexai.counttokensresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface CountTokensResponse
2323
| Property | Type | Description |
2424
| --- | --- | --- |
2525
| [promptTokensDetails](./vertexai.counttokensresponse.md#counttokensresponseprompttokensdetails) | [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface)<!-- -->\[\] | The breakdown, by modality, of how many tokens are consumed by the prompt. |
26-
| [totalBillableCharacters](./vertexai.counttokensresponse.md#counttokensresponsetotalbillablecharacters) | number | The total number of billable characters counted across all instances from the request.<!-- -->This field is not supported in Google AI, so it will default to 0 when using Google AI. |
26+
| [totalBillableCharacters](./vertexai.counttokensresponse.md#counttokensresponsetotalbillablecharacters) | number | The total number of billable characters counted across all instances from the request.<!-- -->This property is only supported when using the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->). When using the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->), this property is not supported and will default to 0. |
2727
| [totalTokens](./vertexai.counttokensresponse.md#counttokensresponsetotaltokens) | number | The total number of tokens counted across all instances from the request. |
2828

2929
## CountTokensResponse.promptTokensDetails
@@ -40,7 +40,7 @@ promptTokensDetails?: ModalityTokenCount[];
4040

4141
The total number of billable characters counted across all instances from the request.
4242

43-
This field is not supported in Google AI, so it will default to 0 when using Google AI.
43+
This property is only supported when using the Gemini API in Vertex AI ([VertexAIBackend](./vertexai.vertexaibackend.md#vertexaibackend_class)<!-- -->). When using the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->), this property is not supported and will default to 0.
4444

4545
<b>Signature:</b>
4646

docs-devsite/vertexai.googleaibackend.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# GoogleAIBackend class
13-
Represents the configuration class for the Google AI backend. Use this with [AIOptions](./vertexai.aioptions.md#aioptions_interface) when initializing the service with [getAI()](./vertexai.md#getai_a94a413)<!-- -->.
13+
Configuration class for the Gemini Developer API (using Google AI).
14+
15+
Use this with [AIOptions](./vertexai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./vertexai.md#getai_a94a413) to specify the Gemini Developer API as the backend.
1416

1517
<b>Signature:</b>
1618

docs-devsite/vertexai.imagengenerationconfig.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ export interface ImagenGenerationConfig
2727

2828
| Property | Type | Description |
2929
| --- | --- | --- |
30-
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->For Imagen 3 models, the default value is <code>true</code>; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">addWatermark</a> documentation for more details.<!-- -->In Google AI, the default value is true, and it cannot be turned off. |
30+
| [addWatermark](./vertexai.imagengenerationconfig.md#imagengenerationconfigaddwatermark) | boolean | <b><i>(Public Preview)</i></b> Whether to add an invisible watermark to generated images.<!-- -->If set to <code>true</code>, an invisible SynthID watermark is embedded in generated images to indicate that they are AI generated. If set to <code>false</code>, watermarking will be disabled.<!-- -->For Imagen 3 models, the default value is <code>true</code>; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">addWatermark</a> documentation for more details.<!-- -->When using the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->), this will default to true, and cannot be turned off. |
3131
| [aspectRatio](./vertexai.imagengenerationconfig.md#imagengenerationconfigaspectratio) | [ImagenAspectRatio](./vertexai.md#imagenaspectratio) | <b><i>(Public Preview)</i></b> The aspect ratio of the generated images. The default value is square 1:1. Supported aspect ratios depend on the Imagen model, see [ImagenAspectRatio](./vertexai.md#imagenaspectratio) for more details. |
3232
| [imageFormat](./vertexai.imagengenerationconfig.md#imagengenerationconfigimageformat) | [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | <b><i>(Public Preview)</i></b> The image format of the generated images. The default is PNG.<!-- -->See [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) for more details. |
33-
| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | <b><i>(Public Preview)</i></b> A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details.<!-- -->This is no longer supported in Google AI in versions greater than <code>imagen-3.0-generate-002</code>. |
33+
| [negativePrompt](./vertexai.imagengenerationconfig.md#imagengenerationconfignegativeprompt) | string | <b><i>(Public Preview)</i></b> A description of what should be omitted from the generated images.<!-- -->Support for negative prompts depends on the Imagen model.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details.<!-- -->This is no longer supported in the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->) in versions greater than <code>imagen-3.0-generate-002</code>. |
3434
| [numberOfImages](./vertexai.imagengenerationconfig.md#imagengenerationconfignumberofimages) | number | <b><i>(Public Preview)</i></b> The number of images to generate. The default value is 1.<!-- -->The number of sample images that may be generated in each request depends on the model (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">sampleCount</a> documentation for more details. |
3535

3636
## ImagenGenerationConfig.addWatermark
@@ -44,7 +44,7 @@ If set to `true`<!-- -->, an invisible SynthID watermark is embedded in generate
4444

4545
For Imagen 3 models, the default value is `true`<!-- -->; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">addWatermark</a> documentation for more details.
4646

47-
In Google AI, the default value is true, and it cannot be turned off.
47+
When using the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->), this will default to true, and cannot be turned off.
4848

4949
<b>Signature:</b>
5050

@@ -91,7 +91,7 @@ Support for negative prompts depends on the Imagen model.
9191

9292
See the [documentation](http://firebase.google.com/docs/vertex-ai/model-parameters#imagen) for more details.
9393

94-
This is no longer supported in Google AI in versions greater than `imagen-3.0-generate-002`<!-- -->.
94+
This is no longer supported in the Gemini Developer API ([GoogleAIBackend](./vertexai.googleaibackend.md#googleaibackend_class)<!-- -->) in versions greater than `imagen-3.0-generate-002`<!-- -->.
9595

9696
<b>Signature:</b>
9797

0 commit comments

Comments
 (0)