feat: add AskContexts and AsyncRetrieveContexts APIs to VertexRagService

Google APIs · copybara-github · commit e50da278bd78 · 2026-03-02T17:35:12.000-08:00
PiperOrigin-RevId: 877654221
diff --git a/google/cloud/aiplatform/v1/vertex_rag_service.proto b/google/cloud/aiplatform/v1/vertex_rag_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,8 +21,10 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/aiplatform/v1/content.proto";
+import "google/cloud/aiplatform/v1/operation.proto";
 import "google/cloud/aiplatform/v1/tool.proto";
 import "google/cloud/aiplatform/v1/vertex_rag_data.proto";
+import "google/longrunning/operations.proto";
 
 option csharp_namespace = "Google.Cloud.AIPlatform.V1";
 option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
@@ -69,6 +71,29 @@ service VertexRagService {
     };
     option (google.api.method_signature) = "parent,content,facts";
   }
+
+  // Agentic Retrieval Ask API for RAG.
+  rpc AskContexts(AskContextsRequest) returns (AskContextsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*}:askContexts"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,query";
+  }
+
+  // Asynchronous API to retrieves relevant contexts for a query.
+  rpc AsyncRetrieveContexts(AsyncRetrieveContextsRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*}:asyncRetrieveContexts"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,query";
+    option (google.longrunning.operation_info) = {
+      response_type: "AsyncRetrieveContextsResponse"
+      metadata_type: "AsyncRetrieveContextsOperationMetadata"
+    };
+  }
 }
 
 // A query to retrieve relevant contexts.
@@ -316,3 +341,69 @@ message Claim {
   // Confidence score of this corroboration.
   optional float score = 4;
 }
+
+// Agentic Retrieval Ask API for RAG.
+// Request message for
+// [VertexRagService.AskContexts][google.cloud.aiplatform.v1.VertexRagService.AskContexts].
+message AskContextsRequest {
+  // Required. The resource name of the Location from which to retrieve
+  // RagContexts. The users must have permission to make a call in the project.
+  // Format:
+  // `projects/{project}/locations/{location}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "locations.googleapis.com/Location"
+    }
+  ];
+
+  // Required. Single RAG retrieve query.
+  RagQuery query = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The tools to use for AskContexts.
+  repeated Tool tools = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [VertexRagService.AskContexts][google.cloud.aiplatform.v1.VertexRagService.AskContexts].
+message AskContextsResponse {
+  // The Retrieval Response.
+  string response = 1;
+
+  // The contexts of the query.
+  RagContexts contexts = 2;
+}
+
+// Request message for
+// [VertexRagService.AsyncRetrieveContexts][google.cloud.aiplatform.v1.VertexRagService.AsyncRetrieveContexts].
+message AsyncRetrieveContextsRequest {
+  // Required. The resource name of the Location from which to retrieve
+  // RagContexts. The users must have permission to make a call in the project.
+  // Format:
+  // `projects/{project}/locations/{location}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "locations.googleapis.com/Location"
+    }
+  ];
+
+  // Required. Single RAG retrieve query.
+  RagQuery query = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The tools to use for AskContexts.
+  repeated Tool tools = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [VertexRagService.AsyncRetrieveContexts][google.cloud.aiplatform.v1.VertexRagService.AsyncRetrieveContexts].
+message AsyncRetrieveContextsResponse {
+  // The contexts of the query.
+  RagContexts contexts = 1;
+}
+
+// Metadata for AsyncRetrieveContextsOperation.
+message AsyncRetrieveContextsOperationMetadata {
+  // The operation generic information.
+  GenericOperationMetadata generic_metadata = 1;
+}
