Class Tool (1.14.0)

public final class Tool extends GeneratedMessageV3 implements ToolOrBuilder

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).

Protobuf type google.cloud.vertexai.v1.Tool

Implements

ToolOrBuilder

Static Fields

FUNCTION_DECLARATIONS_FIELD_NUMBER

public static final int FUNCTION_DECLARATIONS_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_SEARCH_RETRIEVAL_FIELD_NUMBER

public static final int GOOGLE_SEARCH_RETRIEVAL_FIELD_NUMBER
Field Value
Type Description
int

RETRIEVAL_FIELD_NUMBER

public static final int RETRIEVAL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Tool getDefaultInstance()
Returns
Type Description
Tool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Tool.Builder newBuilder()
Returns
Type Description
Tool.Builder

newBuilder(Tool prototype)

public static Tool.Builder newBuilder(Tool prototype)
Parameter
Name Description
prototype Tool
Returns
Type Description
Tool.Builder

parseDelimitedFrom(InputStream input)

public static Tool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Tool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Tool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Tool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Tool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Tool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Tool> parser()
Returns
Type Description
Parser<Tool>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Tool getDefaultInstanceForType()
Returns
Type Description
Tool

getFunctionDeclarations(int index)

public FunctionDeclaration getFunctionDeclarations(int index)

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 in the response. User should provide a FunctionResponse 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.

repeated .google.cloud.vertexai.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FunctionDeclaration

getFunctionDeclarationsCount()

public int getFunctionDeclarationsCount()

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 in the response. User should provide a FunctionResponse 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.

repeated .google.cloud.vertexai.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFunctionDeclarationsList()

public List<FunctionDeclaration> getFunctionDeclarationsList()

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 in the response. User should provide a FunctionResponse 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.

repeated .google.cloud.vertexai.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<FunctionDeclaration>

getFunctionDeclarationsOrBuilder(int index)

public FunctionDeclarationOrBuilder getFunctionDeclarationsOrBuilder(int index)

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 in the response. User should provide a FunctionResponse 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.

repeated .google.cloud.vertexai.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FunctionDeclarationOrBuilder

getFunctionDeclarationsOrBuilderList()

public List<? extends FunctionDeclarationOrBuilder> getFunctionDeclarationsOrBuilderList()

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 in the response. User should provide a FunctionResponse 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.

repeated .google.cloud.vertexai.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.FunctionDeclarationOrBuilder>

getGoogleSearchRetrieval()

public GoogleSearchRetrieval getGoogleSearchRetrieval()

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

.google.cloud.vertexai.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchRetrieval

The googleSearchRetrieval.

getGoogleSearchRetrievalOrBuilder()

public GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()

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

.google.cloud.vertexai.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchRetrievalOrBuilder

getParserForType()

public Parser<Tool> getParserForType()
Returns
Type Description
Parser<Tool>
Overrides

getRetrieval()

public Retrieval getRetrieval()

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.

.google.cloud.vertexai.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Retrieval

The retrieval.

getRetrievalOrBuilder()

public RetrievalOrBuilder getRetrievalOrBuilder()

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.

.google.cloud.vertexai.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RetrievalOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGoogleSearchRetrieval()

public boolean hasGoogleSearchRetrieval()

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

.google.cloud.vertexai.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleSearchRetrieval field is set.

hasRetrieval()

public boolean hasRetrieval()

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.

.google.cloud.vertexai.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the retrieval field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Tool.Builder newBuilderForType()
Returns
Type Description
Tool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Tool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Tool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Tool.Builder toBuilder()
Returns
Type Description
Tool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException