feat: agent

Author: zakahan

.gitignore

@@ -49,4 +49,5 @@ __pycache__/
 *.local.yaml
 .cloudide/
 
-dist/*.whl
+dist/*.whl
+examples/**/*.json

Makefile

@@ -43,8 +43,8 @@ test:
 # Define a variable for Python and notebook files.
 PYTHON_FILES=.
 MYPY_CACHE=.mypy_cache
-format: PYTHON_FILES=./arkitect
-lint: PYTHON_FILES=./arkitect
+format: PYTHON_FILES=./arkitect ./examples
+lint: PYTHON_FILES=./arkitect ./examples
 lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=arkitect/ --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
 lint_package: PYTHON_FILES=arkitect
 lint_tests: PYTHON_FILES=tests

arkitect/core/client/__init__.py

@@ -14,6 +14,7 @@
 
 from .base import Client, ClientPool, get_client_pool
 from .http import default_ark_client, load_request
+from .redis import RedisClient
 from .sse import AsyncSSEDecoder
 
 __all__ = [
@@ -23,4 +24,5 @@
     "default_ark_client",
     "load_request",
     "get_client_pool",
+    "RedisClient",
 ]

arkitect/core/client/redis.py

@@ -0,0 +1,121 @@
+# Copyright 2025 Bytedance 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 redis.asyncio as redis
+from redis.asyncio.retry import Retry
+from redis.backoff import ExponentialBackoff
+from redis.exceptions import BusyLoadingError, ConnectionError, TimeoutError
+
+from arkitect.core.client.base import Client
+
+
+class RedisClient(Client):
+    """
+    Initialize a new Redis client object.
+
+    Parameters:
+    host (str): The hostname of the Redis server.
+    username (str): The username for the Redis server.
+    password (str): The password for the Redis server.
+
+    Returns:
+    None.
+
+    """
+
+    def __init__(self, host: str, username: str, password: str):
+        self.client = redis.Redis(
+            host=host,
+            username=username,
+            password=password,
+            retry=Retry(ExponentialBackoff(), 3),
+            retry_on_error=[BusyLoadingError, ConnectionError, TimeoutError],
+        )
+
+    async def get(self, key: str) -> str:
+        """
+        Get the value of a key from the Redis database.
+
+        Args:
+        key (str): The key to retrieve from the Redis database.
+
+        Returns:
+        str: The value of the key, or None if the key does not exist.
+
+        """
+        return await self.client.get(key)
+
+    async def set(self, key: str, value: str) -> None:
+        """
+        Set the value of a key in the Redis database.
+        Args:
+        key (str): The key to set in the Redis database.
+        value (str): The value to set for the key.
+        Returns:
+        None.
+        """
+        await self.client.set(key, value)
+
+    async def get_with_prefix(self, prefix: str) -> tuple[list[str], list[str]]:
+        """
+        Asynchronous method to obtain all keys and values from the
+        Redis database that match the specified prefix
+
+        :param prefix: The specified prefix
+
+        :return: A list of tuples containing matching keys
+            and their corresponding values
+        """
+
+        cursor = 0
+        keys = []
+
+        while True:
+            # 使用 SCAN 命令进行迭代查询
+            cursor, key_data = await self.client.scan(cursor, match=prefix, count=1000)
+
+            # 将匹配到的 key 添加到列表中
+            keys.extend(key_data)
+
+            # 如果游标值为 0，则表示遍历完成
+            if cursor == 0 or len(key_data) == 0:
+                break
+
+        # 使用 MGET 命令获取所有匹配到的 key 的对应 value
+        values = await self.client.mget(keys)
+
+        return keys, values
+
+    async def mget(self, keys: list[str]) -> list[str]:
+        """
+        Get the values of multiple keys from the Redis database.
+
+        Args:
+        keys (list): A list of keys to retrieve from the Redis database.
+
+        Returns:
+        list: A list of values corresponding to the given keys.
+
+        """
+        return await self.client.mget(keys)
+
+    async def delete(self, key: str) -> None:
+        """
+        Delete a key from the Redis database.
+        Args:
+        key (str): The key to delete from the Redis database.
+        Returns:
+        None.
+        """
+        await self.client.delete(key)

arkitect/core/component/agent/__init__.py

@@ -0,0 +1,19 @@
+# Copyright 2025 Bytedance 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 arkitect.core.component.agent.base_agent import BaseAgent
+from arkitect.core.component.agent.default_agent import DefaultAgent
+from arkitect.core.component.agent.parallel_agent import ParallelAgent
+
+__all__ = ["BaseAgent", "ParallelAgent", "DefaultAgent"]

