Cloud AI Platform v1 API - Class Tool (2.25.0) 

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

Reference documentation and code samples for the Cloud AI Platform 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
NameDescription
otherTool

Properties

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][content.part.function_call] in the response. User should provide a [FunctionResponse][content.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 64 function declarations can be provided.

Property Value
TypeDescription
RepeatedFieldFunctionDeclaration

GoogleSearchRetrieval

public GoogleSearchRetrieval GoogleSearchRetrieval { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
Retrieval