feat: add EnterpriseWebSearch tool option

Google APIs · copybara-github · commit 2862c1e2d80e · 2025-02-26T15:56:25.000-08:00
PiperOrigin-RevId: 731486257
diff --git a/google/cloud/aiplatform/v1/tool.proto b/google/cloud/aiplatform/v1/tool.proto
@@ -38,6 +38,10 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
 // one type of Tool (e.g FunctionDeclaration, Retrieval or
 // GoogleSearchRetrieval).
 message Tool {
+  // GoogleSearch tool type.
+  // Tool to support Google Search in Model. Powered by Google.
+  message GoogleSearch {}
+
   // Tool that executes code generated by the model, and automatically returns
   // the result to the model.
   //
@@ -48,11 +52,12 @@ message Tool {
   // 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][content.part.function_call] in the response.
-  // User should provide a [FunctionResponse][content.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.
+  // 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 FunctionDeclaration function_declarations = 1
       [(google.api.field_behavior) = OPTIONAL];
 
@@ -62,14 +67,22 @@ message Tool {
   // model for generation.
   Retrieval retrieval = 2 [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. GoogleSearch tool type.
+  // Tool to support Google Search in Model. Powered by Google.
+  GoogleSearch google_search = 7 [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. GoogleSearchRetrieval tool type.
   // Specialized retrieval tool that is powered by Google search.
   GoogleSearchRetrieval google_search_retrieval = 3
       [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. Tool to support searching public web data, powered by Vertex AI
+  // Search and Sec4 compliance.
+  EnterpriseWebSearch enterprise_web_search = 6
+      [(google.api.field_behavior) = OPTIONAL];
+
   // 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.
   CodeExecution code_execution = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -263,6 +276,10 @@ message GoogleSearchRetrieval {
   DynamicRetrievalConfig dynamic_retrieval_config = 2;
 }
 
+// Tool to search public web data, powered by Vertex AI Search and Sec4
+// compliance.
+message EnterpriseWebSearch {}
+
 // Describes the options to customize dynamic retrieval.
 message DynamicRetrievalConfig {
   // The mode of the predictor to be used in dynamic retrieval.
@@ -299,17 +316,17 @@ message FunctionCallingConfig {
     // Unspecified function calling mode. This value should not be used.
     MODE_UNSPECIFIED = 0;
 
-    // Default model behavior, model decides to predict either a function call
-    // or a natural language response.
+    // Default model behavior, model decides to predict either function calls
+    // or natural language response.
     AUTO = 1;
 
-    // Model is constrained to always predicting a function call only.
-    // If "allowed_function_names" are set, the predicted function call will be
+    // Model is constrained to always predicting function calls only.
+    // If "allowed_function_names" are set, the predicted function calls will be
     // limited to any one of "allowed_function_names", else the predicted
-    // function call will be any one of the provided "function_declarations".
+    // function calls will be any one of the provided "function_declarations".
     ANY = 2;
 
-    // Model will not predict any function call. Model behavior is same as when
+    // Model will not predict any function calls. Model behavior is same as when
     // not passing any function declarations.
     NONE = 3;
   }
diff --git a/google/cloud/aiplatform/v1beta1/tool.proto b/google/cloud/aiplatform/v1beta1/tool.proto
@@ -77,9 +77,13 @@ message Tool {
   GoogleSearchRetrieval google_search_retrieval = 3
       [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. Tool to support searching public web data, powered by Vertex AI
+  // Search and Sec4 compliance.
+  EnterpriseWebSearch enterprise_web_search = 6
+      [(google.api.field_behavior) = OPTIONAL];
+
   // 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.
   CodeExecution code_execution = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
@@ -320,6 +324,10 @@ message GoogleSearchRetrieval {
   DynamicRetrievalConfig dynamic_retrieval_config = 2;
 }
 
+// Tool to search public web data, powered by Vertex AI Search and Sec4
+// compliance.
+message EnterpriseWebSearch {}
+
 // Describes the options to customize dynamic retrieval.
 message DynamicRetrievalConfig {
   // The mode of the predictor to be used in dynamic retrieval.
