Show / Hide Table of Contents

Class ToolResponse

The execution result of a specific tool from the client or the agent.

Inheritance
object
ToolResponse
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 ToolResponse : IDirectResponseSchema

Properties

AgentName

Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.

Declaration
[JsonProperty("agentName")]
public virtual string AgentName { get; set; }
Property Value
Type Description
string

DisplayName

Output only. Display name of the tool.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

Optional. The matching ID of the tool call the response is for.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

ParentToolCallId

Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.

Declaration
[JsonProperty("parentToolCallId")]
public virtual string ParentToolCallId { get; set; }
Property Value
Type Description
string

Response

Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.

Declaration
[JsonProperty("response")]
public virtual IDictionary<string, object> Response { get; set; }
Property Value
Type Description
IDictionary<string, object>

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 that got executed.

Declaration
[JsonProperty("toolsetTool")]
public virtual ToolsetTool ToolsetTool { get; set; }
Property Value
Type Description
ToolsetTool

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX