com.google.cloud.aiplatform.v1beta1

Interface ToolOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Tool, Tool.Builder

public interface ToolOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Tool.CodeExecution	getCodeExecution() Optional.
Tool.CodeExecutionOrBuilder	getCodeExecutionOrBuilder() Optional.
FunctionDeclaration	getFunctionDeclarations(int index) Optional.
int	getFunctionDeclarationsCount() Optional.
List<FunctionDeclaration>	getFunctionDeclarationsList() Optional.
FunctionDeclarationOrBuilder	getFunctionDeclarationsOrBuilder(int index) Optional.
List<? extends FunctionDeclarationOrBuilder>	getFunctionDeclarationsOrBuilderList() Optional.
Tool.GoogleSearch	getGoogleSearch() Optional.
Tool.GoogleSearchOrBuilder	getGoogleSearchOrBuilder() Optional.
GoogleSearchRetrieval	getGoogleSearchRetrieval() Optional.
GoogleSearchRetrievalOrBuilder	getGoogleSearchRetrievalOrBuilder() Optional.
Retrieval	getRetrieval() Optional.
RetrievalOrBuilder	getRetrievalOrBuilder() Optional.
boolean	hasCodeExecution() Optional.
boolean	hasGoogleSearch() Optional.
boolean	hasGoogleSearchRetrieval() Optional.
boolean	hasRetrieval() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFunctionDeclarationsList

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][google.cloud.aiplatform.v1beta1.Part.function_call] in the
 response. User should provide a
 [FunctionResponse][google.cloud.aiplatform.v1beta1.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.
 

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

getFunctionDeclarations

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][google.cloud.aiplatform.v1beta1.Part.function_call] in the
 response. User should provide a
 [FunctionResponse][google.cloud.aiplatform.v1beta1.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.
 

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

getFunctionDeclarationsCount

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][google.cloud.aiplatform.v1beta1.Part.function_call] in the
 response. User should provide a
 [FunctionResponse][google.cloud.aiplatform.v1beta1.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.
 

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

getFunctionDeclarationsOrBuilderList

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][google.cloud.aiplatform.v1beta1.Part.function_call] in the
 response. User should provide a
 [FunctionResponse][google.cloud.aiplatform.v1beta1.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.
 

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

getFunctionDeclarationsOrBuilder

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][google.cloud.aiplatform.v1beta1.Part.function_call] in the
 response. User should provide a
 [FunctionResponse][google.cloud.aiplatform.v1beta1.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.
 

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

hasRetrieval

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:

Whether the retrieval field is set.

getRetrieval

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:

The retrieval.

getRetrievalOrBuilder

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];

hasGoogleSearch

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:

Whether the googleSearch field is set.

getGoogleSearch

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:

The googleSearch.

getGoogleSearchOrBuilder

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];

hasGoogleSearchRetrieval

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:

Whether the googleSearchRetrieval field is set.

getGoogleSearchRetrieval

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:

The googleSearchRetrieval.

getGoogleSearchRetrievalOrBuilder

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];

hasCodeExecution

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:

Whether the codeExecution field is set.

getCodeExecution

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:

The codeExecution.

getCodeExecutionOrBuilder

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];