veadk-python 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

veadk/a2a/remote_ve_agent.py

@@ -1,3 +1,17 @@
+# 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 json
 
 import requests

veadk/agent.py

@@ -39,6 +39,7 @@ from veadk.prompts.agent_default_prompt import DEFAULT_DESCRIPTION, DEFAULT_INST
 from veadk.tracing.base_tracer import BaseTracer
 from veadk.utils.logger import get_logger
 from veadk.utils.patches import patch_asyncio
+from google.adk.agents.base_agent import BaseAgent
 
 patch_asyncio()
 logger = get_logger(__name__)
@@ -77,7 +78,7 @@ class Agent(LlmAgent):
     tools: list[ToolUnion] = []
     """The tools provided to agent."""
 
-    sub_agents: list[Agent] = Field(default_factory=list, exclude=True)
+    sub_agents: list[BaseAgent] = Field(default_factory=list, exclude=True)
     """The sub agents provided to agent."""
 
     knowledgebase: Optional[KnowledgeBase] = None
@@ -117,9 +118,11 @@ class Agent(LlmAgent):
         if self.tracers:
             self.before_model_callback = []
             self.after_model_callback = []
+            self.after_tool_callback = []
             for tracer in self.tracers:
-                self.before_model_callback.append(tracer.llm_metrics_hook)
-                self.after_model_callback.append(tracer.token_metrics_hook)
+                self.before_model_callback.append(tracer.tracer_hook_before_model)
+                self.after_model_callback.append(tracer.tracer_hook_after_model)
+                self.after_tool_callback.append(tracer.tracer_hook_after_tool)
 
         logger.info(f"Agent `{self.name}` init done.")
         logger.debug(
@@ -220,6 +223,9 @@ class Agent(LlmAgent):
             session_service=session_service,
             memory_service=self.long_term_memory,
         )
+        if getattr(self, "tracers", None):
+            for tracer in self.tracers:
+                tracer.set_app_name(app_name)
 
         logger.info(f"Begin to process prompt {prompt}")
         # run

veadk/cli/main.py

@@ -18,6 +18,7 @@ import importlib.util
 import os
 import shutil
 import sys
+from importlib.util import module_from_spec, spec_from_file_location
 from pathlib import Path
 
 import typer
@@ -31,6 +32,32 @@ logger = get_logger(__name__)
 app = typer.Typer(name="vego")
 
 
+def set_variable_in_file(file_path: str, setting_values: dict):
+    import ast
+
+    with open(file_path, "r", encoding="utf-8") as f:
+        source_code = f.read()
+
+    tree = ast.parse(source_code)
+
+    class VariableTransformer(ast.NodeTransformer):
+        def visit_Assign(self, node: ast.Assign):
+            for target in node.targets:
+                if isinstance(target, ast.Name) and target.id in setting_values:
+                    node.value = ast.Constant(value=setting_values[target.id])
+            return node
+
+    transformer = VariableTransformer()
+    new_tree = transformer.visit(tree)
+    ast.fix_missing_locations(new_tree)
+    new_source_code = ast.unparse(new_tree)
+
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write(new_source_code)
+
+    print("Your project has beed created.")
+
+
 @app.command()
 def init():
     """Init a veadk project that can be deployed to Volcengine VeFaaS."""
@@ -39,9 +66,9 @@ def init():
     cwd = Path.cwd()
     template_dir = Path(__file__).parent.resolve() / "services" / "vefaas" / "template"
 
-    name = Prompt.ask("Project name", default="veadk-cloud-agent")
+    local_dir_name = Prompt.ask("Local directory name", default="veadk-cloud-proj")
 
