.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "build_tutorial/agent.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_build_tutorial_agent.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_build_tutorial_agent.py:


.. _build-agent:

构建智能体
====================

AgentScope 中，可以通过继承基类`agentscope.agents.AgentBase`来构建智能体

在下面，我们将构建一个简单的，可以和其他人互动的智能体。

.. GENERATED FROM PYTHON SOURCE LINES 13-21

.. code-block:: Python


    from agentscope.agents import AgentBase
    from agentscope.memory import TemporaryMemory
    from agentscope.message import Msg
    from agentscope.models import DashScopeChatWrapper
    import json









.. GENERATED FROM PYTHON SOURCE LINES 22-38

定义智能体
--------------------------------
继承 `agentscope.agents.AgentBase` 类并实现其构造函数和 `reply` 方法。

在构造函数中，我们初始化智能体的名字、系统提示、记忆模块和模型。
在本例中，我们采用 DashScope Chat API 中的 `qwen-max` 作为模型服务。
当然，你可以将其替换为 `agentscope.models` 下的其它模型。

`reply`方法是智能体的核心，它接受消息作为输入并返回回复消息。
在该方法中，我们实现了智能体的基本逻辑:

- 在记忆中记录输入消息，
- 使用系统提示和记忆构建提示词，
- 调用模型获取返回值，
- 在记忆中记录返回值并返回一个消息。


.. GENERATED FROM PYTHON SOURCE LINES 38-81

.. code-block:: Python



    class JarvisAgent(AgentBase):
        def __init__(self):
            super().__init__("Jarvis")

            self.name = "Jarvis"
            self.sys_prompt = "你是一个名为Jarvis的助手。"
            self.memory = TemporaryMemory()
            self.model = DashScopeChatWrapper(
                config_name="_",
                model_name="qwen-max",
            )

        def reply(self, msg):
            # 在记忆中记录消息
            self.memory.add(msg)

            # 使用系统提示和记忆构建上下文
            prompt = self.model.format(
                Msg(
                    name="system",
                    content=self.sys_prompt,
                    role="system",
                ),
                self.memory.get_memory(),
            )

            # 调用模型获取响应
            response = self.model(prompt)

            # 在记忆中记录响应消息并返回
            msg = Msg(
                name=self.name,
                content=response.text,
                role="assistant",
            )
            self.memory.add(msg)

            self.speak(msg)
            return msg









.. GENERATED FROM PYTHON SOURCE LINES 82-84

创建智能体类后，我们实例化它，并通过发送消息与之交互。


.. GENERATED FROM PYTHON SOURCE LINES 84-100

.. code-block:: Python


    jarvis = JarvisAgent()

    msg = Msg(
        name="user",
        content="嗨！Jarvis。",
        role="user",
    )

    msg_reply = jarvis(msg)

    print(f"消息的发送者: {msg_reply.name}")
    print(f"发送者的角色: {msg_reply.role}")
    print(f"消息的内容: {msg_reply.content}")






.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Jarvis: 你好！有什么我可以帮你的吗？
    消息的发送者: Jarvis
    发送者的角色: assistant
    消息的内容: 你好！有什么我可以帮你的吗？




.. GENERATED FROM PYTHON SOURCE LINES 101-114

======================

组件
----------
现在我们简要介绍上述智能体中使用到的基本组件，包括

* 记忆
* 模型

记忆
^^^^^^^
记忆模块提供了记忆管理的基本操作。


.. GENERATED FROM PYTHON SOURCE LINES 114-131

.. code-block:: Python


    memory = TemporaryMemory()

    # 添加一条消息
    memory.add(Msg("system", "你是一个名为Jarvis的助手。", "system"))

    # 一次添加多条消息
    memory.add(
        [
            Msg("Stank", "嗨!", "user"),
            Msg("Jarvis", "我能为您做些什么吗?", "assistant"),
        ],
    )

    print(f"当前记忆: {memory.get_memory()}")
    print(f"当前大小: {memory.size()}")





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    当前记忆: [<agentscope.message.msg.Msg object at 0x7f02aeb903d0>, <agentscope.message.msg.Msg object at 0x7f02aeb90040>, <agentscope.message.msg.Msg object at 0x7f02aeb90130>]
    当前大小: 3




.. GENERATED FROM PYTHON SOURCE LINES 132-134

使用参数 `recent_n` 获取最后两条消息。


.. GENERATED FROM PYTHON SOURCE LINES 134-142

.. code-block:: Python


    recent_two_msgs = memory.get_memory(recent_n=2)

    for i, msg in enumerate(recent_two_msgs):
        print(
            f"MSG{i}: 发送者: {msg.name}, 角色: {msg.role}, 内容: {msg.content}",
        )





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    MSG0: 发送者: Stank, 角色: user, 内容: 嗨!
    MSG1: 发送者: Jarvis, 角色: assistant, 内容: 我能为您做些什么吗?




.. GENERATED FROM PYTHON SOURCE LINES 143-145

删除记忆中的第一条消息。


.. GENERATED FROM PYTHON SOURCE LINES 145-151

.. code-block:: Python


    memory.delete(0)

    print(f"删除后的记忆: {memory.get_memory()}")
    print(f"删除后的大小: {memory.size()}")





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    删除后的记忆: [<agentscope.message.msg.Msg object at 0x7f02aeb90040>, <agentscope.message.msg.Msg object at 0x7f02aeb90130>]
    删除后的大小: 2




.. GENERATED FROM PYTHON SOURCE LINES 152-158

模型
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
`agentscope.models` 封装了不同的模型 API，并在其 `format` 函数中为不同的 API 提供了基本的提示词构建策略。

以 DashScope Chat API 为例:


.. GENERATED FROM PYTHON SOURCE LINES 158-172

.. code-block:: Python


    messages = [
        Msg("system", "你是一个名为Jarvis的助手。", "system"),
        Msg("Stank", "嗨!", "user"),
        Msg("Jarvis", "我能为您做些什么吗?", "assistant"),
    ]

    model = DashScopeChatWrapper(
        config_name="api",
        model_name="qwen-max",
    )
    prompt = model.format(messages)
    print(json.dumps(prompt, indent=4, ensure_ascii=False))





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    [
        {
            "role": "system",
            "content": "你是一个名为Jarvis的助手。"
        },
        {
            "role": "user",
            "content": "## Conversation History\nStank: 嗨!\nJarvis: 我能为您做些什么吗?"
        }
    ]




.. GENERATED FROM PYTHON SOURCE LINES 173-177

进一步阅读
---------------------
- :ref:`builtin-agent`
- :ref:`model_api`


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 1.380 seconds)


.. _sphx_glr_download_build_tutorial_agent.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: agent.ipynb <agent.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: agent.py <agent.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: agent.zip <agent.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_