Dialogflow v3 API - Class Tool (3.0.0) 

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

Reference documentation and code samples for the Dialogflow v3 API class Tool.

A tool provides a list of actions which are available to the [Playbook][google.cloud.dialogflow.cx.v3.Playbook] to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.

Inheritance

object > Tool

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

Tool()

public Tool()

Tool(Tool)

public Tool(Tool other)
Parameter
Name Description
other Tool

Properties

DataStoreSpec

public Tool.Types.DataStoreTool DataStoreSpec { get; set; }

Data store search tool specification.

Property Value
Type Description
ToolTypesDataStoreTool

Description

public string Description { get; set; }

Required. High level description of the Tool and its usage.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the Tool, unique within an agent.

Property Value
Type Description
string

FunctionSpec

public Tool.Types.FunctionTool FunctionSpec { get; set; }

Client side executed function specification.

Property Value
Type Description
ToolTypesFunctionTool

Name

public string Name { get; set; }

The unique identifier of the Tool. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

Property Value
Type Description
string

OpenApiSpec

public Tool.Types.OpenApiTool OpenApiSpec { get; set; }

OpenAPI specification of the Tool.

Property Value
Type Description
ToolTypesOpenApiTool

SpecificationCase

public Tool.SpecificationOneofCase SpecificationCase { get; }
Property Value
Type Description
ToolSpecificationOneofCase

ToolName

public ToolName ToolName { get; set; }

ToolName-typed view over the Name resource name property.

Property Value
Type Description
ToolName

ToolType

public Tool.Types.ToolType ToolType { get; set; }

Output only. The tool type.

Property Value
Type Description
ToolTypesToolType