AlejandroMorgante commented on code in PR #68799: URL: https://github.com/apache/airflow/pull/68799#discussion_r3509590364
########## providers/microsoft/azure/src/airflow/providers/microsoft/azure/hooks/ai_agents.py: ########## @@ -0,0 +1,457 @@ +# +# 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. +from __future__ import annotations + +import asyncio +import json +from functools import cached_property +from typing import TYPE_CHECKING, Any, cast +from urllib.parse import quote + +from azure.core.exceptions import ResourceNotFoundError +from azure.identity import ClientSecretCredential +from requests import Session +from requests.exceptions import HTTPError + +from airflow.providers.common.compat.sdk import BaseHook +from airflow.providers.microsoft.azure.hooks.base_azure import _AZURE_CLOUD_ENVIRONMENTS +from airflow.providers.microsoft.azure.utils import ( + add_managed_identity_connection_widgets, + get_field, + get_sync_default_azure_credential, +) + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + from requests import Response + + from airflow.sdk import Connection + + +HOSTED_AGENT_FEATURE_HEADER = "HostedAgents=V1Preview" +TOKEN_SCOPE = "https://ai.azure.com/.default"; +VERSION_INTERMEDIATE_STATUSES = {"creating", "deleting"} +VERSION_SUCCESS_STATUSES = {"active"} +VERSION_FAILURE_STATUSES = {"failed"} + + +def serialize_resource(resource: Any) -> Any: + """Serialize an SDK or HTTP response object into XCom-safe primitives.""" + if resource is None or isinstance(resource, str | int | float | bool): + return resource + if isinstance(resource, list | tuple): + return [serialize_resource(item) for item in resource] + if isinstance(resource, dict): + return {key: serialize_resource(value) for key, value in resource.items()} + if hasattr(resource, "as_dict"): + return serialize_resource(resource.as_dict()) + if hasattr(resource, "model_dump"): + return serialize_resource(resource.model_dump()) + if hasattr(resource, "__dict__"): + return { + key: serialize_resource(value) for key, value in vars(resource).items() if not key.startswith("_") + } + return resource + + +def get_resource_attr(resource: Any, attr: str) -> Any: + """Get an attribute from an SDK resource or mapping.""" + if isinstance(resource, dict): + return resource.get(attr) + return getattr(resource, attr, None) + + +def get_version_status(version: Any) -> str: + """Return a normalized Hosted agent version status string.""" + status = get_resource_attr(version, "status") + if hasattr(status, "value"): + status = status.value + if status is None: + raise ValueError("Azure AI Hosted agent version did not include a status.") + return str(status).lower() + + +def get_agent_version(version: Any) -> str: + """ + Return the version identifier from a Hosted agent version or agent payload. + + Accepts both a ``agent.version`` object (returned by POST /agents/{name}/versions and + GET /agents/{name}/versions/{version}) and a top-level ``agent`` object (returned by + POST /agents), extracting the version from ``versions.latest.version`` in the latter case. + """ + agent_version = get_resource_attr(version, "version") or get_resource_attr(version, "agent_version") + if agent_version is None: + # POST /agents returns an agent object; the initial version lives under versions.latest + versions = get_resource_attr(version, "versions") + latest = get_resource_attr(versions, "latest") if versions is not None else None + agent_version = get_resource_attr(latest, "version") if latest is not None else None + if agent_version is None: + raise ValueError("Azure AI Hosted agent response did not include a version.") + return str(agent_version) + + +class AzureAIAgentsHook(BaseHook): + """ + Hook for Microsoft Foundry Hosted agents. + + :param azure_ai_agents_conn_id: The Azure AI Agents connection id. + :param endpoint: Optional Azure AI Foundry project endpoint. If not provided, the hook uses the + connection host or the ``endpoint`` connection extra. + :param api_version: Foundry Agent Service API version. + """ + + conn_name_attr = "azure_ai_agents_conn_id" + default_conn_name = "azure_ai_agents_default" + conn_type = "azure_ai_agents" + hook_name = "Azure AI Foundry Hosted Agents" + + def __init__( + self, + azure_ai_agents_conn_id: str = default_conn_name, + endpoint: str | None = None, + api_version: str = "v1", + ) -> None: + super().__init__() + self.conn_id = azure_ai_agents_conn_id + self.endpoint = endpoint + self.api_version = api_version + + @classmethod + @add_managed_identity_connection_widgets + def get_connection_form_widgets(cls) -> dict[str, Any]: + """Return connection widgets to add to connection form.""" + from flask_appbuilder.fieldwidgets import BS3TextFieldWidget + from flask_babel import lazy_gettext + from wtforms import StringField + + return { + "tenantId": StringField(lazy_gettext("Azure Tenant ID"), widget=BS3TextFieldWidget()), + "cloud_environment": StringField( + lazy_gettext("Azure Cloud Environment"), widget=BS3TextFieldWidget() + ), + "endpoint": StringField(lazy_gettext("Project Endpoint"), widget=BS3TextFieldWidget()), + } + + @classmethod + def get_ui_field_behaviour(cls) -> dict[str, Any]: + """Return custom field behaviour.""" + return { + "hidden_fields": ["schema", "port"], + "relabeling": { + "host": "Project Endpoint", + "login": "Azure Client ID", + "password": "Azure Secret", + }, + "placeholders": { + "host": "https://<aiservices-id>.services.ai.azure.com/api/projects/<project-name>", + "login": "client_id (token credentials auth)", + "password": "secret (token credentials auth)", + "tenantId": "tenantId (token credentials auth)", + "cloud_environment": "AzurePublicCloud (default) | AzureUSGovernment | AzureChinaCloud", + "endpoint": "Overrides Project Endpoint from host", + }, + } + + @cached_property + def session(self) -> Session: + """Return a cached requests session.""" + return Session() + + def _get_endpoint(self, conn: Connection, extras: dict[str, Any] | None = None) -> str: + connection_extras = extras if extras is not None else conn.extra_dejson + endpoint = self.endpoint or conn.host or self._get_field(connection_extras, "endpoint") + if not endpoint: + raise ValueError( + "Azure AI Foundry project endpoint must be provided by the hook, connection host, " + "or connection extra." + ) + return endpoint.rstrip("/") + + def _get_credential(self, conn: Connection) -> TokenCredential: + extras = conn.extra_dejson + tenant = self._get_field(extras, "tenantId") + cloud_env_name = self._get_field(extras, "cloud_environment") or "AzurePublicCloud" + cloud_env = _AZURE_CLOUD_ENVIRONMENTS.get( + cloud_env_name, _AZURE_CLOUD_ENVIRONMENTS["AzurePublicCloud"] + ) + + if all([conn.login, conn.password, tenant]): + self.log.info("Getting connection using specific credentials.") + return ClientSecretCredential( + client_id=cast("str", conn.login), + client_secret=cast("str", conn.password), + tenant_id=cast("str", tenant), + authority=cloud_env["authority"], + ) + + self.log.info("Using DefaultAzureCredential as credential.") + managed_identity_client_id = self._get_field(extras, "managed_identity_client_id") + workload_identity_tenant_id = self._get_field(extras, "workload_identity_tenant_id") + return get_sync_default_azure_credential( + managed_identity_client_id=managed_identity_client_id, + workload_identity_tenant_id=workload_identity_tenant_id, + ) + + def _get_field(self, extras: dict[str, Any], field_name: str) -> Any: + return get_field( + conn_id=self.conn_id, + conn_type=self.conn_type, + extras=extras, + field_name=field_name, + ) + + def _request( + self, + method: str, + path: str, + *, + json_payload: dict[str, Any] | None = None, + extra_headers: dict[str, str] | None = None, + query_params: dict[str, str] | None = None, + include_api_version: bool = True, + ) -> Any: + conn = self.get_connection(self.conn_id) + credential = self._get_credential(conn) + token = credential.get_token(TOKEN_SCOPE).token + url = f"{self._get_endpoint(conn)}/{path.lstrip('/')}" + headers = { + "Authorization": f"Bearer {token}", + "Content-Type": "application/json", + "Foundry-Features": HOSTED_AGENT_FEATURE_HEADER, + } + if extra_headers: + headers.update(extra_headers) + + params = {"api-version": self.api_version} if include_api_version else {} + if query_params: + params.update(query_params) + + response = self.session.request( + method=method, + url=url, + params=params or None, + headers=headers, + json=json_payload, + ) + return self._process_response(response) + + def _process_response(self, response: Response) -> Any: + if response.status_code == 404: + raise ResourceNotFoundError("Azure AI Hosted agent resource was not found.") + try: + response.raise_for_status() + except HTTPError as err: + error_body = self._get_response_error_body(response) + if error_body: + raise HTTPError(f"{err}; response body: {error_body}", response=response) from err + raise + if response.status_code == 204 or not response.content: + return None + headers = getattr(response, "headers", None) or {} + content_type = str(headers.get("Content-Type", "")) if hasattr(headers, "get") else "" + if "json" in content_type: + return response.json() + try: + return response.json() + except ValueError: + return response.text + + @staticmethod + def _get_response_error_body(response: Response) -> str | None: + response_text = getattr(response, "text", None) + if response_text: + return response_text + try: + return json.dumps(response.json()) + except ValueError: + return None + + @staticmethod + def _quote_resource_id(resource_id: str) -> str: + return quote(resource_id, safe="") + + @staticmethod + def _build_agent_payload( + *, + definition: dict[str, Any], + metadata: dict[str, str] | None = None, + description: str | None = None, + blueprint_reference: dict[str, Any] | None = None, + agent_endpoint: dict[str, Any] | None = None, + agent_card: dict[str, Any] | None = None, + ) -> dict[str, Any]: + payload: dict[str, Any] = {"definition": definition} + optional_values = { + "metadata": metadata, + "description": description, + "blueprint_reference": blueprint_reference, + "agent_endpoint": agent_endpoint, + "agent_card": agent_card, + } + payload.update({key: value for key, value in optional_values.items() if value is not None}) + return payload + + def create_agent( + self, + agent_name: str, + definition: dict[str, Any], + *, + metadata: dict[str, str] | None = None, + description: str | None = None, + blueprint_reference: dict[str, Any] | None = None, + agent_endpoint: dict[str, Any] | None = None, + agent_card: dict[str, Any] | None = None, + ) -> dict[str, Any]: Review Comment: Done. Added parameter and return value entries for the public hook methods! -- 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]
