deploy: 56478f3

_modules/agentscope/agents/dict_dialog_agent.html

@@ -96,10 +96,27 @@ <h1>Source code for agentscope.agents.dict_dialog_agent</h1><div class="highligh
 
 <span class="kn">from</span> <span class="nn">..message</span> <span class="kn">import</span> <span class="n">Msg</span>
 <span class="kn">from</span> <span class="nn">.agent</span> <span class="kn">import</span> <span class="n">AgentBase</span>
+<span class="kn">from</span> <span class="nn">..models.model</span> <span class="kn">import</span> <span class="n">ModelResponse</span>
 <span class="kn">from</span> <span class="nn">..prompt</span> <span class="kn">import</span> <span class="n">PromptEngine</span>
 <span class="kn">from</span> <span class="nn">..prompt</span> <span class="kn">import</span> <span class="n">PromptType</span>
 
 
+<div class="viewcode-block" id="parse_dict">
+<a class="viewcode-back" href="../../../agentscope.agents.html#agentscope.agents.dict_dialog_agent.parse_dict">[docs]</a>
+<span class="k">def</span> <span class="nf">parse_dict</span><span class="p">(</span><span class="n">response</span><span class="p">:</span> <span class="n">ModelResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ModelResponse</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse function for DictDialogAgent&quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">ModelResponse</span><span class="p">(</span><span class="n">raw</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">))</span></div>
+
+
+
+<div class="viewcode-block" id="default_response">
+<a class="viewcode-back" href="../../../agentscope.agents.html#agentscope.agents.dict_dialog_agent.default_response">[docs]</a>
+<span class="k">def</span> <span class="nf">default_response</span><span class="p">(</span><span class="n">response</span><span class="p">:</span> <span class="n">ModelResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ModelResponse</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The default response of fault_handler&quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">ModelResponse</span><span class="p">(</span><span class="n">raw</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;speak&quot;</span><span class="p">:</span> <span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">})</span></div>
+
+
+
 <div class="viewcode-block" id="DictDialogAgent">
 <a class="viewcode-back" href="../../../agentscope.agents.html#agentscope.agents.dict_dialog_agent.DictDialogAgent">[docs]</a>
 <span class="k">class</span> <span class="nc">DictDialogAgent</span><span class="p">(</span><span class="n">AgentBase</span><span class="p">):</span>
@@ -131,8 +148,8 @@ <h1>Source code for agentscope.agents.dict_dialog_agent</h1><div class="highligh
         <span class="n">model_config_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
         <span class="n">use_memory</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
         <span class="n">memory_config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
-        <span class="n">parse_func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">,</span>
-        <span class="n">fault_handler</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;speak&quot;</span><span class="p">:</span> <span class="n">x</span><span class="p">},</span>
+        <span class="n">parse_func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="n">parse_dict</span><span class="p">,</span>
+        <span class="n">fault_handler</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="n">default_response</span><span class="p">,</span>
         <span class="n">max_retries</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
         <span class="n">prompt_type</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">PromptType</span><span class="p">]</span> <span class="o">=</span> <span class="n">PromptType</span><span class="o">.</span><span class="n">LIST</span><span class="p">,</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -151,11 +168,13 @@ <h1>Source code for agentscope.agents.dict_dialog_agent</h1><div class="highligh
 <span class="sd">                Whether the agent has memory.</span>
 <span class="sd">            memory_config (`Optional[dict]`, defaults to `None`):</span>
 <span class="sd">                The config of memory.</span>
-<span class="sd">            parse_func (`Optional[Callable[..., Any]]`, defaults to `None`):</span>
+<span class="sd">            parse_func (`Optional[Callable[..., Any]]`,</span>
+<span class="sd">            defaults to `parse_dict`):</span>
 <span class="sd">                The function used to parse the model output,</span>
 <span class="sd">                e.g. `json.loads`, which is used to extract json from the</span>
 <span class="sd">                output.</span>
