Skip to content

Commit dd5101b

Browse files
hsubox76hsubox76
committed
Merge branch 'ch-schema' into ch-schema-docs
2 parents 145e5d8 + bd64869 commit dd5101b

35 files changed

+275
-992
lines changed

‎.changeset/large-snakes-march.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'firebase': major
3+
'@firebase/vertexai': major
4+
---
5+
6+
Release VertexAI in Firebase for general availability.

‎.changeset/slimy-cups-promise.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@firebase/functions-compat': patch
3+
'@firebase/functions': patch
4+
---
5+
6+
Remove node bundle from the functions SDK as the node-specific fetch code has been removed in favor of using native fetch throughout the SDK.

‎.github/workflows/canary-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
NPM_TOKEN_STORAGE: ${{secrets.NPM_TOKEN_STORAGE}}
7171
NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
7272
NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
73-
NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}}
73+
NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}}
7474
NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
7575
NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
7676
NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

‎.github/workflows/prerelease-manual-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ jobs:
7373
NPM_TOKEN_STORAGE: ${{secrets.NPM_TOKEN_STORAGE}}
7474
NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
7575
NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
76-
NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}}
76+
NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}}
7777
NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
7878
NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
7979
NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

‎.github/workflows/release-prod.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ jobs:
8383
NPM_TOKEN_STORAGE: ${{secrets.NPM_TOKEN_STORAGE}}
8484
NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
8585
NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
86-
NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}}
86+
NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}}
8787
NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
8888
NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
8989
NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

‎.github/workflows/release-staging.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ jobs:
109109
NPM_TOKEN_STORAGE: ${{secrets.NPM_TOKEN_STORAGE}}
110110
NPM_TOKEN_STORAGE_TYPES: ${{secrets.NPM_TOKEN_STORAGE_TYPES}}
111111
NPM_TOKEN_UTIL: ${{secrets.NPM_TOKEN_UTIL}}
112-
NPM_TOKEN_VERTEXAI_PREVIEW: ${{secrets.NPM_TOKEN_VERTEXAI_PREVIEW}}
112+
NPM_TOKEN_VERTEXAI: ${{secrets.NPM_TOKEN_VERTEXAI}}
113113
NPM_TOKEN_WEBCHANNEL_WRAPPER: ${{secrets.NPM_TOKEN_WEBCHANNEL_WRAPPER}}
114114
NPM_TOKEN_FIREBASE: ${{secrets.NPM_TOKEN_FIREBASE}}
115115
NPM_TOKEN_APP_COMPAT: ${{ secrets.NPM_TOKEN_APP_COMPAT }}

‎common/api-review/vertexai-preview.api.md renamed to ‎common/api-review/vertexai.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## API Report File for "@firebase/vertexai-preview"
1+
## API Report File for "@firebase/vertexai"
22

33
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
44

