Package com.google.cloud.aiplatform.v1

Interface ToolOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tool, Tool.Builder
@Generated public interface ToolOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

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

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

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

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

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

    • 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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

    • hasGoogleMaps

      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];
      Returns:
      Whether the googleMaps field is set.

    • getGoogleMaps

      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];
      Returns:
      The googleMaps.

    • getGoogleMapsOrBuilder

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

    • hasEnterpriseWebSearch

      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];
      Returns:
      Whether the enterpriseWebSearch field is set.

    • getEnterpriseWebSearch

      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];
      Returns:
      The enterpriseWebSearch.

    • getEnterpriseWebSearchOrBuilder

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

    • hasParallelAiSearch

      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];
      Returns:
      Whether the parallelAiSearch field is set.

    • getParallelAiSearch

      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];
      Returns:
      The parallelAiSearch.

    • getParallelAiSearchOrBuilder

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

    • hasCodeExecution

      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];
      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.
      .google.cloud.aiplatform.v1.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.
      .google.cloud.aiplatform.v1.Tool.CodeExecution code_execution = 4 [(.google.api.field_behavior) = OPTIONAL];

    • hasUrlContext

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

    • getUrlContext

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

    • getUrlContextOrBuilder

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

    • hasComputerUse

      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];
      Returns:
      Whether the computerUse field is set.

    • getComputerUse

      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];
      Returns:
      The computerUse.

    • getComputerUseOrBuilder

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