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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. The name of the function to call. Matches [FunctionDeclaration.name]. |
↳ args |
Google\Protobuf\Struct
Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. |
↳ partial_args |
array<PartialArg>
Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. |
↳ will_continue |
bool
Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. |
getName
Optional. The name of the function to call.
Matches [FunctionDeclaration.name].
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. The name of the function to call.
Matches [FunctionDeclaration.name].
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArgs
Optional. The function parameters and values in JSON object format.
See [FunctionDeclaration.parameters] for parameter details.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasArgs
clearArgs
setArgs
Optional. The function parameters and values in JSON object format.
See [FunctionDeclaration.parameters] for parameter details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartialArgs
Optional. The partial argument value of the function call.
If provided, represents the arguments/fields that are streamed incrementally.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<PartialArg> |
|
setPartialArgs
Optional. The partial argument value of the function call.
If provided, represents the arguments/fields that are streamed incrementally.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PartialArg>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWillContinue
Optional. Whether this is the last part of the FunctionCall.
If true, another partial message for the current FunctionCall is expected to follow.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setWillContinue
Optional. Whether this is the last part of the FunctionCall.
If true, another partial message for the current FunctionCall is expected to follow.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|