Package com.google.cloud.aiplatform.v1

Class Tool.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>
com.google.cloud.aiplatform.v1.Tool.Builder
All Implemented Interfaces:
ToolOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Tool
public static final class Tool.Builder extends com.google.protobuf.GeneratedMessage.Builder<Tool.Builder> 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.aiplatform.v1.Tool

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>

    • clear

      public Tool.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>

    • getDefaultInstanceForType

      public Tool getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Tool build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Tool buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Tool.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Builder>

    • mergeFrom

      public Tool.Builder mergeFrom(Tool other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>

    • mergeFrom

      public Tool.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Builder>
      Throws:
      IOException

    • 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][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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionDeclarationsList in interface ToolOrBuilder

    • 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][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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionDeclarationsCount in interface ToolOrBuilder

    • getFunctionDeclarations

      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][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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionDeclarations in interface ToolOrBuilder

    • setFunctionDeclarations

      public Tool.Builder setFunctionDeclarations(int index, FunctionDeclaration value)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • setFunctionDeclarations

      public Tool.Builder setFunctionDeclarations(int index, FunctionDeclaration.Builder builderForValue)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addFunctionDeclarations

      public Tool.Builder addFunctionDeclarations(FunctionDeclaration value)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addFunctionDeclarations

      public Tool.Builder addFunctionDeclarations(int index, FunctionDeclaration value)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addFunctionDeclarations

      public Tool.Builder addFunctionDeclarations(FunctionDeclaration.Builder builderForValue)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addFunctionDeclarations

      public Tool.Builder addFunctionDeclarations(int index, FunctionDeclaration.Builder builderForValue)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addAllFunctionDeclarations

      public Tool.Builder addAllFunctionDeclarations(Iterable<? extends FunctionDeclaration> values)
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • clearFunctionDeclarations

      public Tool.Builder clearFunctionDeclarations()
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • removeFunctionDeclarations

      public Tool.Builder removeFunctionDeclarations(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.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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • getFunctionDeclarationsBuilder

      public FunctionDeclaration.Builder getFunctionDeclarationsBuilder(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.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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • getFunctionDeclarationsOrBuilder

      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][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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionDeclarationsOrBuilder in interface ToolOrBuilder

    • 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][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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFunctionDeclarationsOrBuilderList in interface ToolOrBuilder

    • addFunctionDeclarationsBuilder

      public FunctionDeclaration.Builder addFunctionDeclarationsBuilder()
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • addFunctionDeclarationsBuilder

      public FunctionDeclaration.Builder addFunctionDeclarationsBuilder(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.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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • getFunctionDeclarationsBuilderList

      public List<FunctionDeclaration.Builder> getFunctionDeclarationsBuilderList()
       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.
      repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

    • 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.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRetrieval in interface ToolOrBuilder
      Returns:
      Whether the retrieval field is set.

    • 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.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetrieval in interface ToolOrBuilder
      Returns:
      The retrieval.

    • setRetrieval

      public Tool.Builder setRetrieval(Retrieval value)
       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.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setRetrieval

      public Tool.Builder setRetrieval(Retrieval.Builder builderForValue)
       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.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

    • mergeRetrieval

      public Tool.Builder mergeRetrieval(Retrieval value)
       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.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearRetrieval

      public Tool.Builder clearRetrieval()
       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.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getRetrievalBuilder

      public Retrieval.Builder getRetrievalBuilder()
       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.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

    • 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.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetrievalOrBuilder in interface ToolOrBuilder

    • hasGoogleSearch

      public boolean hasGoogleSearch()
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGoogleSearch in interface ToolOrBuilder
      Returns:
      Whether the googleSearch field is set.

    • getGoogleSearch

      public Tool.GoogleSearch getGoogleSearch()
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleSearch in interface ToolOrBuilder
      Returns:
      The googleSearch.

    • setGoogleSearch

      public Tool.Builder setGoogleSearch(Tool.GoogleSearch value)
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setGoogleSearch

      public Tool.Builder setGoogleSearch(Tool.GoogleSearch.Builder builderForValue)
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeGoogleSearch

      public Tool.Builder mergeGoogleSearch(Tool.GoogleSearch value)
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearGoogleSearch

      public Tool.Builder clearGoogleSearch()
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleSearchBuilder

      public Tool.GoogleSearch.Builder getGoogleSearchBuilder()
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleSearchOrBuilder

      public Tool.GoogleSearchOrBuilder getGoogleSearchOrBuilder()
       Optional. GoogleSearch tool type.
 Tool to support Google Search in Model. Powered by Google.
      .google.cloud.aiplatform.v1.Tool.GoogleSearch google_search = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleSearchOrBuilder in interface ToolOrBuilder

    • hasGoogleSearchRetrieval

      public boolean hasGoogleSearchRetrieval()
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGoogleSearchRetrieval in interface ToolOrBuilder
      Returns:
      Whether the googleSearchRetrieval field is set.

    • getGoogleSearchRetrieval

      public GoogleSearchRetrieval getGoogleSearchRetrieval()
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleSearchRetrieval in interface ToolOrBuilder
      Returns:
      The googleSearchRetrieval.

    • setGoogleSearchRetrieval

      public Tool.Builder setGoogleSearchRetrieval(GoogleSearchRetrieval value)
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setGoogleSearchRetrieval

      public Tool.Builder setGoogleSearchRetrieval(GoogleSearchRetrieval.Builder builderForValue)
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • mergeGoogleSearchRetrieval

      public Tool.Builder mergeGoogleSearchRetrieval(GoogleSearchRetrieval value)
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • clearGoogleSearchRetrieval

      public Tool.Builder clearGoogleSearchRetrieval()
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleSearchRetrievalBuilder

      public GoogleSearchRetrieval.Builder getGoogleSearchRetrievalBuilder()
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleSearchRetrievalOrBuilder

      public GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()
       Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
      .google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleSearchRetrievalOrBuilder in interface ToolOrBuilder

    • hasGoogleMaps

      public boolean hasGoogleMaps()
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGoogleMaps in interface ToolOrBuilder
      Returns:
      Whether the googleMaps field is set.

    • getGoogleMaps

      public GoogleMaps getGoogleMaps()
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleMaps in interface ToolOrBuilder
      Returns:
      The googleMaps.

    • setGoogleMaps

      public Tool.Builder setGoogleMaps(GoogleMaps value)
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];

    • setGoogleMaps

      public Tool.Builder setGoogleMaps(GoogleMaps.Builder builderForValue)
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];

    • mergeGoogleMaps

      public Tool.Builder mergeGoogleMaps(GoogleMaps value)
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];

    • clearGoogleMaps

      public Tool.Builder clearGoogleMaps()
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleMapsBuilder

      public GoogleMaps.Builder getGoogleMapsBuilder()
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getGoogleMapsOrBuilder

      public GoogleMapsOrBuilder getGoogleMapsOrBuilder()
       Optional. GoogleMaps tool type.
 Tool to support Google Maps in Model.
      .google.cloud.aiplatform.v1.GoogleMaps google_maps = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGoogleMapsOrBuilder in interface ToolOrBuilder

    • hasEnterpriseWebSearch

      public boolean hasEnterpriseWebSearch()
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEnterpriseWebSearch in interface ToolOrBuilder
      Returns:
      Whether the enterpriseWebSearch field is set.

    • getEnterpriseWebSearch

      public EnterpriseWebSearch getEnterpriseWebSearch()
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnterpriseWebSearch in interface ToolOrBuilder
      Returns:
      The enterpriseWebSearch.

    • setEnterpriseWebSearch

      public Tool.Builder setEnterpriseWebSearch(EnterpriseWebSearch value)
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setEnterpriseWebSearch

      public Tool.Builder setEnterpriseWebSearch(EnterpriseWebSearch.Builder builderForValue)
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeEnterpriseWebSearch

      public Tool.Builder mergeEnterpriseWebSearch(EnterpriseWebSearch value)
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearEnterpriseWebSearch

      public Tool.Builder clearEnterpriseWebSearch()
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getEnterpriseWebSearchBuilder

      public EnterpriseWebSearch.Builder getEnterpriseWebSearchBuilder()
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getEnterpriseWebSearchOrBuilder

      public EnterpriseWebSearchOrBuilder getEnterpriseWebSearchOrBuilder()
       Optional. Tool to support searching public web data, powered by Vertex AI
 Search and Sec4 compliance.
      .google.cloud.aiplatform.v1.EnterpriseWebSearch enterprise_web_search = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnterpriseWebSearchOrBuilder in interface ToolOrBuilder

    • hasParallelAiSearch

      public boolean hasParallelAiSearch()
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasParallelAiSearch in interface ToolOrBuilder
      Returns:
      Whether the parallelAiSearch field is set.

    • getParallelAiSearch

      public Tool.ParallelAiSearch getParallelAiSearch()
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParallelAiSearch in interface ToolOrBuilder
      Returns:
      The parallelAiSearch.

    • setParallelAiSearch

      public Tool.Builder setParallelAiSearch(Tool.ParallelAiSearch value)
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];

    • setParallelAiSearch

      public Tool.Builder setParallelAiSearch(Tool.ParallelAiSearch.Builder builderForValue)
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];

    • mergeParallelAiSearch

      public Tool.Builder mergeParallelAiSearch(Tool.ParallelAiSearch value)
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];

    • clearParallelAiSearch

      public Tool.Builder clearParallelAiSearch()
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getParallelAiSearchBuilder

      public Tool.ParallelAiSearch.Builder getParallelAiSearchBuilder()
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getParallelAiSearchOrBuilder

      public Tool.ParallelAiSearchOrBuilder getParallelAiSearchOrBuilder()
       Optional. If specified, Vertex AI will use Parallel.ai to search for
 information to answer user queries. The search results will be grounded on
 Parallel.ai and presented to the model for response generation
      .google.cloud.aiplatform.v1.Tool.ParallelAiSearch parallel_ai_search = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParallelAiSearchOrBuilder in interface ToolOrBuilder

    • hasCodeExecution

      public boolean hasCodeExecution()
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCodeExecution in interface ToolOrBuilder
      Returns:
      Whether the codeExecution field is set.

    • getCodeExecution

      public Tool.CodeExecution getCodeExecution()
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCodeExecution in interface ToolOrBuilder
      Returns:
      The codeExecution.

    • setCodeExecution

      public Tool.Builder setCodeExecution(Tool.CodeExecution value)
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setCodeExecution

      public Tool.Builder setCodeExecution(Tool.CodeExecution.Builder builderForValue)
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeCodeExecution

      public Tool.Builder mergeCodeExecution(Tool.CodeExecution value)
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearCodeExecution

      public Tool.Builder clearCodeExecution()
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getCodeExecutionBuilder

      public Tool.CodeExecution.Builder getCodeExecutionBuilder()
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getCodeExecutionOrBuilder

      public Tool.CodeExecutionOrBuilder getCodeExecutionOrBuilder()
       Optional. CodeExecution tool type.
 Enables the model to execute code as part of generation.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCodeExecutionOrBuilder in interface ToolOrBuilder

    • hasUrlContext

      public boolean hasUrlContext()
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUrlContext in interface ToolOrBuilder
      Returns:
      Whether the urlContext field is set.

    • getUrlContext

      public UrlContext getUrlContext()
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUrlContext in interface ToolOrBuilder
      Returns:
      The urlContext.

    • setUrlContext

      public Tool.Builder setUrlContext(UrlContext value)
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];

    • setUrlContext

      public Tool.Builder setUrlContext(UrlContext.Builder builderForValue)
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];

    • mergeUrlContext

      public Tool.Builder mergeUrlContext(UrlContext value)
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];

    • clearUrlContext

      public Tool.Builder clearUrlContext()
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getUrlContextBuilder

      public UrlContext.Builder getUrlContextBuilder()
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getUrlContextOrBuilder

      public UrlContextOrBuilder getUrlContextOrBuilder()
       Optional. Tool to support URL context retrieval.
      .google.cloud.aiplatform.v1.UrlContext url_context = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUrlContextOrBuilder in interface ToolOrBuilder

    • hasComputerUse

      public boolean hasComputerUse()
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasComputerUse in interface ToolOrBuilder
      Returns:
      Whether the computerUse field is set.

    • getComputerUse

      public Tool.ComputerUse getComputerUse()
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getComputerUse in interface ToolOrBuilder
      Returns:
      The computerUse.

    • setComputerUse

      public Tool.Builder setComputerUse(Tool.ComputerUse value)
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];

    • setComputerUse

      public Tool.Builder setComputerUse(Tool.ComputerUse.Builder builderForValue)
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];

    • mergeComputerUse

      public Tool.Builder mergeComputerUse(Tool.ComputerUse value)
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];

    • clearComputerUse

      public Tool.Builder clearComputerUse()
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getComputerUseBuilder

      public Tool.ComputerUse.Builder getComputerUseBuilder()
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getComputerUseOrBuilder

      public Tool.ComputerUseOrBuilder getComputerUseOrBuilder()
       Optional. Tool to support the model interacting directly with the computer.
 If enabled, it automatically populates computer-use specific Function
 Declarations.
      .google.cloud.aiplatform.v1.Tool.ComputerUse computer_use = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getComputerUseOrBuilder in interface ToolOrBuilder