@@ -633,6 +633,38 @@ message Candidate {
633633 // Output only. Metadata specifies sources used to ground generated content.
634634 GroundingMetadata grounding_metadata = 7
635635 [(google.api.field_behavior ) = OUTPUT_ONLY ];
636+
637+ // Output only. Metadata related to url context retrieval tool.
638+ UrlContextMetadata url_context_metadata = 11
639+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
640+ }
641+
642+ // Metadata related to url context retrieval tool.
643+ message UrlContextMetadata {
644+ // Output only. List of url context.
645+ repeated UrlMetadata url_metadata = 1
646+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
647+ }
648+
649+ // Context of the a single url retrieval.
650+ message UrlMetadata {
651+ // Status of the url retrieval.
652+ enum UrlRetrievalStatus {
653+ // Default value. This value is unused.
654+ URL_RETRIEVAL_STATUS_UNSPECIFIED = 0 ;
655+
656+ // Url retrieval is successful.
657+ URL_RETRIEVAL_STATUS_SUCCESS = 1 ;
658+
659+ // Url retrieval is failed due to error.
660+ URL_RETRIEVAL_STATUS_ERROR = 2 ;
661+ }
662+
663+ // Retrieved url by the tool.
664+ string retrieved_url = 1 ;
665+
666+ // Status of the url retrieval.
667+ UrlRetrievalStatus url_retrieval_status = 2 ;
636668}
637669
638670// Logprobs Result
0 commit comments