‎docs-devsite/vertexai-preview.arrayschema.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎docs-devsite/vertexai-preview.booleanschema.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎docs-devsite/vertexai-preview.functiondeclaration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export declare interface FunctionDeclaration
2424
| --- | --- | --- |
2525
| [description](./vertexai-preview.functiondeclaration.md#functiondeclarationdescription) | string | Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. |
2626
| [name](./vertexai-preview.functiondeclaration.md#functiondeclarationname) | string | The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a max length of 64. |
27-
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchemaInterface](./vertexai-preview.objectschemainterface.md#objectschemainterface_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |
27+
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |
2828

2929
## FunctionDeclaration.description
3030

@@ -53,5 +53,5 @@ Optional. Describes the parameters to this function in JSON Schema Object format
5353
<b>Signature:</b>
5454

5555
```typescript
56-
parameters?: ObjectSchemaInterface;
56+
parameters?: FunctionDeclarationSchema;
5757
```

‎docs-devsite/vertexai-preview.functiondeclarationschema.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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+
# FunctionDeclarationSchema interface
13+
Schema for parameters passed to [FunctionDeclaration.parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface FunctionDeclarationSchema
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [description](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemadescription) | string | Optional. Description of the parameter. |
26+
| [properties](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemaproperties) | { \[k: string\]: [FunctionDeclarationSchemaProperty](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemaproperty_interface)<!-- -->; } | The format of the parameter. |
27+
| [required](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemarequired) | string\[\] | Optional. Array of required parameters. |
28+
| [type](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschematype) | [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype) | The type of the parameter. |
29+
30+
## FunctionDeclarationSchema.description
31+
32+
Optional. Description of the parameter.
33+
34+
<b>Signature:</b>
35+
36+
```typescript
37+
description?: string;
38+
```
39+
40+
## FunctionDeclarationSchema.properties
41+
42+
The format of the parameter.
43+
44+
<b>Signature:</b>
45+
46+
```typescript
47+
properties: {
48+
[k: string]: FunctionDeclarationSchemaProperty;
49+
};
50+
```
51+
52+
## FunctionDeclarationSchema.required
53+
54+
Optional. Array of required parameters.
55+
56+
<b>Signature:</b>
57+
58+
```typescript
59+
required?: string[];
60+
```
61+
62+
## FunctionDeclarationSchema.type
63+
64+
The type of the parameter.
65+
66+
<b>Signature:</b>
67+
68+
```typescript
69+
type: FunctionDeclarationSchemaType;
70+
```

‎docs-devsite/vertexai-preview.functiondeclarationschemaproperty.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
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+
# FunctionDeclarationSchemaProperty interface
13+
Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface FunctionDeclarationSchemaProperty
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [description](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertydescription) | string | Optional. The description of the property. |
26+
| [enum](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyenum) | string\[\] | Optional. The enum of the property. |
27+
| [example](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyexample) | unknown | Optional. The example of the property. |
28+
| [format](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyformat) | string | Optional. The format of the property. |
29+
| [items](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyitems) | [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) | Optional. The items of the property. [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) |
30+
| [nullable](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertynullable) | boolean | Optional. Whether the property is nullable. |
31+
| [properties](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyproperties) | { \[k: string\]: [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->; } | Optional. Map of [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->. |
32+
| [required](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyrequired) | string\[\] | Optional. Array of required property. |
33+
| [type](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertytype) | [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype) | Optional. The type of the property. [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype)<!-- -->. |
34+
35+
## FunctionDeclarationSchemaProperty.description
36+
37+
Optional. The description of the property.
38+
39+
<b>Signature:</b>
40+
41+
```typescript
42+
description?: string;
43+
```
44+
45+
## FunctionDeclarationSchemaProperty.enum
46+
47+
Optional. The enum of the property.
48+
49+
<b>Signature:</b>
50+
51+
```typescript
52+
enum?: string[];
53+
```
54+
55+
## FunctionDeclarationSchemaProperty.example
56+
57+
Optional. The example of the property.
58+
59+
<b>Signature:</b>
60+
61+
```typescript
62+
example?: unknown;
63+
```
64+
65+
## FunctionDeclarationSchemaProperty.format
66+
67+
Optional. The format of the property.
68+
69+
<b>Signature:</b>
70+
71+
```typescript
72+
format?: string;
73+
```
74+
75+
## FunctionDeclarationSchemaProperty.items
76+
77+
Optional. The items of the property. [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)
78+
79+
<b>Signature:</b>
80+
81+
```typescript
82+
items?: FunctionDeclarationSchema;
83+
```
84+
85+
## FunctionDeclarationSchemaProperty.nullable
86+
87+
Optional. Whether the property is nullable.
88+
89+
<b>Signature:</b>
90+
91+
```typescript
92+
nullable?: boolean;
93+
```
94+
95+
## FunctionDeclarationSchemaProperty.properties
96+
97+
Optional. Map of [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->.
98+
99+
<b>Signature:</b>
100+
101+
```typescript
102+
properties?: {
103+
[k: string]: FunctionDeclarationSchema;
104+
};
105+
```
106+
107+
## FunctionDeclarationSchemaProperty.required
108+
109+
Optional. Array of required property.
110+
111+
<b>Signature:</b>
112+
113+
```typescript
114+
required?: string[];
115+
```
116+
117+
## FunctionDeclarationSchemaProperty.type
118+
119+
Optional. The type of the property. [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype)<!-- -->.
120+
121+
<b>Signature:</b>
122+
123+
```typescript
124+
type?: FunctionDeclarationSchemaType;
125+
```

0 commit comments

Comments
 (0)