feat: add VertexAISearch.max_results, filter, data_store_specs options

Google APIs · copybara-github · commit 7d43527b927f · 2025-05-19T15:03:19.000-07:00
PiperOrigin-RevId: 760783731
diff --git a/google/cloud/aiplatform/v1beta1/tool.proto b/google/cloud/aiplatform/v1beta1/tool.proto
@@ -321,6 +321,21 @@ message VertexRagStore {
 // datastore and engine are mutually exclusive.
 // See https://cloud.google.com/products/agent-builder
 message VertexAISearch {
+  // Define data stores within engine to filter on in a search call and
+  // configurations for those data stores. For more information, see
+  // https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+  message DataStoreSpec {
+    // Full resource name of DataStore, such as
+    // Format:
+    // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+    string data_store = 1;
+
+    // Optional. Filter specification to filter documents in the data store
+    // specified by data_store field. For more information on filtering, see
+    // [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+    string filter = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
   // Optional. Fully-qualified Vertex AI Search data store resource ID.
   // Format:
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
@@ -330,6 +345,20 @@ message VertexAISearch {
   // Format:
   // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
   string engine = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Number of search results to return per query.
+  // The default value is 10.
+  // The maximumm allowed value is 10.
+  int32 max_results = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Filter strings to be passed to the search API.
+  string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Specifications that define the specific DataStores to be searched, along
+  // with configurations for those data stores. This is only considered for
+  // Engines with multiple data stores.
+  // It should only be set if engine is used.
+  repeated DataStoreSpec data_store_specs = 5;
 }
 
 // Tool to retrieve public web data for grounding, powered by Google.
