Google Cloud Ai Platform V1 Client - Class FunctionDeclaration (0.32.0)

Version 0.32.0

• 0.39.0 (latest)
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FunctionDeclaration.

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.

Generated from protobuf message google.cloud.aiplatform.v1.FunctionDeclaration

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. 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 maximum length of 64.
↳ description	string Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
↳ parameters	Google\Cloud\AIPlatform\V1\Schema Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1

getName

Required. 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 maximum length of 64.

Returns
Type	Description
string

setName

Required. 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 maximum length of 64.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. Description and purpose of the function.

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

Returns
Type	Description
string

setDescription

Optional. Description and purpose of the function.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getParameters

Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required:

• param1

Returns
Type	Description
Google\Cloud\AIPlatform\V1\Schema|null

hasParameters

clearParameters

setParameters

Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required:

• param1

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\Schema

Returns
Type	Description
$this