Google Cloud Ai Platform V1 Client - Class FunctionCall (0.31.0)

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

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the function to call. Matches [FunctionDeclaration.name].

↳ args Google\Protobuf\Struct

Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

getName

Required. The name of the function to call.

Matches [FunctionDeclaration.name].

Returns
TypeDescription
string

setName

Required. The name of the function to call.

Matches [FunctionDeclaration.name].

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getArgs

Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasArgs

clearArgs

setArgs

Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this