veadk-python 0.1.0__tar.gz → 0.2.1__tar.gz

{veadk_python-0.1.0 → veadk_python-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.1.0
+Version: 0.2.1
 Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
 Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
 Requires-Python: >=3.10
@@ -79,9 +79,18 @@ uv pip install -e .
 
 ## Configuration
 
-We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
 
-You can refer to the [example config file](config.yaml.example) for more details.
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
+
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
 
 ## Have a try
 
@@ -101,8 +110,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution
 

{veadk_python-0.1.0 → veadk_python-0.2.1}/README.md

@@ -39,9 +39,18 @@ uv pip install -e .
 
 ## Configuration
 
-We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
+
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
 
-You can refer to the [example config file](config.yaml.example) for more details.
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
 
 ## Have a try
 
@@ -61,8 +70,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution
 

{veadk_python-0.1.0 → veadk_python-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "veadk-python"
-version = "0.1.0"
+version = "0.2.1"
 description = "Volcengine agent development kit, integrations with Volcengine cloud services."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -64,4 +64,10 @@ dev = [
 
 [tool.setuptools.packages.find]
 include = ["veadk*"]
-exclude = ["app*", "assets*", "examples*", "ide*", "tests*",]
+exclude = ["assets*", "ide*", "tests*"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"veadk" = ["**/*"]

{veadk_python-0.1.0 → veadk_python-0.2.1}/tests/test_agent.py

@@ -49,7 +49,6 @@ def test_agent():
     assert agent.long_term_memory.backend == "local"
     assert load_memory in agent.tools
 
-    assert tracer.llm_metrics_hook in agent.before_model_callback
-    assert tracer.token_metrics_hook in agent.after_model_callback
-    assert tracer.token_metrics_hook in agent.after_model_callback
-    assert tracer.token_metrics_hook in agent.after_model_callback
+    assert tracer.tracer_hook_before_model in agent.before_model_callback
+    assert tracer.tracer_hook_after_model in agent.after_model_callback
+    assert tracer.tracer_hook_after_tool in agent.after_tool_callback

veadk_python-0.2.1/tests/test_cloud.py

@@ -0,0 +1,124 @@
+# 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
+import tempfile
+import pytest
+
+from unittest.mock import Mock, patch, AsyncMock
+
+os.environ["VOLCENGINE_ACCESS_KEY"] = "test_access_key"
+os.environ["VOLCENGINE_SECRET_KEY"] = "test_secret_key"
+
+from veadk.cloud.cloud_agent_engine import CloudAgentEngine
+
+
+@pytest.mark.asyncio
+async def test_cloud():
+    app_name = "test-app"
+    key = "CloudTestIdentifier123"
+    test_endpoint = "https://test-endpoint.volcengine.com"
+    test_message = "Hello cloud agent"
+
+    # Create temporary directory with required agent.py file for testing
+    with tempfile.TemporaryDirectory() as temp_dir:
+        with open(os.path.join(temp_dir, "agent.py"), "w") as f:
+            f.write(f"# Test agent implementation with {key}")
+
+        # Mock shutil.copy to avoid template file copying issues
+        with patch("shutil.copy"):
+            with patch("veadk.cloud.cloud_agent_engine.VeFaaS") as mock_vefaas_class:
+                # Setup mock VeFaaS service for all operations
+                mock_vefaas_service = Mock()
+                mock_vefaas_class.return_value = mock_vefaas_service
+
+                # Mock deploy operation
+                mock_vefaas_service.deploy.return_value = (
+                    test_endpoint,
+                    "app-123",
+                    "func-456",
+                )
+
+                # Mock update operation
+                mock_vefaas_service._update_function_code.return_value = (
+                    test_endpoint,
+                    "app-123",
+                    "func-456",
+                )
+
+                # Mock remove operation
+                mock_vefaas_service.find_app_id_by_name.return_value = "app-123"
+                mock_vefaas_service.delete.return_value = None
+
+                # Test CloudAgentEngine creation and deploy functionality
+                engine = CloudAgentEngine()
+
+                # Test deploy operation
+                cloud_app = engine.deploy(application_name=app_name, path=temp_dir)
+
+                # Verify deployment result contains expected values
+                assert cloud_app.vefaas_application_name == app_name
+                assert cloud_app.vefaas_endpoint == test_endpoint
+                assert cloud_app.vefaas_application_id == "app-123"
+
+                # Test update_function_code operation
+                updated_app = engine.update_function_code(
+                    application_name=app_name, path=temp_dir
+                )
+
+                # Verify update result maintains same endpoint
+                assert updated_app.vefaas_endpoint == test_endpoint
+
+                # Test remove operation with mocked user input
+                with patch("builtins.input", return_value="y"):
+                    engine.remove(app_name)
+                    mock_vefaas_service.find_app_id_by_name.assert_called_with(app_name)
+                    mock_vefaas_service.delete.assert_called_with("app-123")
+
+                # Test CloudApp message_send functionality
+                mock_response = Mock()
+                mock_message = Mock()
+                mock_response.root.result = mock_message
+
+                with patch.object(cloud_app, "_get_a2a_client") as mock_get_client:
+                    mock_client = AsyncMock()
+                    mock_client.send_message = AsyncMock(return_value=mock_response)
+                    mock_get_client.return_value = mock_client
+
+                    # Test message sending to cloud agent
+                    result = await cloud_app.message_send(
+                        message=test_message,
+                        session_id="session-123",
+                        user_id="user-456",
+                    )
+
+                    # Verify message sending result
+                    assert result == mock_message
+                    mock_client.send_message.assert_called_once()
+
+                # Test CloudApp delete_self functionality
+                with patch("builtins.input", return_value="y"):
+                    with patch(
+                        "veadk.cli.services.vefaas.vefaas.VeFaaS"
+                    ) as mock_vefaas_in_app:
+                        mock_vefaas_client = Mock()
+                        mock_vefaas_in_app.return_value = mock_vefaas_client
+                        mock_vefaas_client.delete.return_value = None
+
+                        cloud_app.delete_self()
+                        mock_vefaas_client.delete.assert_called_with("app-123")
+
+                # Verify all mocks were called as expected
+                mock_vefaas_service.deploy.assert_called_once()
+                mock_vefaas_service._update_function_code.assert_called_once()

veadk_python-0.2.1/tests/test_evaluator.py

@@ -0,0 +1,161 @@
+# 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 os
+
+from veadk.evaluation.base_evaluator import BaseEvaluator
+
+EVAL_SET_DATA = {
+    "eval_set_id": "home_automation_agent_light_on_off_set",
+    "name": "",
+    "description": "This is an eval set that is used for unit testing `x` behavior of the Agent",
+    "eval_cases": [
+        {
+            "eval_id": "eval_case_id",
+            "conversation": [
+                {
+                    "invocation_id": "b7982664-0ab6-47cc-ab13-326656afdf75",  # Unique identifier for the invocation.
+                    "user_content": {  # Content provided by the user in this invocation. This is the query.
+                        "parts": [{"text": "Turn off device_2 in the Bedroom."}],
+                        "role": "user",
+                    },
+                    "final_response": {  # Final response from the agent that acts as a reference of benchmark.
+                        "parts": [{"text": "I have set the device_2 status to off."}],
+                        "role": "model",
+                    },
+                    "intermediate_data": {
+                        "tool_uses": [  # Tool use trajectory in chronological order.
+                            {
+                                "args": {
+                                    "location": "Bedroom",
+                                    "device_id": "device_2",
+                                    "status": "OFF",
+                                },
+                                "name": "set_device_info",
+                            }
+                        ],
+                        "intermediate_responses": [],  # Any intermediate sub-agent responses.
+                    },
+                }
+            ],
+            "session_input": {  # Initial session input.
+                "app_name": "home_automation_agent",
+                "user_id": "test_user",
+                "state": {},
+            },
+        }
+    ],
+}
+
+TRACE_SET_DATA = [
+    {
+        "name": "execute_tool get_city_weather",
+        "span_id": 5421848634094108689,
+        "trace_id": 115143748123782151752771111946932434777,
+        "start_time": 1754884672226444000,
+        "end_time": 1754884672226993000,
+        "attributes": {
+            "gen_ai.tool.name": "get_city_weather",
+            "gen_ai.tool.description": "Retrieves the weather information of a given city. the args must in English",
+            "gen_ai.tool.call.id": "call_6ow5622pvcouw3tpvr7rfqtl",
+            "gcp.vertex.agent.tool_call_args": '{"city": "Xi\'an"}',
+        },
+        "parent_span_id": 7997784243558253239,
+    },
+    {
+        "name": "call_llm",
+        "span_id": 7997784243558253239,
+        "trace_id": 115143748123782151752771111946932434777,
+        "attributes": {
+            "session.id": "veadk_example_session",
+            "user.id": "veadk_default_user",
+        },
+        "parent_span_id": 14844888006539887900,
+    },
+    {
+        "name": "call_llm",
+        "span_id": 7789424022423491416,
+        "trace_id": 115143748123782151752771111946932434777,
+        "attributes": {
+            "session.id": "veadk_example_session",
+            "user.id": "veadk_default_user",
+        },
+        "parent_span_id": 14844888006539887900,
+    },
+    {
+        "name": "agent_run [chat_robot]",
+        "span_id": 14844888006539887900,
+        "trace_id": 115143748123782151752771111946932434777,
+        "attributes": {
+            "session.id": "veadk_example_session",
+            "user.id": "veadk_default_user",
+        },
+        "parent_span_id": 2943363177785645047,
+    },
+    {
+        "name": "invocation [veadk_default_app]",
+        "span_id": 2943363177785645047,
+        "trace_id": 115143748123782151752771111946932434777,
+        "start_time": 1754884660687962000,
+        "end_time": 1754884676664833000,
+        "attributes": {
+            "input.value": '{"user_id": "veadk_default_user", "session_id": "veadk_example_session", "new_message": "{\\"parts\\": [{\\"video_metadata\\": null, \\"thought\\": null, \\"inline_data\\": null, \\"file_data\\": null, \\"thought_signature\\": null, \\"code_execution_result\\": null, \\"executable_code\\": null, \\"function_call\\": null, \\"function_response\\": null, \\"text\\": \\"How is the weather like in Xi\'an?\\"}], \\"role\\": \\"user\\"}", "run_config": "{\\"speech_config\\": null, \\"response_modalities\\": null, \\"save_input_blobs_as_artifacts\\": false, \\"support_cfc\\": false, \\"streaming_mode\\": \\"StreamingMode.NONE\\", \\"output_audio_transcription\\": null, \\"input_audio_transcription\\": null, \\"realtime_input_config\\": null, \\"enable_affective_dialog\\": null, \\"proactivity\\": null, \\"max_llm_calls\\": 500}"}',
+            "user.id": "veadk_default_user",
+            "session.id": "veadk_example_session",
+            "output.value": '{"content":{"parts":[{"text":"The weather in Xi\'an is cool, with a temperature of 18\u00b0C."}],"role":"model"},"partial":false,"usage_metadata":{"candidates_token_count":132,"prompt_token_count":547,"total_token_count":679},"invocation_id":"e-ea6bb35b-c3f0-4c5c-b127-c71c7d6d6441","author":"chat_robot","actions":{"state_delta":{},"artifact_delta":{},"requested_auth_configs":{}},"id":"c0929124-9be0-4f75-a6ba-f7a531c9ccb6","timestamp":1754884672.227546}',
+        },
+        "parent_span_id": None,
+    },
+]
+
+
+def test_evaluator():
+    base_evaluator = BaseEvaluator(agent=None, name="test_evaluator")
+
+    # save data to file
+    eval_set_file_path = "./eval_set_for_test_evaluator.json"
+    with open(eval_set_file_path, "w") as f:
+        json.dump(EVAL_SET_DATA, f)
+
+    base_evaluator.generate_eval_data(file_path=eval_set_file_path)
+
+    assert len(base_evaluator.invocation_list) == 1
+    assert len(base_evaluator.invocation_list[0].invocations) == 1
+    assert (
+        base_evaluator.invocation_list[0].invocations[0].invocation_id
+        == "b7982664-0ab6-47cc-ab13-326656afdf75"
+    )
+
+    os.remove(eval_set_file_path)
+
+
+def test_tracing_file_to_evalset():
+    base_evaluator = BaseEvaluator(agent=None, name="test_evaluator")
+
+    # save data to file
+    tracing_file_path = "./tracing_for_test_evaluator.json"
+    with open(tracing_file_path, "w") as f:
+        json.dump(TRACE_SET_DATA, f)
+
+    base_evaluator.generate_eval_data(file_path=tracing_file_path)
+
+    assert len(base_evaluator.invocation_list) == 1
+    assert len(base_evaluator.invocation_list[0].invocations) == 1
+    assert (
+        base_evaluator.invocation_list[0].invocations[0].invocation_id
+        == "e-ea6bb35b-c3f0-4c5c-b127-c71c7d6d6441"
+    )
+
+    os.remove(tracing_file_path)

{veadk_python-0.1.0 → veadk_python-0.2.1}/tests/test_knowledgebase.py

@@ -33,5 +33,3 @@ async def test_knowledgebase():
     )
     res = "".join(res_list)
     assert key in res, f"Test failed for backend local res is {res}"
-    assert key in res, f"Test failed for backend local res is {res}"
-    assert key in res, f"Test failed for backend local res is {res}"

{veadk_python-0.1.0 → veadk_python-0.2.1}/tests/test_long_term_memory.py

@@ -49,7 +49,7 @@ async def test_long_term_memory():
         events=[
             Event(
                 invocation_id="test_invocation_id",
-                author=agent.name,
+                author="user",
                 branch=None,
                 content=types.Content(
                     parts=[types.Part(text="My name is Alice.")],

{veadk_python-0.1.0 → veadk_python-0.2.1}/tests/test_tracing.py

@@ -14,6 +14,12 @@
 
 
 import pytest
+from opentelemetry import trace as trace_api
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+    OTLPSpanExporter,
+)
+from opentelemetry.sdk import trace as trace_sdk
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
 
 from veadk.tracing.telemetry.exporters.apmplus_exporter import (
     APMPlusExporter,
@@ -34,8 +40,7 @@ USER_ID = "testuser"
 SESSION_ID = "testsession"
 
 
-@pytest.mark.asyncio
-async def test_tracing():
+def init_exporters():
     cozeloop_exporter = CozeloopExporter(
         config=CozeloopExporterConfig(
             endpoint="http://localhost:8000",
@@ -61,12 +66,51 @@ async def test_tracing():
             secret_key="test_secret_key",
         )
     )
+    return [cozeloop_exporter, apmplus_exporter, tls_exporter]
+
+
+def gen_span_processor(endpoint: str):
+    otlp_exporter = OTLPSpanExporter(
+        endpoint=endpoint,
+    )
+    span_processor = BatchSpanProcessor(otlp_exporter)
+    return span_processor
 
-    exporters = [cozeloop_exporter, apmplus_exporter, tls_exporter]
+
+@pytest.mark.asyncio
+async def test_tracing():
+    exporters = init_exporters()
     tracer = OpentelemetryTracer(exporters=exporters)
 
-    assert len(tracer.exporters) == 5  # with extra 2 built-in exporters
+    assert len(tracer.exporters) == 4  # with extra 1 built-in exporters
 
     # TODO: Ensure the tracing provider is set correctly after loading SDK
-    # TODO: Ensure the tracing provider is set correctly after loading SDK
-    # TODO: Ensure the tracing provider is set correctly after loading SDK
+
+
+@pytest.mark.asyncio
+async def test_tracing_with_global_provider():
+    exporters = init_exporters()
+    # set global tracer provider before init OpentelemetryTracer
+    trace_api.set_tracer_provider(trace_sdk.TracerProvider())
+    tracer_provider = trace_api.get_tracer_provider()
+    tracer_provider.add_span_processor(gen_span_processor("http://localhost:8000"))
+    trace_api.set_tracer_provider(tracer_provider)
+    #
+    tracer = OpentelemetryTracer(exporters=exporters)
+
+    assert len(tracer.exporters) == 4  # with extra 1 built-in exporters
+
+
+@pytest.mark.asyncio
+async def test_tracing_with_apmplus_global_provider():
+    exporters = init_exporters()
+    # add apmplus exporter to global tracer provider before init OpentelemetryTracer
+    trace_api.set_tracer_provider(trace_sdk.TracerProvider())
+    tracer_provider = trace_api.get_tracer_provider()
+    tracer_provider.add_span_processor(gen_span_processor("http://apmplus-region.com"))
+
+    # init OpentelemetryTracer
+    tracer = OpentelemetryTracer(exporters=exporters)
+
+    # apmplus exporter won't init again
+    assert len(tracer.exporters) == 3  # with extra 1 built-in exporters

veadk_python-0.2.1/veadk/a2a/remote_ve_agent.py

@@ -0,0 +1,33 @@
+# 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
+from a2a.types import AgentCard
+from google.adk.agents.remote_a2a_agent import RemoteA2aAgent
+
+AGENT_CARD_WELL_KNOWN_PATH = "/.well-known/agent.json"
+
+
+class RemoteVeAgent(RemoteA2aAgent):
+    def __init__(self, name: str, url: str):
+        agent_card_dict = requests.get(url + AGENT_CARD_WELL_KNOWN_PATH).json()
+        agent_card_dict["url"] = url
+
+        agent_card_json_str = json.dumps(agent_card_dict, ensure_ascii=False, indent=2)
+
+        agent_card_object = AgentCard.model_validate_json(str(agent_card_json_str))
+
+        super().__init__(name=name, agent_card=agent_card_object)

{veadk_python-0.1.0 → veadk_python-0.2.1}/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