Skip to content

Commit 730f460

Browse files
committed
Cleanup
1 parent 475c81a commit 730f460

16 files changed

+200
-113
lines changed

config/.eslintrc.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,6 @@ module.exports = {
174174
}
175175
}
176176
],
177-
// We prefer using interfaces, but we need to use types for aliases like '
178-
// '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
179177
'@typescript-eslint/explicit-member-accessibility': [
180178
'error',
181179
{

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.md#backend) | A [Backend](./vertexai.md#backend) 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 backend configuration. |
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.md#backend) instance that specifies the backend configuration.
43+
A [Backend](./vertexai.backend.md#backend_class) instance that specifies the backend configuration.
4444

4545
<b>Signature:</b>
4646

docs-devsite/vertexai.aioptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ export interface AIOptions
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [backend](./vertexai.aioptions.md#aioptionsbackend) | [Backend](./vertexai.md#backend) | The backend configuration to use for the AI service instance. Use [googleAIBackend()](./vertexai.md#googleaibackend) or [vertexAIBackend()](./vertexai.md#vertexaibackend_d0a4534) to create this configuration. |
25+
| [backend](./vertexai.aioptions.md#aioptionsbackend) | [Backend](./vertexai.backend.md#backend_class) | The backend configuration to use for the AI service instance. |
2626

2727
## AIOptions.backend
2828

29-
The backend configuration to use for the AI service instance. Use [googleAIBackend()](./vertexai.md#googleaibackend) or [vertexAIBackend()](./vertexai.md#vertexaibackend_d0a4534) to create this configuration.
29+
The backend configuration to use for the AI service instance.
3030

3131
<b>Signature:</b>
3232

docs-devsite/vertexai.backend.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# 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)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare abstract class Backend
19+
```
20+
21+
## Constructors
22+
23+
| Constructor | Modifiers | Description |
24+
| --- | --- | --- |
25+
| [(constructor)(type)](./vertexai.backend.md#backendconstructor) | | Protected constructor for use by subclasses. |
26+
27+
## Properties
28+
29+
| Property | Modifiers | Type | Description |
30+
| --- | --- | --- | --- |
31+
| [backendType](./vertexai.backend.md#backendbackendtype) | | [BackendType](./vertexai.md#backendtype) | Specifies the backend type (either 'GOOGLE\_AI' or 'VERTEX\_AI'). |
32+
33+
## Backend.(constructor)
34+
35+
Protected constructor for use by subclasses.
36+
37+
<b>Signature:</b>
38+
39+
```typescript
40+
protected constructor(type: BackendType);
41+
```
42+
43+
#### Parameters
44+
45+
| Parameter | Type | Description |
46+
| --- | --- | --- |
47+
| type | [BackendType](./vertexai.md#backendtype) | The specific backend type constant (e.g., BackendType.GOOGLE\_AI). |
48+
49+
## Backend.backendType
50+
51+
Specifies the backend type (either 'GOOGLE\_AI' or 'VERTEX\_AI').
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
readonly backendType: BackendType;
57+
```

docs-devsite/vertexai.citation.md

Lines changed: 6 additions & 2 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 | |
27+
| [publicationDate](./vertexai.citation.md#citationpublicationdate) | Date | This field is not supported in Google AI. |
2828
| [startIndex](./vertexai.citation.md#citationstartindex) | number | |
29-
| [title](./vertexai.citation.md#citationtitle) | string | |
29+
| [title](./vertexai.citation.md#citationtitle) | string | This field is not supported in Google AI. |
3030
| [uri](./vertexai.citation.md#citationuri) | string | |
3131

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

4848
## Citation.publicationDate
4949

50+
This field is not supported in Google AI.
51+
5052
<b>Signature:</b>
5153

5254
```typescript
@@ -63,6 +65,8 @@ startIndex?: number;
6365

6466
## Citation.title
6567

68+
This field is not supported in Google AI.
69+
6670
<b>Signature:</b>
6771

6872
```typescript

docs-devsite/vertexai.counttokensresponse.md

Lines changed: 3 additions & 1 deletion
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. |
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. |
2727
| [totalTokens](./vertexai.counttokensresponse.md#counttokensresponsetotaltokens) | number | The total number of tokens counted across all instances from the request. |
2828

2929
## CountTokensResponse.promptTokensDetails
@@ -40,6 +40,8 @@ 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.
44+
4345
<b>Signature:</b>
4446

4547
```typescript
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# 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)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class GoogleAIBackend extends Backend
19+
```
20+
<b>Extends:</b> [Backend](./vertexai.backend.md#backend_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)()](./vertexai.googleaibackend.md#googleaibackendconstructor) | | Creates a configuration object for the Google AI backend. |
27+
28+
## GoogleAIBackend.(constructor)
29+
30+
Creates a configuration object for the Google AI backend.
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor();
36+
```

docs-devsite/vertexai.imagengenerationconfig.md

Lines changed: 4 additions & 2 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. |
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. |
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. |
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>. |
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
@@ -91,6 +91,8 @@ 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`<!-- -->.
95+
9496
<b>Signature:</b>
9597

9698
```typescript

0 commit comments

Comments
 (0)