Vertex AI v1 API - Class Tool (3.56.0) 

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

Reference documentation and code samples for the Vertex AI v1 API class Tool.

Tool details that the model may use to generate response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

Inheritance

object > Tool

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Tool()

public Tool()

Tool(Tool)

public Tool(Tool other)
Parameter
Name Description
other Tool

Properties

CodeExecution

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

Optional. CodeExecution tool type. Enables the model to execute code as part of generation.

Property Value
Type Description
ToolTypesCodeExecution

ComputerUse

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

Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.

Property Value
Type Description
ToolTypesComputerUse

EnterpriseWebSearch

public EnterpriseWebSearch EnterpriseWebSearch { get; set; }

Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.

Property Value
Type Description
EnterpriseWebSearch

FunctionDeclarations

public RepeatedField<FunctionDeclaration> FunctionDeclarations { get; }

Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating [FunctionCall][google.cloud.aiplatform.v1.Part.function_call] in the response. User should provide a [FunctionResponse][google.cloud.aiplatform.v1.Part.function_response] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.

Property Value
Type Description
RepeatedFieldFunctionDeclaration

GoogleMaps

public GoogleMaps GoogleMaps { get; set; }

Optional. GoogleMaps tool type. Tool to support Google Maps in Model.

Property Value
Type Description
GoogleMaps

GoogleSearch

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

Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.

Property Value
Type Description
ToolTypesGoogleSearch

GoogleSearchRetrieval

public GoogleSearchRetrieval GoogleSearchRetrieval { get; set; }

Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.

Property Value
Type Description
GoogleSearchRetrieval

Retrieval

public Retrieval Retrieval { get; set; }

Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.

Property Value
Type Description
Retrieval

UrlContext

public UrlContext UrlContext { get; set; }

Optional. Tool to support URL context retrieval.

Property Value
Type Description
UrlContext