docs-devsite/ai.functiondeclaration.md
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
Structured representation of a function declaration as defined by the OpenAPI 3.0 specification<!-- -->. Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.
<b>Signature:</b>
export interface FunctionDeclaration
| Property | Type | Description |
|---|---|---|
| description | string | Description and purpose of the function. Model uses it to decide how and whether to call the function. |
| functionReference | Function | Reference to an actual function to call. Specifying this will cause the function to be called automatically when requested by the model. |
| name | 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. |
| parameters | ObjectSchema | ObjectSchemaRequest | 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. |
Description and purpose of the function. Model uses it to decide how and whether to call the function.
<b>Signature:</b>
description: string;
Reference to an actual function to call. Specifying this will cause the function to be called automatically when requested by the model.
<b>Signature:</b>
functionReference?: Function;
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.
<b>Signature:</b>
name: string;
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.
<b>Signature:</b>
parameters?: ObjectSchema | ObjectSchemaRequest;