Gemini Enterprise for Customer Experience v1 API - Class ExecuteToolRequest (1.0.0) 

public sealed class ExecuteToolRequest : IMessage<ExecuteToolRequest>, IEquatable<ExecuteToolRequest>, IDeepCloneable<ExecuteToolRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class ExecuteToolRequest.

Request message for [ToolService.ExecuteTool][google.cloud.ces.v1.ToolService.ExecuteTool].

Inheritance

object > ExecuteToolRequest

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

ExecuteToolRequest()

public ExecuteToolRequest()

ExecuteToolRequest(ExecuteToolRequest)

public ExecuteToolRequest(ExecuteToolRequest other)
Parameter
Name Description
other ExecuteToolRequest

Properties

Args

public Struct Args { get; set; }

Optional. The input parameters and values for the tool in JSON object format.

Property Value
Type Description
Struct

Context

public Struct Context { get; set; }

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.

Property Value
Type Description
Struct

HasTool

public bool HasTool { get; }

Gets whether the "tool" field is set

Property Value
Type Description
bool

MockConfig

public MockConfig MockConfig { get; set; }

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.

Property Value
Type Description
MockConfig

Parent

public string Parent { get; set; }

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

Property Value
Type Description
string

ParentAsAppName

public AppName ParentAsAppName { get; set; }

AppName-typed view over the Parent resource name property.

Property Value
Type Description
AppName

Tool

public string Tool { get; set; }

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Property Value
Type Description
string

ToolAsToolName

public ToolName ToolAsToolName { get; set; }

ToolName-typed view over the Tool resource name property.

Property Value
Type Description
ToolName

ToolExecutionContextCase

public ExecuteToolRequest.ToolExecutionContextOneofCase ToolExecutionContextCase { get; }
Property Value
Type Description
ExecuteToolRequestToolExecutionContextOneofCase

ToolIdentifierCase

public ExecuteToolRequest.ToolIdentifierOneofCase ToolIdentifierCase { get; }
Property Value
Type Description
ExecuteToolRequestToolIdentifierOneofCase

ToolsetTool

public ToolsetTool ToolsetTool { get; set; }

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Property Value
Type Description
ToolsetTool

Variables

public Struct Variables { get; set; }

Optional. The variables that are available for the tool execution.

Property Value
Type Description
Struct