-    target_dir = cwd / name
+    target_dir = cwd / local_dir_name
 
     if target_dir.exists():
         response = Confirm.ask(
@@ -51,11 +78,57 @@ def init():
             print("Operation cancelled.")
             return
         else:
-            shutil.rmtree(target_dir)  # 删除旧目录
+            shutil.rmtree(target_dir)
             print(f"Deleted existing directory: {target_dir}")
 
+    vefaas_application_name = Prompt.ask(
+        "Volcengine FaaS application name", default="veadk-cloud-agent"
+    )
+
+    gateway_name = Prompt.ask(
+        "Volcengine gateway instance name", default="", show_default=True
+    )
+
+    gateway_service_name = Prompt.ask(
+        "Volcengine gateway service name", default="", show_default=True
+    )
+
+    gateway_upstream_name = Prompt.ask(
+        "Volcengine gateway upstream name", default="", show_default=True
+    )
+
+    deploy_mode_options = {
+        "1": "A2A Server",
+        "2": "VeADK Studio",
+        "3": "VeADK Web / Google ADK Web",
+    }
+
+    deploy_mode = Prompt.ask(
+        """Choose your deploy mode:
+1. A2A Server
+2. VeADK Studio
+3. VeADK Web / Google ADK Web
+""",
+        default="1",
+    )
+
+    if deploy_mode in deploy_mode_options:
+        deploy_mode = deploy_mode_options[deploy_mode]
+    else:
+        print("Invalid deploy mode, set default to A2A Server")
+        deploy_mode = deploy_mode_options["1"]
+
+    setting_values = {
+        "VEFAAS_APPLICATION_NAME": vefaas_application_name,
+        "GATEWAY_NAME": gateway_name,
+        "GATEWAY_SERVICE_NAME": gateway_service_name,
+        "GATEWAY_UPSTREAM_NAME": gateway_upstream_name,
+        "USE_STUDIO": deploy_mode == deploy_mode_options["2"],
+        "USE_ADK_WEB": deploy_mode == deploy_mode_options["3"],
+    }
+
     shutil.copytree(template_dir, target_dir)
-    print(f"Created new project: {name}")
+    set_variable_in_file(target_dir / "deploy.py", setting_values)
 
 
 # @app.command()
@@ -128,6 +201,10 @@ def web(
         None,
         "--session_service_uri",
     ),
+    host: str = typer.Option(
+        "127.0.0.1",
+        "--host",
+    ),
 ):
     from google.adk.memory import in_memory_memory_service
 
