Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::ExecuteToolRequest.
Request message for ToolService.ExecuteTool.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#args
def args() -> ::Google::Protobuf::Struct- (::Google::Protobuf::Struct) — Optional. The input parameters and values for the tool in JSON object format.
#args=
def args=(value) -> ::Google::Protobuf::Struct- value (::Google::Protobuf::Struct) — Optional. The input parameters and values for the tool in JSON object format.
- (::Google::Protobuf::Struct) — Optional. The input parameters and values for the tool in JSON object format.
#context
def context() -> ::Google::Protobuf::Struct-
(::Google::Protobuf::Struct) — Optional. The
ToolCallContext to be passed to the Python tool.
Note: The following fields are mutually exclusive:
context,variables. If a field in that set is populated, all other fields in the set will automatically be cleared.
#context=
def context=(value) -> ::Google::Protobuf::Struct-
value (::Google::Protobuf::Struct) — Optional. The
ToolCallContext to be passed to the Python tool.
Note: The following fields are mutually exclusive:
context,variables. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Protobuf::Struct) — Optional. The
ToolCallContext to be passed to the Python tool.
Note: The following fields are mutually exclusive:
context,variables. If a field in that set is populated, all other fields in the set will automatically be cleared.
#mock_config
def mock_config() -> ::Google::Cloud::Ces::V1beta::MockConfig- (::Google::Cloud::Ces::V1beta::MockConfig) — Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
#mock_config=
def mock_config=(value) -> ::Google::Cloud::Ces::V1beta::MockConfig- value (::Google::Cloud::Ces::V1beta::MockConfig) — Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
- (::Google::Cloud::Ces::V1beta::MockConfig) — Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
#parent
def parent() -> ::String-
(::String) — Required. The resource name of the app which the tool/toolset belongs to.
Format:
projects/{project}/locations/{location}/apps/{app}
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The resource name of the app which the tool/toolset belongs to.
Format:
projects/{project}/locations/{location}/apps/{app}
-
(::String) — Required. The resource name of the app which the tool/toolset belongs to.
Format:
projects/{project}/locations/{location}/apps/{app}
#tool
def tool() -> ::String-
(::String) — Optional. The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool}
Note: The following fields are mutually exclusive:
tool,toolset_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tool=
def tool=(value) -> ::String-
value (::String) — Optional. The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool}
Note: The following fields are mutually exclusive:
tool,toolset_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::String) — Optional. The name of the tool to execute.
Format:
projects/{project}/locations/{location}/apps/{app}/tools/{tool}
Note: The following fields are mutually exclusive:
tool,toolset_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
#toolset_tool
def toolset_tool() -> ::Google::Cloud::Ces::V1beta::ToolsetTool-
(::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the
predicate from the toolset. Otherwise, an error will be returned.
Note: The following fields are mutually exclusive:
toolset_tool,tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
#toolset_tool=
def toolset_tool=(value) -> ::Google::Cloud::Ces::V1beta::ToolsetTool-
value (::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the
predicate from the toolset. Otherwise, an error will be returned.
Note: The following fields are mutually exclusive:
toolset_tool,tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the
predicate from the toolset. Otherwise, an error will be returned.
Note: The following fields are mutually exclusive:
toolset_tool,tool. If a field in that set is populated, all other fields in the set will automatically be cleared.
#variables
def variables() -> ::Google::Protobuf::Struct-
(::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.
Note: The following fields are mutually exclusive:
variables,context. If a field in that set is populated, all other fields in the set will automatically be cleared.
#variables=
def variables=(value) -> ::Google::Protobuf::Struct-
value (::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.
Note: The following fields are mutually exclusive:
variables,context. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.
Note: The following fields are mutually exclusive:
variables,context. If a field in that set is populated, all other fields in the set will automatically be cleared.