Vertex AI v1beta1 API - Class ToolUseExample (1.0.0-beta42) 

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

Reference documentation and code samples for the Vertex AI v1beta1 API class ToolUseExample.

A single example of the tool usage.

Inheritance

object > ToolUseExample

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ToolUseExample()

public ToolUseExample()

ToolUseExample(ToolUseExample)

public ToolUseExample(ToolUseExample other)
Parameter
Name Description
other ToolUseExample

Properties

DisplayName

public string DisplayName { get; set; }

Required. The display name for example.

Property Value
Type Description
string

ExtensionOperation

public ToolUseExample.Types.ExtensionOperation ExtensionOperation { get; set; }

Extension operation to call.

Property Value
Type Description
ToolUseExampleTypesExtensionOperation

FunctionName

public string FunctionName { get; set; }

Function name to call.

Property Value
Type Description
string

HasFunctionName

public bool HasFunctionName { get; }

Gets whether the "function_name" field is set

Property Value
Type Description
bool

Query

public string Query { get; set; }

Required. Query that should be routed to this tool.

Property Value
Type Description
string

RequestParams

public Struct RequestParams { get; set; }

Request parameters used for executing this tool.

Property Value
Type Description
Struct

ResponseParams

public Struct ResponseParams { get; set; }

Response parameters generated by this tool.

Property Value
Type Description
Struct

ResponseSummary

public string ResponseSummary { get; set; }

Summary of the tool response to the user query.

Property Value
Type Description
string

TargetCase

public ToolUseExample.TargetOneofCase TargetCase { get; }
Property Value
Type Description
ToolUseExampleTargetOneofCase