Google Cloud Ces V1 Client - Class Callback (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class Callback.

A callback defines the custom logic to be executed at various stages of agent interaction.

Generated from protobuf message google.cloud.ces.v1.Callback

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ python_code string

Required. The python code to execute for the callback.

↳ description string

Optional. Human-readable description of the callback.

↳ disabled bool

Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.

↳ proactive_execution_enabled bool

Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. ENABLE WITH CAUTION. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.

getPythonCode

Required. The python code to execute for the callback.

Returns
Type Description
string

hasPythonCode

setPythonCode

Required. The python code to execute for the callback.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Human-readable description of the callback.

Returns
Type Description
string

setDescription

Optional. Human-readable description of the callback.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisabled

Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.

Returns
Type Description
bool

setDisabled

Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.

Parameter
Name Description
var bool
Returns
Type Description
$this

getProactiveExecutionEnabled

Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback.

ENABLE WITH CAUTION. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.

Returns
Type Description
bool

setProactiveExecutionEnabled

Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback.

ENABLE WITH CAUTION. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCallback

Returns
Type Description
string