Interface ToolOrBuilder (3.56.0) 

public interface ToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCodeExecution()

public abstract Tool.CodeExecution getCodeExecution()

Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services.

.google.cloud.aiplatform.v1beta1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.CodeExecution

The codeExecution.

getCodeExecutionOrBuilder()

public abstract Tool.CodeExecutionOrBuilder getCodeExecutionOrBuilder()

Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services.

.google.cloud.aiplatform.v1beta1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.CodeExecutionOrBuilder

getFunctionDeclarations(int index)

public abstract 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 128 function declarations can be provided.

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

Parameter
Name Description
index int
Returns
Type Description
FunctionDeclaration

getFunctionDeclarationsCount()

public abstract 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 128 function declarations can be provided.

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

Returns
Type Description
int

getFunctionDeclarationsList()

public abstract 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 128 function declarations can be provided.

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

Returns
Type Description
List<FunctionDeclaration>

getFunctionDeclarationsOrBuilder(int index)

public abstract 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 128 function declarations can be provided.

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

Parameter
Name Description
index int
Returns
Type Description
FunctionDeclarationOrBuilder

getFunctionDeclarationsOrBuilderList()

public abstract 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 128 function declarations can be provided.

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

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.FunctionDeclarationOrBuilder>

getGoogleSearch()

public abstract Tool.GoogleSearch getGoogleSearch()

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

.google.cloud.aiplatform.v1beta1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.GoogleSearch

The googleSearch.

getGoogleSearchOrBuilder()

public abstract Tool.GoogleSearchOrBuilder getGoogleSearchOrBuilder()

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

.google.cloud.aiplatform.v1beta1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Tool.GoogleSearchOrBuilder

getGoogleSearchRetrieval()

public abstract GoogleSearchRetrieval getGoogleSearchRetrieval()

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

.google.cloud.aiplatform.v1beta1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchRetrieval

The googleSearchRetrieval.

getGoogleSearchRetrievalOrBuilder()

public abstract GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()

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

.google.cloud.aiplatform.v1beta1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchRetrievalOrBuilder

getRetrieval()

public abstract 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.aiplatform.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Retrieval

The retrieval.

getRetrievalOrBuilder()

public abstract 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.aiplatform.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RetrievalOrBuilder

hasCodeExecution()

public abstract boolean hasCodeExecution()

Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services.

.google.cloud.aiplatform.v1beta1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the codeExecution field is set.

hasGoogleSearch()

public abstract boolean hasGoogleSearch()

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

.google.cloud.aiplatform.v1beta1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleSearch field is set.

hasGoogleSearchRetrieval()

public abstract boolean hasGoogleSearchRetrieval()

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

.google.cloud.aiplatform.v1beta1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleSearchRetrieval field is set.

hasRetrieval()

public abstract 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.aiplatform.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the retrieval field is set.