Skip to content

Commit 562735c

Browse files
committed
regen docs
1 parent 9a9d1c6 commit 562735c

File tree

6 files changed

+11
-55
lines changed

6 files changed

+11
-55
lines changed

common/api-review/ai.api.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ export interface FunctionCallPart {
280280
export interface FunctionDeclaration {
281281
description: string;
282282
name: string;
283-
parameters?: ObjectSchemaInterface;
283+
parameters?: ObjectSchema | ObjectSchemaRequest;
284284
}
285285

286286
// @public
@@ -702,9 +702,8 @@ export class ObjectSchema extends Schema {
702702
}
703703

704704
// @public
705-
export interface ObjectSchemaInterface extends SchemaInterface {
706-
// (undocumented)
707-
optionalProperties?: string[];
705+
export interface ObjectSchemaRequest extends SchemaRequest {
706+
optionalProperties?: never;
708707
// (undocumented)
709708
type: SchemaType.OBJECT;
710709
}

docs-devsite/_toc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ toc:
108108
path: /docs/reference/js/ai.numberschema.md
109109
- title: ObjectSchema
110110
path: /docs/reference/js/ai.objectschema.md
111-
- title: ObjectSchemaInterface
112-
path: /docs/reference/js/ai.objectschemainterface.md
111+
- title: ObjectSchemaRequest
112+
path: /docs/reference/js/ai.objectschemarequest.md
113113
- title: PromptFeedback
114114
path: /docs/reference/js/ai.promptfeedback.md
115115
- title: RequestOptions

docs-devsite/ai.functiondeclaration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export declare interface FunctionDeclaration
2424
| --- | --- | --- |
2525
| [description](./ai.functiondeclaration.md#functiondeclarationdescription) | string | Description and purpose of the function. Model uses it to decide how and whether to call the function. |
2626
| [name](./ai.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](./ai.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchemaInterface](./ai.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](./ai.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchema](./ai.objectschema.md#objectschema_class) \| [ObjectSchemaRequest](./ai.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

docs-devsite/ai.md

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

docs-devsite/ai.objectschemainterface.md

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

docs-devsite/vertexai.objectschemarequest.md renamed to docs-devsite/ai.objectschemarequest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# 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.
13+
Interface for JSON parameters in [SchemaType.OBJECT](./ai.md#schematypeobject_enummember) format when not using the [ObjectSchema](./ai.objectschema.md#objectschema_class) helper.
1414

1515
<b>Signature:</b>
1616

1717
```typescript
1818
export interface ObjectSchemaRequest extends SchemaRequest
1919
```
20-
<b>Extends:</b> [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)
20+
<b>Extends:</b> [SchemaRequest](./ai.schemarequest.md#schemarequest_interface)
2121
2222
## Properties
2323
2424
| Property | Type | Description |
2525
| --- | --- | --- |
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) | |
26+
| [optionalProperties](./ai.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](./ai.objectschemarequest.md#objectschemarequesttype) | [SchemaType.OBJECT](./ai.md#schematypeobject_enummember) | |
2828
2929
## ObjectSchemaRequest.optionalProperties
3030

0 commit comments

Comments
 (0)