📄 Source: ExecuteToolRequest.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\CustomerEngagementSuite;
class ExecuteToolRequest extends \Google\Model
{
/**
* Optional. The input parameters and values for the tool in JSON object
* format.
*
* @var array[]
*/
public $args;
/**
* Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-
* engagement-ai/conversational-agents/ps/tool/python#environment for details)
* to be passed to the Python tool.
*
* @var array[]
*/
public $context;
protected $mockConfigType = MockConfig::class;
protected $mockConfigDataType = '';
/**
* Optional. The name of the tool to execute. Format:
* projects/{project}/locations/{location}/apps/{app}/tools/{tool}
*
* @var string
*/
public $tool;
protected $toolsetToolType = ToolsetTool::class;
protected $toolsetToolDataType = '';
/**
* Optional. The variables that are available for the tool execution.
*
* @var array[]
*/
public $variables;
/**
* Optional. The input parameters and values for the tool in JSON object
* format.
*
* @param array[] $args
*/
public function setArgs($args)
{
$this->args = $args;
}
/**
* @return array[]
*/
public function getArgs()
{
return $this->args;
}
/**
* Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-
* engagement-ai/conversational-agents/ps/tool/python#environment for details)
* to be passed to the Python tool.
*
* @param array[] $context
*/
public function setContext($context)
{
$this->context = $context;
}
/**
* @return array[]
*/
public function getContext()
{
return $this->context;
}
/**
* 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.
*
* @param MockConfig $mockConfig
*/
public function setMockConfig(MockConfig $mockConfig)
{
$this->mockConfig = $mockConfig;
}
/**
* @return MockConfig
*/
public function getMockConfig()
{
return $this->mockConfig;
}
/**
* Optional. The name of the tool to execute. Format:
* projects/{project}/locations/{location}/apps/{app}/tools/{tool}
*
* @param string $tool
*/
public function setTool($tool)
{
$this->tool = $tool;
}
/**
* @return string
*/
public function getTool()
{
return $this->tool;
}
/**
* Optional. The toolset tool to execute. Only one tool should match the
* predicate from the toolset. Otherwise, an error will be returned.
*
* @param ToolsetTool $toolsetTool
*/
public function setToolsetTool(ToolsetTool $toolsetTool)
{
$this->toolsetTool = $toolsetTool;
}
/**
* @return ToolsetTool
*/
public function getToolsetTool()
{
return $this->toolsetTool;
}
/**
* Optional. The variables that are available for the tool execution.
*
* @param array[] $variables
*/
public function setVariables($variables)
{
$this->variables = $variables;
}
/**
* @return array[]
*/
public function getVariables()
{
return $this->variables;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExecuteToolRequest::class, 'Google_Service_CustomerEngagementSuite_ExecuteToolRequest');
← Back