Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::ToolUse.
Stores metadata of the invocation of an action supported by a tool.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#action
def action() -> ::String
Returns
- (::String) — Optional. Name of the action to be called during the tool use.
#action=
def action=(value) -> ::String
Parameter
- value (::String) — Optional. Name of the action to be called during the tool use.
Returns
- (::String) — Optional. Name of the action to be called during the tool use.
#display_name
def display_name() -> ::String
Returns
- (::String) — Output only. The display name of the tool.
#input_action_parameters
def input_action_parameters() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Optional. A list of input parameters for the action.
#input_action_parameters=
def input_action_parameters=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Optional. A list of input parameters for the action.
Returns
- (::Google::Protobuf::Struct) — Optional. A list of input parameters for the action.
#output_action_parameters
def output_action_parameters() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Optional. A list of output parameters generated by the action.
#output_action_parameters=
def output_action_parameters=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Optional. A list of output parameters generated by the action.
Returns
- (::Google::Protobuf::Struct) — Optional. A list of output parameters generated by the action.
#tool
def tool() -> ::String
Returns
-
(::String) — Required. The tool that should be
used. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
#tool=
def tool=(value) -> ::String
Parameter
-
value (::String) — Required. The tool that should be
used. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
Returns
-
(::String) — Required. The tool that should be
used. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.