veadk-python 0.2.27__py3-none-any.whl

veadk/cli/cli_uploadevalset.py

@@ -0,0 +1,139 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed 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.
+
+import click
+import json
+import requests
+from veadk.utils.logger import get_logger
+from veadk.config import getenv
+from pathlib import Path
+
+logger = get_logger(__name__)
+
+
+@click.command()
+@click.option("--file", required=True, help="JSON file path containing dataset items")
+@click.option("--cozeloop-workspace-id", default=None, help="CozeLoop workspace ID")
+@click.option("--cozeloop-evalset-id", default=None, help="CozeLoop evaluation set ID")
+@click.option(
+    "--cozeloop-api-key",
+    default=None,
+    help="CozeLoop API key (or set COZELOOP_API_KEY env var)",
+)
+def uploadevalset(
+    file: str,
+    cozeloop_workspace_id: str,
+    cozeloop_evalset_id: str,
+    cozeloop_api_key: str,
+) -> None:
+    """Upload dataset items to CozeLoop evaluation set.
+
+    This command uploads evaluation dataset items from a JSON file to the CozeLoop
+    platform for agent evaluation and testing. It processes Google ADK formatted
+    evaluation cases and converts them to CozeLoop's expected format.
+
+    Args:
+        file: Path to the JSON file containing dataset items in Google ADK format.
+        cozeloop_workspace_id: CozeLoop workspace identifier for organizing evaluation sets.
+            If not provided, uses OBSERVABILITY_OPENTELEMETRY_COZELOOP_SERVICE_NAME environment variable.
+        cozeloop_evalset_id: Specific evaluation set ID where items will be uploaded.
+            If not provided, uses OBSERVABILITY_OPENTELEMETRY_COZELOOP_EVALSET_ID environment variable.
+        cozeloop_api_key: API key for authenticating with CozeLoop services.
+            If not provided, uses OBSERVABILITY_OPENTELEMETRY_COZELOOP_API_KEY environment variable.
+    """
+
+    if not cozeloop_workspace_id:
+        cozeloop_workspace_id = getenv(
+            "OBSERVABILITY_OPENTELEMETRY_COZELOOP_SERVICE_NAME"
+        )
+    if not cozeloop_evalset_id:
+        cozeloop_evalset_id = getenv("OBSERVABILITY_OPENTELEMETRY_COZELOOP_EVALSET_ID")
+    if not cozeloop_api_key:
+        cozeloop_api_key = getenv("OBSERVABILITY_OPENTELEMETRY_COZELOOP_API_KEY")
+
+    # Read JSON file
+    file_path = Path(file)
+    if not file_path.exists():
+        logger.error(f"File not found: {file}")
+        return
+
+    logger.info(f"Reading dataset from {file}")
+    with open(file_path, "r", encoding="utf-8") as f:
+        data = json.load(f)
+
+    # Prepare items
+    items = []
+    for case in data.get("eval_cases", []):
+        conversation = case.get("conversation", [])
+        for turn in conversation:
+            user_text = (
+                turn.get("user_content", {}).get("parts", [{}])[0].get("text", "")
+            )
+            output_text = (
+                turn.get("final_response", {}).get("parts", [{}])[0].get("text", "")
+            )
+
+            items.append(
+                {
+                    "turns": [
+                        {
+                            "field_datas": [
+                                {
+                                    "name": "input",
+                                    "content": {
+                                        "content_type": "Text",
+                                        "text": user_text,
+                                    },
+                                },
+                                {
+                                    "name": "output",
+                                    "content": {
+                                        "content_type": "Text",
+                                        "text": output_text,
+                                    },
+                                },
+                            ]
+                        }
+                    ]
+                }
+            )
+
+    # Upload to CozeLoop
+    url = f"https://api.coze.cn/v1/loop/evaluation/evaluation_sets/{cozeloop_evalset_id}/items"
+    logger.info(
+        f"Uploading {len(items)} items to workspace_id={cozeloop_workspace_id} evalset_id={cozeloop_evalset_id}"
+    )
+
+    response = requests.post(
+        url=url,
+        headers={
+            "Authorization": f"Bearer {cozeloop_api_key}",
+            "Content-Type": "application/json",
+            "X-TT-ENV": "ppe_eval_openapi",
+            "x-use-ppe": "1",
+        },
+        json={
+            "workspace_id": cozeloop_workspace_id,
+            "is_allow_partial_add": True,
+            "is_skip_invalid_items": True,
+            "items": items,
+        },
+    )
+
+    if response.status_code == 200:
+        logger.info(
+            f"Successfully uploaded dataset to CozeLoop evalset {cozeloop_evalset_id}"
+        )
+    else:
+        logger.error(f"Failed to upload dataset: {response.text}")

