Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::ToolCallResult (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::ToolCallResult.

The result of calling a tool's action that has been executed by the client.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String
Returns
  • (::String) — Required. The name of the tool's action associated with this call.

#action=

def action=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the tool's action associated with this call.
Returns
  • (::String) — Required. The name of the tool's action associated with this call.

#error

def error() -> ::Google::Cloud::Dialogflow::CX::V3::ToolCallResult::Error
Returns

#error=

def error=(value) -> ::Google::Cloud::Dialogflow::CX::V3::ToolCallResult::Error
Parameter
Returns

#output_parameters

def output_parameters() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — The tool call's output parameters.

    Note: The following fields are mutually exclusive: output_parameters, error. If a field in that set is populated, all other fields in the set will automatically be cleared.

#output_parameters=

def output_parameters=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — The tool call's output parameters.

    Note: The following fields are mutually exclusive: output_parameters, error. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — The tool call's output parameters.

    Note: The following fields are mutually exclusive: output_parameters, error. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tool

def tool() -> ::String
Returns
  • (::String) — Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

#tool=

def tool=(value) -> ::String
Parameter
  • value (::String) — Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
Returns
  • (::String) — Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.