-<span class="sd">            fault_handler (`Optional[Callable[..., Any]]`, defaults to `None`):</span>
+<span class="sd">            fault_handler (`Optional[Callable[..., Any]]`,</span>
+<span class="sd">            defaults to `default_response`):</span>
 <span class="sd">                The function used to handle the fault when parse_func fails</span>
 <span class="sd">                to parse the model output.</span>
 <span class="sd">            max_retries (`Optional[int]`, defaults to `None`):</span>
@@ -222,7 +241,7 @@ <h1>Source code for agentscope.agents.dict_dialog_agent</h1><div class="highligh
             <span class="n">parse_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">parse_func</span><span class="p">,</span>
             <span class="n">fault_handler</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fault_handler</span><span class="p">,</span>
             <span class="n">max_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_retries</span><span class="p">,</span>
-        <span class="p">)</span><span class="o">.</span><span class="n">text</span>
+        <span class="p">)</span><span class="o">.</span><span class="n">raw</span>
 
         <span class="c1"># logging raw messages in debug mode</span>
         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">response</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>

_modules/agentscope/models/model.html

@@ -197,7 +197,16 @@ <h1>Source code for agentscope.models.model</h1><div class="highlight"><pre>
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">raw</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Raw dictionary field.&quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_raw</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_raw</span>
+
+    <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+        <span class="n">serialized_fields</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">,</span>
+            <span class="s2">&quot;embedding&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">embedding</span><span class="p">,</span>
+            <span class="s2">&quot;image_urls&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_urls</span><span class="p">,</span>
+            <span class="s2">&quot;raw&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw</span><span class="p">,</span>
+        <span class="p">}</span>
+        <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">serialized_fields</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span></div>
 
 
 

_sources/tutorial/201-agent.md.txt

@@ -90,10 +90,10 @@ def reply(self, x: dict = None) -> dict:
     prompt = self.engine.join(self.sys_prompt, self.memory.get_memory())
 
     # Invoke the language model with the prepared prompt
-    response = self.model(prompt, parse_func=json.loads, fault_handler=lambda x: {"speak": x})
+    response = self.model(prompt).text
 
     # Format the response and create a message object
-    msg = Msg(self.name, response.get("speak", None) or response, **response)
+    msg = Msg(self.name, response)
 
     # Record the message to memory and return it
     self.memory.add(msg)

_sources/tutorial/204-service.md.txt

@@ -118,12 +118,12 @@ class YourAgent(AgentBase):
         prompt += params_prompt
 
         # Get the model response
-        model_response = self.model(prompt)
+        model_response = self.model(prompt).text
 
         # Parse the model response and call the create_file function
         # Additional extraction functions might be necessary
         try:
-            kwargs = json.loads(model_response.content)
+            kwargs = json.loads(model_response)
             create_file(**kwargs)
         except:
             # Error handling

agentscope.agents.html

@@ -117,6 +117,8 @@
 <li class="toctree-l4"><a class="reference internal" href="#agentscope.agents.dict_dialog_agent.DictDialogAgent.reply"><code class="docutils literal notranslate"><span class="pre">DictDialogAgent.reply()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="#agentscope.agents.dict_dialog_agent.default_response"><code class="docutils literal notranslate"><span class="pre">default_response()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#agentscope.agents.dict_dialog_agent.parse_dict"><code class="docutils literal notranslate"><span class="pre">parse_dict()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#module-agentscope.agents.text_to_image_agent">text_to_image_agent module</a><ul>
