AlejandroMorgante commented on code in PR #68479: URL: https://github.com/apache/airflow/pull/68479#discussion_r3439531486
########## providers/google/src/airflow/providers/google/cloud/hooks/vertex_ai/agent_engine.py: ########## @@ -0,0 +1,280 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +"""This module contains a Google Cloud Vertex AI Agent Engine hook.""" + +from __future__ import annotations + +import json +import time +from collections.abc import Sequence +from typing import TYPE_CHECKING, Any + +from asgiref.sync import sync_to_async +from google.genai._api_client import HttpOptions +from google.genai.errors import ClientError +from vertexai import Client + +from airflow.providers.google.common.hooks.base_google import ( + PROVIDE_PROJECT_ID, + GoogleBaseAsyncHook, + GoogleBaseHook, +) + +if TYPE_CHECKING: + from vertexai._genai import types + + +class AgentEngineHook(GoogleBaseHook): + """Hook for Google Cloud Vertex AI Agent Engine APIs.""" + + def __init__( + self, + gcp_conn_id: str = "google_cloud_default", + impersonation_chain: str | Sequence[str] | None = None, + **kwargs, + ) -> None: + super().__init__( + gcp_conn_id=gcp_conn_id, + impersonation_chain=impersonation_chain, + **kwargs, + ) + + def get_agent_engine_client(self, project_id: str, location: str): + """Return the Vertex AI Agent Engine client.""" + return Client( + project=project_id, + location=location, + credentials=self.get_credentials(), + ).agent_engines + + @staticmethod + def build_agent_engine_name(project_id: str, location: str, agent_engine_id: str) -> str: + """Build a fully qualified Agent Engine resource name.""" + return f"projects/{project_id}/locations/{location}/reasoningEngines/{agent_engine_id}" + + @GoogleBaseHook.fallback_to_default_project_id + def create_agent_engine( + self, + location: str, + agent: Any | None = None, + config: Any | None = None, + project_id: str = PROVIDE_PROJECT_ID, + ) -> types.AgentEngine: + """ + Create an Agent Engine. + + :param location: Required. The ID of the Google Cloud location that the service belongs to. + :param agent: Optional. The agent object to deploy. + :param config: Optional. Configuration for the Agent Engine. + :param project_id: Optional. The ID of the Google Cloud project. Defaults to the project + configured in the connection. + """ + client = self.get_agent_engine_client(project_id=project_id, location=location) + return client.create(agent=agent, config=config) + + @GoogleBaseHook.fallback_to_default_project_id + def get_agent_engine( + self, + location: str, + agent_engine_id: str, + project_id: str = PROVIDE_PROJECT_ID, + ) -> types.AgentEngine: + """ + Get an Agent Engine. + + :param location: Required. The ID of the Google Cloud location that the service belongs to. + :param agent_engine_id: Required. The Agent Engine ID. + :param project_id: Optional. The ID of the Google Cloud project. Defaults to the project + configured in the connection. + """ + client = self.get_agent_engine_client(project_id=project_id, location=location) + name = self.build_agent_engine_name(project_id, location, agent_engine_id) + return client.get(name=name) + + @GoogleBaseHook.fallback_to_default_project_id + def query_agent_engine( + self, + location: str, + agent_engine_id: str, + config: Any | None = None, + request_timeout: float | None = None, + project_id: str = PROVIDE_PROJECT_ID, + ) -> Any: + """ + Query an Agent Engine. + + :param location: Required. The ID of the Google Cloud location that the service belongs to. + :param agent_engine_id: Required. The Agent Engine ID. + :param config: Optional. Configuration for the query request (``class_method``, ``input``). + :param request_timeout: Optional. Timeout in seconds for the HTTP request. Defaults to no timeout. + :param project_id: Optional. The ID of the Google Cloud project. Defaults to the project + configured in the connection. + """ + # Use the SDK's _api_client.request() directly rather than the SDK's run_query_job + # (requires GCS) or _query (private method; triggers a Pydantic parsing bug in + # google-genai 2.8.0 when the response output type is Any). Calling request() bypasses + # Pydantic parsing while still letting the SDK handle URL construction and auth. + # Replace with a public synchronous query API when available; tracked at + # https://github.com/apache/airflow/issues/68605 + cfg = config if isinstance(config, dict) else {} + body: dict[str, Any] = {"classMethod": cfg.get("class_method", "query")} + if "input" in cfg: + input_val = cfg["input"] + if isinstance(input_val, str): + try: + input_val = json.loads(input_val) + except json.JSONDecodeError as err: + raise ValueError("Agent Engine query input must be valid JSON.") from err + if not isinstance(input_val, dict): + raise ValueError("Agent Engine query input must be a JSON object.") + body["input"] = input_val + + sdk_client = self.get_agent_engine_client(project_id=project_id, location=location) + http_options = HttpOptions( + timeout=int(request_timeout * 1000) if request_timeout is not None else None + ) + name = self.build_agent_engine_name(project_id, location, agent_engine_id) + api_client = getattr(sdk_client, "_api_client", None) + request = getattr(api_client, "request", None) + if request is None: + raise RuntimeError( + "The Vertex AI Agent Engine SDK no longer exposes _api_client.request. " + "QueryAgentEngineOperator must be updated to use a supported synchronous query API." + ) + response = request("post", f"{name}:query", body, http_options) + data = {} if not response.body else json.loads(response.body) + output = data.get("output") + return output if output is not None else data + + @GoogleBaseHook.fallback_to_default_project_id + def update_agent_engine( + self, + location: str, + agent_engine_id: str, + config: Any, + agent: Any | None = None, + project_id: str = PROVIDE_PROJECT_ID, + ) -> types.AgentEngine: + """ + Update an Agent Engine. + + :param location: Required. The ID of the Google Cloud location that the service belongs to. + :param agent_engine_id: Required. The Agent Engine ID. + :param config: Required. Configuration for the Agent Engine update. + :param agent: Optional. The updated agent object to deploy. + :param project_id: Optional. The ID of the Google Cloud project. Defaults to the project + configured in the connection. + """ + client = self.get_agent_engine_client(project_id=project_id, location=location) + name = self.build_agent_engine_name(project_id, location, agent_engine_id) + return client.update(name=name, agent=agent, config=config) + + @GoogleBaseHook.fallback_to_default_project_id + def delete_agent_engine( + self, + location: str, + agent_engine_id: str, + force: bool | None = None, + config: Any | None = None, + project_id: str = PROVIDE_PROJECT_ID, + ) -> types.DeleteAgentEngineOperation: + """ + Delete an Agent Engine. + + :param location: Required. The ID of the Google Cloud location that the service belongs to. + :param agent_engine_id: Required. The Agent Engine ID. + :param force: Optional. Whether to forcefully delete child resources. Defaults to ``False`` + when not specified. + :param config: Optional. Additional deletion configuration. + :param project_id: Optional. The ID of the Google Cloud project. Defaults to the project + configured in the connection. + """ + client = self.get_agent_engine_client(project_id=project_id, location=location) + name = self.build_agent_engine_name(project_id, location, agent_engine_id) + return client.delete(name=name, force=force, config=config) + + def is_agent_engine_deleted(self, project_id: str, location: str, agent_engine_id: str) -> bool: + """Return whether an Agent Engine no longer exists.""" + try: + self.get_agent_engine( + project_id=project_id, + location=location, + agent_engine_id=agent_engine_id, + ) + except ClientError as err: + if getattr(err, "code", None) == 404: + return True + raise + return False + + def wait_for_agent_engine_deleted( + self, + project_id: str, + location: str, + agent_engine_id: str, + poll_interval: float = 30, + timeout: float | None = None, + ) -> None: + """ + Wait until an Agent Engine no longer exists. + + :param project_id: The ID of the Google Cloud project that the service belongs to. + :param location: The ID of the Google Cloud location that the service belongs to. + :param agent_engine_id: The Agent Engine ID. + :param poll_interval: Time, in seconds, to wait between checks. + :param timeout: Optional timeout, in seconds. + """ + start_time = time.monotonic() + while True: + if self.is_agent_engine_deleted( + project_id=project_id, + location=location, + agent_engine_id=agent_engine_id, + ): + return + if timeout is not None and time.monotonic() - start_time > timeout: + raise TimeoutError(f"Timed out waiting for Agent Engine {agent_engine_id} to be deleted") + self.log.info("Waiting for Agent Engine %s to be deleted.", agent_engine_id) + time.sleep(poll_interval) Review Comment: Agreed. I removed this helper as well. The delete flow now relies on the `DeleteAgentEngineOperation` returned by `delete()` and polls the operation state instead of checking whether the Agent Engine resource eventually returns 404. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
