elkar 的安装和配置教程

项目基础介绍

elkar 是一个开源的任务管理层，用于构建基于 Google 的 Agent2Agent 协议（A2A）的人工智能代理。它允许开发者轻松地发送、跟踪和协调跨 AI 代理的任务。elkar 提供了一个 Python SDK，以及其他语言的即将支持，以简化 A2A 协议的实现，并且还有一个应用和 API 来管理、监控和调试代理任务。

主要编程语言

elkar 项目主要使用 Python 编程语言。

项目使用的关键技术和框架

• A2A 协议：Google 开发的 Agent2Agent 协议，用于代理间的通信。
• 异步操作：使用 Python 的异步编程特性来处理任务。
• RESTful API：提供 API 以便其他应用或服务与之交互。
• Supabase 或其他后端存储：用于任务存储和管理。

准备工作

在开始安装 elkar 之前，请确保您的系统中已经安装了以下软件：

• Python 3.8 或更高版本
• pip（Python 包管理器）
• Node.js 和 npm（用于运行调试器）

安装步骤

步骤 1：安装 Python SDK

首先，确保您的 Python 环境已经准备好。然后，使用 pip 安装 elkar SDK：

pip install elkar

步骤 2：创建任务处理器

在您的 Python 文件中，定义一个异步函数来处理任务。下面是一个基本的任务处理器示例：

from elkar.a2a_types import *
from elkar.server.server import A2AServer
from elkar.task_manager.task_manager_base import RequestContext
from elkar.task_manager.task_manager_with_task_modifier import TaskManagerWithModifier
from elkar.task_modifier.base import TaskModifierBase

async def task_handler(task: TaskModifierBase, request_context: RequestContext):
    await task.set_status(
        TaskStatus(
            state=TaskState.WORKING,
            message=Message(
                role="agent",
                parts=[TextPart(text="我理解了任务，正在处理中...")]
            )
        )
    )
    await task.upsert_artifacts([
        Artifact(
            parts=[
                TextPart(text="任务完成，这是结果...")
            ],
            index=0
        )
    ])
    await task.set_status(
        TaskStatus(
            state=TaskState.COMPLETED,
            message=Message(
                role="agent",
                parts=[TextPart(text="任务已完成！")]
            ),
            is_final=True
        )
    )

步骤 3：创建代理卡片

代理卡片是根据 A2A 协议的要求定义的。在您的 Python 文件中创建一个代理卡片：

agent_card = AgentCard(
    name="测试代理",
    description="测试代理描述",
    url="https://example.com",
    provider=AgentProvider(
        organization="Elkar",
        url="https://www.elkar.co"
    ),
    documentationUrl="https://example.com/documentation",
    version="1.0.0",
    skills=[
        AgentSkill(
            id="1",
            name="生成图像",
            description="根据提示描述生成图像",
            inputModes=["text"],
            outputModes=["image"]
        ),
    ],
    capabilities=AgentCapabilities(
        streaming=True,
        pushNotifications=True,
        stateTransitionHistory=True
    )
)

步骤 4：创建 A2A 服务器

实例化您的 A2A 服务器，使用托管服务作为任务存储：

api_key = "YOUR_ELKAR_API_KEY"  # 替换为您的实际 Elkar API 密钥
store = ElkarClientStore(
    base_url="https://api.elkar.co/api",
    api_key=api_key
)

task_manager = TaskManagerWithModifier(
    agent_card,
    send_task_handler=task_handler,
    store=store
)

server = A2AServer(
    task_manager,
    host="0.0.0.0",
    port=5001,
    endpoint="/"
)

server.start()  # 注意：这在生产环境中应使用 ASGI 服务器如 Uvicorn

步骤 5：运行和调试

如果想要仅用于调试 A2A 服务器，可以运行调试器：

cd a2a-client
npm run a2adebugger

然后，在浏览器中打开 http://localhost:5173 进行调试。

以上步骤就是 elkar 的安装和配置的基本教程。在实际应用中，您可能需要根据自己的需求进行更多的配置和定制。