veadk/cli/cli_web.py

@@ -0,0 +1,143 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed 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 functools import wraps
+
+import click
+
+from veadk.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def patch_adkwebserver_disable_openapi():
+    """
+    Monkey patch AdkWebServer to disable OpenAPI documentation endpoints.
+
+    This function patches the AdkWebServer.get_fast_api_app method to remove
+    OpenAPI-related routes (/openapi.json, /docs, /redoc) from the FastAPI
+    application for security and simplicity purposes.
+
+    The patch is applied by replacing the original method with a wrapped version
+    that filters out the unwanted routes after the FastAPI app is created.
+    """
+    import google.adk.cli.adk_web_server
+    from fastapi.routing import APIRoute
+    from starlette.routing import Route
+
+    original_get_fast_api = google.adk.cli.adk_web_server.AdkWebServer.get_fast_api_app
+
+    def wrapped_get_fast_api(self, *args, **kwargs):
+        app = original_get_fast_api(self, *args, **kwargs)
+
+        paths = ["/openapi.json", "/docs", "/redoc"]
+        new_routes = []
+        for route in app.router.routes:
+            if isinstance(route, (APIRoute, Route)) and route.path in paths:
+                continue
+            new_routes.append(route)
+        app.router.routes = new_routes
+
+        return app
+
+    google.adk.cli.adk_web_server.AdkWebServer.get_fast_api_app = wrapped_get_fast_api
+
+
+@click.command(
+    context_settings=dict(ignore_unknown_options=True, allow_extra_args=True)
+)
+@click.pass_context
+def web(ctx, *args, **kwargs) -> None:
+    """
+    Launch a web server with VeADK agent support and memory integration.
+
+    This command starts a web server that can serve VeADK agents with both
+    short-term and long-term memory capabilities. It automatically detects
+    the type of agent being loaded and configures the appropriate memory
+    services accordingly.
+
+    The function patches the ADK web server to integrate VeADK-specific
+    functionality, including memory service configuration and workflow
+    agent detection.
+
+    Args:
+        ctx: Click context object containing command line arguments
+
+    Note:
+        For workflow agents (Sequential, Loop, Parallel), individual sub-agent
+        memory configurations are not utilized as warned in the logs.
+    """
+    from google.adk.cli import adk_web_server
+    from google.adk.runners import Runner as ADKRunner
+
+    from veadk import Agent
+    from veadk.agents.loop_agent import LoopAgent
+    from veadk.agents.parallel_agent import ParallelAgent
+    from veadk.agents.sequential_agent import SequentialAgent
+
+    def before_get_runner_async(func):
+        logger.info("Hook before `get_runner_async`")
+
+        @wraps(func)
+        async def wrapper(*args, **kwargs) -> ADKRunner:
+            self: adk_web_server.AdkWebServer = args[0]
+            app_name: str = args[1]
+            """Returns the cached runner for the given app."""
+            agent_or_app = self.agent_loader.load_agent(app_name)
+
+            if isinstance(agent_or_app, (SequentialAgent, LoopAgent, ParallelAgent)):
+                logger.warning(
+                    "Detect VeADK workflow agent, the short-term memory and long-term memory of each sub agent are useless."
+                )
+
+            if isinstance(agent_or_app, Agent):
+                logger.info("Detect VeADK Agent.")
+
+                if agent_or_app.short_term_memory:
+                    self.session_service = (
+                        agent_or_app.short_term_memory.session_service
+                    )
+
+                if agent_or_app.long_term_memory:
+                    self.memory_service = agent_or_app.long_term_memory
+                    logger.info(
+                        f"Long term memory backend is {self.memory_service.backend}"
+                    )
+
+                logger.info(
+                    f"Current session_service={self.session_service.__class__.__name__}, memory_service={self.memory_service.__class__.__name__}"
+                )
+
+            runner = await func(*args, **kwargs)
+            return runner
+
+        return wrapper
+
+    adk_web_server.AdkWebServer.get_runner_async = before_get_runner_async(
+        adk_web_server.AdkWebServer.get_runner_async
+    )
+
+    patch_adkwebserver_disable_openapi()
+
+    from google.adk.cli.cli_tools_click import cli_web
+
+    extra_args: list = ctx.args
+    logger.debug(f"User args: {extra_args}")
+
+    # set a default log level to avoid unnecessary outputs
+    # from Google ADK and Litellm
+    if "--log_level" not in extra_args:
+        extra_args.extend(["--log_level", "ERROR"])
+
+    cli_web.main(args=extra_args, standalone_mode=False)

veadk/cloud/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed 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.