Skip to content

Commit 24d05ab

Browse files
committed
Generate docs
1 parent 9f75fd5 commit 24d05ab

File tree

5 files changed

+50
-48
lines changed

5 files changed

+50
-48
lines changed

docs-devsite/_toc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@ toc:
564564
path: /docs/reference/js/vertexai.numberschema.md
565565
- title: ObjectSchema
566566
path: /docs/reference/js/vertexai.objectschema.md
567-
- title: ObjectSchemaInterface
568-
path: /docs/reference/js/vertexai.objectschemainterface.md
567+
- title: ObjectSchemaRequest
568+
path: /docs/reference/js/vertexai.objectschemarequest.md
569569
- title: PromptFeedback
570570
path: /docs/reference/js/vertexai.promptfeedback.md
571571
- title: RequestOptions

docs-devsite/vertexai.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.functiondeclaration.md#functiondeclarationdescription) | string | Description and purpose of the function. Model uses it to decide how and whether to call the function. |
2626
| [name](./vertexai.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.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchemaInterface](./vertexai.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.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchema](./vertexai.objectschema.md#objectschema_class) \| [ObjectSchemaRequest](./vertexai.objectschemarequest.md#objectschemarequest_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?: ObjectSchema | ObjectSchemaRequest;
5757
```

docs-devsite/vertexai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The Vertex AI in Firebase Web SDK.
100100
| [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
101101
| [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface) | Represents token counting info for a single modality. |
102102
| [ModelParams](./vertexai.modelparams.md#modelparams_interface) | Params passed to [getGenerativeModel()](./vertexai.md#getgenerativemodel_e3037c9)<!-- -->. |
103-
| [ObjectSchemaInterface](./vertexai.objectschemainterface.md#objectschemainterface_interface) | Interface for [ObjectSchema](./vertexai.objectschema.md#objectschema_class) class. |
103+
| [ObjectSchemaRequest](./vertexai.objectschemarequest.md#objectschemarequest_interface) | Interface for JSON parameters in [SchemaType.OBJECT](./vertexai.md#schematypeobject_enummember) format when not using the [ObjectSchema](./vertexai.objectschema.md#objectschema_class) helper. |
104104
| [PromptFeedback](./vertexai.promptfeedback.md#promptfeedback_interface) | If the prompt was blocked, this will be populated with <code>blockReason</code> and the relevant <code>safetyRatings</code>. |
105105
| [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) | Params passed to [getGenerativeModel()](./vertexai.md#getgenerativemodel_e3037c9)<!-- -->. |
106106
| [RetrievedContextAttribution](./vertexai.retrievedcontextattribution.md#retrievedcontextattribution_interface) | |

docs-devsite/vertexai.objectschemainterface.md

Lines changed: 0 additions & 43 deletions
This file was deleted.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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+
# ObjectSchemaRequest interface
13+
Interface for JSON parameters in [SchemaType.OBJECT](./vertexai.md#schematypeobject_enummember) format when not using the [ObjectSchema](./vertexai.objectschema.md#objectschema_class) helper.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface ObjectSchemaRequest extends SchemaRequest
19+
```
20+
<b>Extends:</b> [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)
21+
22+
## Properties
23+
24+
| Property | Type | Description |
25+
| --- | --- | --- |
26+
| [optionalProperties](./vertexai.objectschemarequest.md#objectschemarequestoptionalproperties) | never | This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the <code>Schema.object()</code> helper method. |
27+
| [type](./vertexai.objectschemarequest.md#objectschemarequesttype) | [SchemaType.OBJECT](./vertexai.md#schematypeobject_enummember) | |
28+
29+
## ObjectSchemaRequest.optionalProperties
30+
31+
This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the `Schema.object()` helper method.
32+
33+
<b>Signature:</b>
34+
35+
```typescript
36+
optionalProperties?: never;
37+
```
38+
39+
## ObjectSchemaRequest.type
40+
41+
<b>Signature:</b>
42+
43+
```typescript
44+
type: SchemaType.OBJECT;
45+
```

0 commit comments

Comments
 (0)