Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::Callback.
A callback defines the custom logic to be executed at various stages of agent interaction.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
Returns
- (::String) — Optional. Human-readable description of the callback.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Human-readable description of the callback.
Returns
- (::String) — Optional. Human-readable description of the callback.
#disabled
def disabled() -> ::Boolean
Returns
- (::Boolean) — Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
#disabled=
def disabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
Returns
- (::Boolean) — Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
#proactive_execution_enabled
def proactive_execution_enabled() -> ::Boolean
Returns
- (::Boolean) — 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.
#proactive_execution_enabled=
def proactive_execution_enabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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
- (::Boolean) — 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.
#python_code
def python_code() -> ::String
Returns
- (::String) — Required. The python code to execute for the callback.
#python_code=
def python_code=(value) -> ::String
Parameter
- value (::String) — Required. The python code to execute for the callback.
Returns
- (::String) — Required. The python code to execute for the callback.