arkitect/core/component/agent/base_agent.py

@@ -0,0 +1,95 @@
+# Copyright 2025 Bytedance 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 abc
+from typing import Any, AsyncIterable, Callable, Union
+
+from pydantic import BaseModel
+from volcenginesdkarkruntime import AsyncArk
+
+from arkitect.core.component.llm_event_stream.model import State
+from arkitect.core.component.tool import MCPClient
+from arkitect.types.llm.model import ArkChatParameters
+from arkitect.types.responses.event import BaseEvent
+
+"""
+Agent is the core interface for all runnable agents
+"""
+
+
+class PreAgentCallHook(abc.ABC):
+    @abc.abstractmethod
+    async def pre_agent_call(
+        self,
+        state: State,
+    ) -> AsyncIterable[BaseEvent]:
+        return
+        yield
+
+
+class PostAgentCallHook(abc.ABC):
+    @abc.abstractmethod
+    async def post_agent_call(
+        self,
+        state: State,
+    ) -> AsyncIterable[BaseEvent]:
+        return
+        yield
+
+
+class BaseAgent(abc.ABC, BaseModel):
+    name: str
+    description: str = ""
+    model: str
+    tools: list[Union[MCPClient | Callable]] = []
+    sub_agents: list["BaseAgent"] = []
+    instruction: str | None = None
+    parameters: ArkChatParameters | None = None
+    client: AsyncArk | None = None
+
+    pre_agent_call_hook: PreAgentCallHook | None = None
+    post_agent_call_hook: PostAgentCallHook | None = None
+
+    model_config = {
+        "arbitrary_types_allowed": True,
+    }
+
+    # stream run step
+    @abc.abstractmethod
+    async def _astream(self, state: State, **kwargs: Any) -> AsyncIterable[BaseEvent]:
+        return
+        yield
+
+    async def astream(self, state: State, **kwargs: Any) -> AsyncIterable[BaseEvent]:
+        if self.pre_agent_call_hook:
+            async for event in self.pre_agent_call_hook.pre_agent_call(state):
+                yield event
+
+        async for event in self._astream(state, **kwargs):
+            if event.author == "":
+                event.author = self.name
+            yield event
+
+        if self.post_agent_call_hook:
+            async for event in self.post_agent_call_hook.post_agent_call(state):
+                yield event
+
+    async def __call__(self, state: State, **kwargs: Any) -> AsyncIterable[BaseEvent]:
+        async for event in self.astream(state, **kwargs):
+            yield event
+
+
+class SwitchAgent(BaseModel):
+    agent_name: str
+    message: str

arkitect/core/component/agent/default_agent.py

@@ -0,0 +1,73 @@
+# Copyright 2025 Bytedance 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 typing import Any, AsyncIterable
+
+from pydantic import BaseModel
+
+from arkitect.core.component.agent import BaseAgent
+from arkitect.core.component.llm_event_stream.hooks import (
+    PostLLMCallHook,
+    PostToolCallHook,
+    PreLLMCallHook,
+    PreToolCallHook,
+)
+from arkitect.core.component.llm_event_stream.llm_event_stream import LLMEventStream
+from arkitect.core.component.llm_event_stream.model import State
+from arkitect.types.responses.event import BaseEvent
+
+"""
+Agent is the core interface for all runnable agents
+"""
+
+
+class DefaultAgent(BaseAgent):
+    model_config = {
+        "arbitrary_types_allowed": True,
+    }
+
+    pre_tool_call_hook: PreToolCallHook | None = None
+    post_tool_call_hook: PostToolCallHook | None = None
+    pre_llm_call_hook: PreLLMCallHook | None = None
+    post_llm_call_hook: PostLLMCallHook | None = None
+
+    # stream run step
+    async def _astream(self, state: State, **kwargs: Any) -> AsyncIterable[BaseEvent]:
+        event_stream = LLMEventStream(
+            model=self.model,
+            agent_name=self.name,
+            tools=self.tools,
+            sub_agents=self.sub_agents,
+            state=state,
+            instruction=self.instruction,
+            pre_tool_call_hook=self.pre_tool_call_hook,
+            post_tool_call_hook=self.post_tool_call_hook,
+            pre_llm_call_hook=self.pre_llm_call_hook,
+            post_llm_call_hook=self.post_llm_call_hook,
+            parameters=self.parameters,
+            client=self.client,
+        )
+        await event_stream.init()
+        resp_stream = await event_stream.completions.create(
+            messages=[],
+            **kwargs,
+        )
+
+        async for event in resp_stream:
+            yield event
+
+
+class SwitchAgent(BaseModel):
+    agent_name: str
+    message: str