@@ -143,7 +220,7 @@ def web(
         session_service_uri = ""
 
     cli_tools_click.cli_web.main(
-        args=[agents_dir, "--session_service_uri", session_service_uri]
+        args=[agents_dir, "--session_service_uri", session_service_uri, "--host", host]
     )
 
 
@@ -151,11 +228,35 @@ def web(
 def studio(
     path: str = typer.Option(".", "--path", help="Project path"),
 ):
+    from veadk.cli.studio.fast_api import get_fast_api_app
+
     path = Path(path).resolve()
 
-    from veadk.cli.studio.fast_api import get_fast_api_app
+    agent_py_path = os.path.join(path, "agent.py")
+    if not os.path.exists(agent_py_path):
+        raise FileNotFoundError(f"agent.py not found in {path}")
+
+    spec = spec_from_file_location("agent", agent_py_path)
+    if spec is None:
+        raise ImportError(f"Could not load spec for agent from {agent_py_path}")
+
+    module = module_from_spec(spec)
+
+    try:
+        spec.loader.exec_module(module)
+    except Exception as e:
+        raise ImportError(f"Failed to execute agent.py: {e}")
+
+    agent = None
+    short_term_memory = None
+    try:
+        agent = module.agent
+        short_term_memory = module.short_term_memory
+    except AttributeError as e:
+        missing = str(e).split("'")[1] if "'" in str(e) else "unknown"
+        raise AttributeError(f"agent.py is missing required variable: {missing}")
 
-    app = get_fast_api_app(agents_dir=str(path))
+    app = get_fast_api_app(agent, short_term_memory)
 
     uvicorn.run(
         app,

veadk/cli/services/vefaas/template/README.md

@@ -0,0 +1,37 @@
+# Template project for Vefaas
+
+This is a template project for Vefaas. You can use it as a starting point for your own project.
+
+We implement an minimal agent to report weather in terms of the given city.
+
+## Structure
+
+| File                   | Illustration |
+|------------------------| - |
+| `src/app.py`           | The entrypoint of VeFaaS server. |
+| `src/run.sh`           | The launch script of VeFaaS server. |
+| `src/requirements.txt` | Dependencies of your project. `VeADK`, `FastAPI`, and `uvicorn` must be included. |
+| `src/agent.py`         | The agent and memory definitions. **You may edit this file.** |
+| `config.yaml.example`  | Envs for your project (e.g., `api_key`, `token`, ...). **You may edit this file.** |
+| `deploy.py`            | Local script for deployment. |
+
+You must export your agent and short-term memory in `src/agent.py`.
+
+## Deploy
+
+We recommend you deploy this project by the `cloud` module of VeADK.
+
+```bash
+python deploy.py
+```
+
+You may see output like this:
+
+```bash
+Successfully deployed on:
+
+https://....volceapi.com
+Message ID: ...
+Response from ...: The weather in Beijing is sunny, with a temperature of 25°C.
+App ID: ...
+```

veadk/cli/services/vefaas/template/__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.

veadk/cli/services/vefaas/template/config.yaml.example

@@ -0,0 +1,19 @@
+model:
+  agent:
+    provider: openai
+    name: doubao-1-5-pro-256k-250115
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: 
+  judge:
+    name: doubao-1-5-pro-256k-250115
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key:
+
+
+agent_pilot:
+  api_key:
+
+
+volcengine:
+  access_key: 
+  secret_key: 

veadk/cli/services/vefaas/template/deploy.py

@@ -20,24 +20,38 @@ from veadk.cloud.cloud_agent_engine import CloudAgentEngine
 SESSION_ID = "cloud_app_test_session"
 USER_ID = "cloud_app_test_user"
 
+VEFAAS_APPLICATION_NAME = "weather-reporter"
+GATEWAY_NAME = ""
+GATEWAY_SERVICE_NAME = ""
+GATEWAY_UPSTREAMNAME = ""
+USE_STUDIO = False
+USE_ADK_WEB = False
+
 
 async def main():
     engine = CloudAgentEngine()
+
     cloud_app = engine.deploy(
         path=str(Path(__file__).parent / "src"),
-        name="weather-reporter",
-        # gateway_name="",  # <--- your gateway instance name if you have
-    )
-
-    response_message = await cloud_app.message_send(
-        "How is the weather like in Beijing?", SESSION_ID, USER_ID
+        application_name=VEFAAS_APPLICATION_NAME,
+        gateway_name=GATEWAY_NAME,
+        gateway_service_name=GATEWAY_SERVICE_NAME,
+        gateway_upstream_name=GATEWAY_UPSTREAMNAME,
+        use_studio=USE_STUDIO,
+        use_adk_web=USE_ADK_WEB,
     )
 
-    print(f"Message ID: {response_message.messageId}")
-
-    print(f"Response from {cloud_app.endpoint}: {response_message.parts[0].root.text}")
-
-    print(f"App ID: {cloud_app.app_id}")
+    if not USE_STUDIO and not USE_ADK_WEB:
+        response_message = await cloud_app.message_send(
+            "How is the weather like in Beijing?", SESSION_ID, USER_ID
+        )
+        print(f"VeFaaS application ID: {cloud_app.vefaas_application_id}")
+        print(f"Message ID: {response_message.messageId}")
+        print(
+            f"Response from {cloud_app.vefaas_endpoint}: {response_message.parts[0].root.text}"
+        )
+    else:
+        print(f"Web is running at: {cloud_app.vefaas_endpoint}")
 
 
 if __name__ == "__main__":

veadk/cli/services/vefaas/template/src/__init__.py

@@ -0,0 +1,14 @@
+# 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 . import agent  # noqa F401

veadk/cli/services/vefaas/template/src/agent.py

@@ -0,0 +1,25 @@
+# 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 veadk import Agent
+from veadk.memory.short_term_memory import ShortTermMemory
+from veadk.tools.demo_tools import get_city_weather
+
+app_name: str = "weather-reporter"  # <--- export your app name
+agent: Agent = Agent(tools=[get_city_weather])  # <--- export your agent
+short_term_memory: ShortTermMemory = (
+    ShortTermMemory()
+)  # <--- export your short term memory
+
+root_agent = agent

veadk/cli/services/vefaas/template/src/app.py

@@ -14,17 +14,57 @@
 
 import os
 
-from config import AGENT, APP_NAME, SHORT_TERM_MEMORY, TRACERS
-
+from agent import agent, app_name, short_term_memory
 from veadk.a2a.ve_a2a_server import init_app
+from veadk.tracing.base_tracer import BaseTracer
+from veadk.tracing.telemetry.opentelemetry_tracer import OpentelemetryTracer
+
+
+# ==============================================================================
+# Tracer Config ================================================================
+
+TRACERS: list[BaseTracer] = []
+
+exporters = []
+if os.getenv("VEADK_TRACER_APMPLUS", "").lower() == "true":
+    from veadk.tracing.telemetry.exporters.apmplus_exporter import APMPlusExporter
+
+    exporters.append(APMPlusExporter())
+
+if os.getenv("VEADK_TRACER_COZELOOP", "").lower() == "true":
+    from veadk.tracing.telemetry.exporters.cozeloop_exporter import CozeloopExporter
+
+    exporters.append(CozeloopExporter())
+
+if os.getenv("VEADK_TRACER_TLS", "").lower() == "true":
+    from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporter
+
+    exporters.append(TLSExporter())
+
+TRACERS.append(OpentelemetryTracer(exporters=exporters))
+
 
-SERVER_HOST = os.getenv("SERVER_HOST")
+agent.tracers.extend(TRACERS)
+if not getattr(agent, "before_model_callback", None):
+    agent.before_model_callback = []
+if not getattr(agent, "after_model_callback", None):
+    agent.after_model_callback = []
+if not getattr(agent, "after_tool_callback", None):
+    agent.after_tool_callback = []
+for tracer in TRACERS:
+    if tracer.tracer_hook_before_model not in agent.before_model_callback:
+        agent.before_model_callback.append(tracer.tracer_hook_before_model)
+    if tracer.tracer_hook_after_model not in agent.after_model_callback:
+        agent.after_model_callback.append(tracer.tracer_hook_after_model)
+    if tracer.tracer_hook_after_tool not in agent.after_tool_callback:
+        agent.after_tool_callback.append(tracer.tracer_hook_after_tool)
 
-AGENT.tracers.extend(TRACERS)
+# Tracer Config ================================================================
+# ==============================================================================
 
 app = init_app(
-    server_url=SERVER_HOST,
-    app_name=APP_NAME,
-    agent=AGENT,
-    short_term_memory=SHORT_TERM_MEMORY,
+    server_url="0.0.0.0",  # Automatic identification is not supported yet.
+    app_name=app_name,
+    agent=agent,
+    short_term_memory=short_term_memory,
 )

veadk/cli/services/vefaas/template/src/requirements.txt

@@ -0,0 +1,6 @@
+veadk-python[eval] @ git+https://github.com/volcengine/veadk-python.git # extra eval for prompt optimization in veadk studio
+opensearch-py==2.8.0
+agent-pilot-sdk>=0.0.9 # extra dep for prompt optimization in veadk studio
+typer>=0.16.0
+uvicorn[standard]
+fastapi

veadk/cli/services/vefaas/template/src/run.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+set -ex
+cd `dirname $0`
+
+# A special check for CLI users (run.sh should be located at the 'root' dir)
+if [ -d "output" ]; then
+    cd ./output/
+fi
+
+# Default values for host and port
+HOST="0.0.0.0"
+PORT=${_FAAS_RUNTIME_PORT:-8000}
+TIMEOUT=${_FAAS_FUNC_TIMEOUT}
+
+export SERVER_HOST=$HOST
+export SERVER_PORT=$PORT
+
+export PYTHONPATH=$PYTHONPATH:./site-packages
+# Parse arguments
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        --port)
+            PORT="$2"
+            shift 2
+            ;;
+        --host)
+            HOST="$2"
+            shift 2
+            ;;
+        *)
+            shift
+            ;;
+    esac
+done
+
+# in case of uvicorn and fastapi not installed in user's requirements.txt
+python3 -m pip install uvicorn[standard]
+
+python3 -m pip install fastapi
+
+USE_STUDIO=${USE_STUDIO:-False}
+USE_ADK_WEB=${USE_ADK_WEB:-False}
+
+if [ "$USE_STUDIO" = "True" ]; then
+    echo "USE_STUDIO is True, running veadk studio"
+    # running veadk studio
+    exec python3 -m uvicorn studio_app:app --host $HOST --port $PORT --timeout-graceful-shutdown $TIMEOUT --loop asyncio
+elif [ "$USE_STUDIO" = "False" ]; then
+    echo "USE_STUDIO is False"
+
+    if [ "$USE_ADK_WEB" = "True" ]; then
+        echo "USE_ADK_WEB is True, running veadk web"
+        # running veadk web
+        cd ../
+        exec python3 -m veadk.cli.main web --host "0.0.0.0"
+    else
+        echo "USE_ADK_WEB is False, running a2a server"
+        exec python3 -m uvicorn app:app --host $HOST --port $PORT --timeout-graceful-shutdown $TIMEOUT --loop asyncio
+    fi
+else
+    # running a2a server
+    exec python3 -m uvicorn app:app --host $HOST --port $PORT --timeout-graceful-shutdown $TIMEOUT --loop asyncio
+fi

veadk/cli/services/vefaas/template/src/studio_app.py

@@ -0,0 +1,47 @@
+# 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 os
+from importlib.util import module_from_spec, spec_from_file_location
+from pathlib import Path
+
+from veadk.cli.studio.fast_api import get_fast_api_app
+
+path = Path(__file__).parent.resolve()
+
+agent_py_path = os.path.join(path, "agent.py")
+if not os.path.exists(agent_py_path):
+    raise FileNotFoundError(f"agent.py not found in {path}")
+
+spec = spec_from_file_location("agent", agent_py_path)
+if spec is None:
+    raise ImportError(f"Could not load spec for agent from {agent_py_path}")
+
+module = module_from_spec(spec)
+
+try:
+    spec.loader.exec_module(module)
+except Exception as e:
+    raise ImportError(f"Failed to execute agent.py: {e}")
+
+agent = None
+short_term_memory = None
+try:
+    agent = module.agent
+    short_term_memory = module.short_term_memory
+except AttributeError as e:
+    missing = str(e).split("'")[1] if "'" in str(e) else "unknown"
+    raise AttributeError(f"agent.py is missing required variable: {missing}")
+
+app = get_fast_api_app(agent, short_term_memory)