feat: Expose UrlContextMetadata API to v1

Google APIs · copybara-github · commit 5e989a7b16fc · 2025-06-04T16:18:46.000-07:00
PiperOrigin-RevId: 767327091
diff --git a/google/cloud/aiplatform/v1/content.proto b/google/cloud/aiplatform/v1/content.proto
@@ -543,6 +543,38 @@ message Candidate {
   // Output only. Metadata specifies sources used to ground generated content.
   GroundingMetadata grounding_metadata = 7
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Metadata related to url context retrieval tool.
+  UrlContextMetadata url_context_metadata = 11
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Metadata related to url context retrieval tool.
+message UrlContextMetadata {
+  // Output only. List of url context.
+  repeated UrlMetadata url_metadata = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Context of the a single url retrieval.
+message UrlMetadata {
+  // Status of the url retrieval.
+  enum UrlRetrievalStatus {
+    // Default value. This value is unused.
+    URL_RETRIEVAL_STATUS_UNSPECIFIED = 0;
+
+    // Url retrieval is successful.
+    URL_RETRIEVAL_STATUS_SUCCESS = 1;
+
+    // Url retrieval is failed due to error.
+    URL_RETRIEVAL_STATUS_ERROR = 2;
+  }
+
+  // Retrieved url by the tool.
+  string retrieved_url = 1;
+
+  // Status of the url retrieval.
+  UrlRetrievalStatus url_retrieval_status = 2;
 }
 
 // Logprobs Result
