Skip to content

ai.functiondeclaration.md

Latest commit

 

History

History
68 lines (46 loc) · 2.92 KB

ai.functiondeclaration.md

File metadata and controls

68 lines (46 loc) · 2.92 KB

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 %}

FunctionDeclaration interface

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.

Signature:

export interface FunctionDeclaration

Properties

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.

FunctionDeclaration.description

Description and purpose of the function. Model uses it to decide how and whether to call the function.

Signature:

description: string;

FunctionDeclaration.functionReference

Reference to an actual function to call. Specifying this will cause the function to be called automatically when requested by the model.

Signature:

functionReference?: Function;

FunctionDeclaration.name

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.

Signature:

name: string;

FunctionDeclaration.parameters

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.

Signature:

parameters?: ObjectSchema | ObjectSchemaRequest;