Class ExecuteToolRequest

Request message for ToolService.ExecuteTool.

Inheritance

object

ExecuteToolRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CustomerEngagementSuite.v1.Data

Assembly: Google.Apis.CustomerEngagementSuite.v1.dll

Syntax

public class ExecuteToolRequest : IDirectResponseSchema

Properties

Args

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

Declaration

[JsonProperty("args")]
public virtual IDictionary<string, object> Args { get; set; }

Property Value

Type	Description
IDictionary<string, object>

Context

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.

Declaration

[JsonProperty("context")]
public virtual IDictionary<string, object> Context { get; set; }

Property Value

Type	Description
IDictionary<string, object>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("mockConfig")]
public virtual MockConfig MockConfig { get; set; }

Property Value

Type	Description
MockConfig

Tool

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

Declaration

[JsonProperty("tool")]
public virtual string Tool { get; set; }

Property Value

Type	Description
string

ToolsetTool

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

Declaration

[JsonProperty("toolsetTool")]
public virtual ToolsetTool ToolsetTool { get; set; }

Property Value

Type	Description
ToolsetTool

Variables

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

Declaration

[JsonProperty("variables")]
public virtual IDictionary<string, object> Variables { get; set; }

Property Value

Type	Description
IDictionary<string, object>

Implements

IDirectResponseSchema