AlejandroMorgante commented on code in PR #74386: URL: https://github.com/apache/airflow/pull/74386#discussion_r4238734157
########## providers/databricks/src/airflow/providers/databricks/hooks/agent.py: ########## @@ -0,0 +1,372 @@ +# 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. +"""Invoke agents served by Databricks DurableAgentServer.""" + +from __future__ import annotations + +import json +import time +from typing import TYPE_CHECKING, Any +from urllib.parse import urlsplit +from uuid import UUID, uuid4 + +import aiohttp +import requests +from tenacity import RetryError, stop_before_delay + +from airflow.providers.common.compat.sdk import AirflowException, AirflowOptionalProviderFeatureException +from airflow.providers.databricks.exceptions import DatabricksAgentInvocationTimeout, DatabricksApiError +from airflow.providers.databricks.hooks.databricks_base import BaseDatabricksHook + +if TYPE_CHECKING: + from airflow.providers.common.ai.exceptions import ManagedAgentInvocationError + from airflow.providers.common.ai.managed_agents.base import ( + BaseManagedAgentHook, + ManagedAgentCapabilities, + ManagedAgentRef, + ManagedAgentRequest, + ManagedAgentResponse, + ) +else: + try: + from airflow.providers.common.ai.exceptions import ManagedAgentInvocationError + from airflow.providers.common.ai.managed_agents.base import ( + BaseManagedAgentHook, + ManagedAgentCapabilities, + ManagedAgentRef, + ManagedAgentResponse, + ) + except ImportError as e: + _common_ai_import_error = e + + def _needs_common_ai(*args: Any, **kwargs: Any) -> Any: + raise AirflowOptionalProviderFeatureException( + "Consulting a Databricks agent needs the 'common.ai' extra: " + "pip install 'apache-airflow-providers-databricks[common.ai]'." + ) from _common_ai_import_error + + class BaseManagedAgentHook: + """Keep background invocation available without the Common AI extra.""" + + agent = _needs_common_ai + + ManagedAgentCapabilities = ManagedAgentRef = ManagedAgentResponse = _needs_common_ai + ManagedAgentInvocationError = _needs_common_ai + + +_AGENT_OPTIONS = frozenset({"input_key", "invocation_id"}) + + +class DatabricksAgentHook(BaseDatabricksHook, BaseManagedAgentHook): + """ + Invoke a DurableAgentServer deployed on Databricks Apps. + + With the ``common.ai`` extra installed, ``hook.agent(app_url)`` exposes the synchronous + invocation API through the managed-agent contract. Background invocations remain available + through ``create_invocation`` and ``get_invocation`` without that extra. + + :param app_url: HTTPS base URL for background invocation methods. Defaults to ``None``; + managed-agent calls receive the app URL as their ``agent`` argument. + :param databricks_conn_id: Databricks workspace connection configured with + ``service_principal_oauth=true``, a client ID in login and a client secret in password. + Defaults to ``databricks_default``. + :param timeout_seconds: HTTP request timeout in seconds. Defaults to ``180``. + :param retry_limit: Maximum number of attempts for transient HTTP failures. Defaults to ``3``. + :param retry_delay: Minimum delay between HTTP retries in seconds. Defaults to ``1``. + """ + + def __init__( + self, + app_url: str | None = None, + databricks_conn_id: str = "databricks_default", + timeout_seconds: int = 180, + retry_limit: int = 3, + retry_delay: float = 1, + ) -> None: + super().__init__(databricks_conn_id, timeout_seconds, retry_limit, retry_delay) + self.app_url = self._validate_app_url(app_url) if app_url is not None else None + + agent_platform = "databricks.agent_runtime" + + @staticmethod + def _validate_app_url(app_url: str | None) -> str: + if app_url is None: + raise ValueError("app_url is required for background invocation methods") + parsed = urlsplit(app_url) + if ( + parsed.scheme != "https" + or not parsed.hostname + or parsed.username + or parsed.password + or parsed.path not in ("", "/") + or parsed.query + or parsed.fragment + ): + raise ValueError("app_url must be an HTTPS base URL without credentials, path, query or fragment") + return app_url.rstrip("/") + + def resolve_agent(self, agent: str) -> ManagedAgentRef: + """ + Resolve an app's HTTPS base URL without contacting Databricks. + + :param agent: HTTPS base URL of the deployed app. + :return: Platform-qualified app URL with its trailing slash removed. + """ + return ManagedAgentRef(platform=self.agent_platform, name=self._validate_app_url(agent)) + + def get_agent_capabilities(self, agent: str) -> ManagedAgentCapabilities: + """ + Report session, structured-output and invocation-ID support. + + :param agent: HTTPS base URL of the deployed app. + :return: Capabilities of the synchronous invocation API. + """ + self.resolve_agent(agent) + return ManagedAgentCapabilities(sessions=True, structured_output=True, trace=True) + + def invoke_agent(self, agent: str, request: ManagedAgentRequest) -> ManagedAgentResponse: + """ + Invoke an agent synchronously through the Common AI contract. + + :param agent: HTTPS base URL of the deployed app. + :param request: Prompt or messages, optional session and request timeout. Vendor options + accept ``input_key`` to send a prompt under an agent-specific key and ``invocation_id`` + to reuse a caller-provided UUID. By default, prompts are converted to messages and + a new UUID is generated for each call. + :return: Answer text, full invocation response, structured output, session and invocation ID. + """ + app_url = self.resolve_agent(agent).name + unknown = set(request.vendor_options) - _AGENT_OPTIONS + if unknown: + raise ValueError( + f"vendor_options {sorted(unknown)} are not accepted; expected {sorted(_AGENT_OPTIONS)}" + ) + input_key = request.vendor_options.get("input_key") + if input_key is not None and (not isinstance(input_key, str) or not input_key): + raise ValueError("vendor_options['input_key'] must be a nonempty string") + if input_key is not None and request.messages is not None: + raise ValueError("vendor_options['input_key'] only applies to a prompt") + invocation_id = ( + str(UUID(request.vendor_options["invocation_id"])) + if "invocation_id" in request.vendor_options + else str(uuid4()) + ) + payload: dict[str, Any] = { + "id": invocation_id, + "input": {input_key: request.prompt} + if input_key is not None + else {"messages": request.as_messages()}, + } + if request.session_id is not None: Review Comment: Done, when no session ID is provided, the hook uses the invocation UUID as a one-shot session. Added a regression test through `ManagedAgentToolset.invoke_sync` covering two calls with distinct sessions -- 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]
