Google Cloud Ai Platform V1 Client - Class FunctionResponse (1.35.0)

Version latest

• 1.35.0 (latest)
• 1.34.0
• 1.33.0
• 1.32.1
• 1.31.0
• 1.30.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 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 FunctionResponse.

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

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

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. Matches [FunctionDeclaration.name] and [FunctionCall.name].
↳ response	Google\Protobuf\Struct Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

getName

Required. The name of the function to call.

Matches [FunctionDeclaration.name] and [FunctionCall.name].

Returns
Type	Description
string

setName

Required. The name of the function to call.

Matches [FunctionDeclaration.name] and [FunctionCall.name].

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getResponse

Required. The function response in JSON object format.

Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

Returns
Type	Description
Google\Protobuf\Struct|null

hasResponse

clearResponse

setResponse

Required. The function response in JSON object format.

Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

Parameter
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this