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 \ V1Methods
__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, dots 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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. 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, dots 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, dots 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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. 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. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. 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 |
|