@@ -589,6 +591,18 @@ <h1>Agents package<a class="headerlink" href="#agents-package" title="Link to th
 
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="agentscope.agents.dict_dialog_agent.default_response">
+<span class="sig-prename descclassname"><span class="pre">agentscope.agents.dict_dialog_agent.</span></span><span class="sig-name descname"><span class="pre">default_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="agentscope.models.html#agentscope.models.model.ModelResponse" title="agentscope.models.model.ModelResponse"><span class="pre">ModelResponse</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="agentscope.models.html#agentscope.models.model.ModelResponse" title="agentscope.models.model.ModelResponse"><span class="pre">ModelResponse</span></a></span></span><a class="reference internal" href="_modules/agentscope/agents/dict_dialog_agent.html#default_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#agentscope.agents.dict_dialog_agent.default_response" title="Link to this definition"></a></dt>
+<dd><p>The default response of fault_handler</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="agentscope.agents.dict_dialog_agent.parse_dict">
+<span class="sig-prename descclassname"><span class="pre">agentscope.agents.dict_dialog_agent.</span></span><span class="sig-name descname"><span class="pre">parse_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="agentscope.models.html#agentscope.models.model.ModelResponse" title="agentscope.models.model.ModelResponse"><span class="pre">ModelResponse</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="agentscope.models.html#agentscope.models.model.ModelResponse" title="agentscope.models.model.ModelResponse"><span class="pre">ModelResponse</span></a></span></span><a class="reference internal" href="_modules/agentscope/agents/dict_dialog_agent.html#parse_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#agentscope.agents.dict_dialog_agent.parse_dict" title="Link to this definition"></a></dt>
+<dd><p>Parse function for DictDialogAgent</p>
+</dd></dl>
+
 </section>
 <section id="module-agentscope.agents.text_to_image_agent">
 <span id="text-to-image-agent-module"></span><h2>text_to_image_agent module<a class="headerlink" href="#module-agentscope.agents.text_to_image_agent" title="Link to this heading"></a></h2>

genindex.html

@@ -418,16 +418,18 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="agentscope.agents.html#agentscope.agents.dict_dialog_agent.default_response">default_response() (in module agentscope.agents.dict_dialog_agent)</a>
+</li>
       <li><a href="agentscope.memory.html#agentscope.memory.memory.MemoryBase.delete">delete() (agentscope.memory.memory.MemoryBase method)</a>
 
       <ul>
         <li><a href="agentscope.memory.html#agentscope.memory.temporary_memory.TemporaryMemory.delete">(agentscope.memory.temporary_memory.TemporaryMemory method)</a>
 </li>
       </ul></li>
-      <li><a href="agentscope.service.file.html#agentscope.service.file.common.delete_directory">delete_directory() (in module agentscope.service.file.common)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="agentscope.service.file.html#agentscope.service.file.common.delete_directory">delete_directory() (in module agentscope.service.file.common)</a>
+</li>
       <li><a href="agentscope.service.file.html#agentscope.service.file.common.delete_file">delete_file() (in module agentscope.service.file.common)</a>
 </li>
       <li><a href="agentscope.agents.html#agentscope.agents.dialog_agent.DialogAgent">DialogAgent (class in agentscope.agents.dialog_agent)</a>
@@ -719,14 +721,16 @@ <h2 id="O">O</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="agentscope.agents.html#agentscope.agents.dict_dialog_agent.parse_dict">parse_dict() (in module agentscope.agents.dict_dialog_agent)</a>
+</li>
       <li><a href="agentscope.pipelines.html#agentscope.pipelines.pipeline.PipelineBase">PipelineBase (class in agentscope.pipelines.pipeline)</a>
 </li>
       <li><a href="agentscope.pipelines.html#agentscope.pipelines.functional.placeholder">placeholder() (in module agentscope.pipelines.functional)</a>
-</li>
-      <li><a href="agentscope.models.html#agentscope.models.post_model.PostAPIChatWrapper">PostAPIChatWrapper (class in agentscope.models.post_model)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="agentscope.models.html#agentscope.models.post_model.PostAPIChatWrapper">PostAPIChatWrapper (class in agentscope.models.post_model)</a>
+</li>
       <li><a href="agentscope.models.html#agentscope.models.post_model.PostAPIDALLEWrapper">PostAPIDALLEWrapper (class in agentscope.models.post_model)</a>
 </li>
       <li><a href="agentscope.models.html#agentscope.models.post_model.PostAPIModelWrapperBase">PostAPIModelWrapperBase (class in agentscope.models.post_model)</a>