Skip to content

Commit 56748fc

Browse files
committed
chore: update docs to match new models
Signed-off-by: Jeff Napper <103025963+jnapper7@users.noreply.github.com>
1 parent ca038d1 commit 56748fc

File tree

14 files changed

+1088
-199
lines changed

14 files changed

+1088
-199
lines changed

docs/html/_modules/agntcy_acp/acp_v0/models/value_run_error_update.html

Lines changed: 237 additions & 0 deletions
Large diffs are not rendered by default.

docs/html/_modules/agntcy_acp/acp_v0/models/value_run_interrupt_update.html

Lines changed: 231 additions & 0 deletions
Large diffs are not rendered by default.

docs/html/_modules/agntcy_acp/agws_v0/models.html

Lines changed: 78 additions & 34 deletions
Large diffs are not rendered by default.

docs/html/_modules/agntcy_acp/client.html

Lines changed: 20 additions & 3 deletions
Large diffs are not rendered by default.

docs/html/_modules/agntcy_acp/langgraph/acp_node.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,8 @@ <h1>Source code for agntcy_acp.langgraph.acp_node</h1><div class="highlight"><pr
397397
<span class="c1"># The spec does not require an output so count it as success.</span>
398398
<span class="k">return</span> <span class="kc">None</span>
399399

400-
<span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_run_output</span><span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">run_output</span><span class="p">)</span></div>
400+
<span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_run_output</span><span class="p">(</span><span class="n">state</span><span class="p">,</span> <span class="n">run_output</span><span class="p">)</span>
401+
<span class="k">return</span> <span class="n">state</span></div>
401402

402403

403404
<span class="k">def</span><span class="w"> </span><span class="nf">_convert_stream_mode</span><span class="p">(</span>

docs/html/_modules/agntcy_acp/manifest/generator.html

Lines changed: 92 additions & 98 deletions
Large diffs are not rendered by default.

docs/html/_modules/agntcy_acp/manifest/validator.html

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,16 @@
3333
<h1>Source code for agntcy_acp.manifest.validator</h1><div class="highlight"><pre>
3434
<span></span><span class="c1"># Copyright AGNTCY Contributors (https://github.com/agntcy)</span>
3535
<span class="c1"># SPDX-License-Identifier: Apache-2.0</span>
36-
<span class="kn">import</span><span class="w"> </span><span class="nn">copy</span>
3736
<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
37+
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
3838

3939
<span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">ValidationError</span>
4040

41+
<span class="kn">from</span><span class="w"> </span><span class="nn">agntcy_acp.agws_v0</span><span class="w"> </span><span class="kn">import</span> <span class="n">OASF_EXTENSION_NAME_MANIFEST</span><span class="p">,</span> <span class="n">AgentManifest</span>
4142
<span class="kn">from</span><span class="w"> </span><span class="nn">agntcy_acp.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">ACPDescriptorValidationException</span>
4243
<span class="kn">from</span><span class="w"> </span><span class="nn">agntcy_acp.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">AgentACPDescriptor</span>
4344

44-
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">AgentManifest</span>
45+
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
4546

4647

4748
<div class="viewcode-block" id="validate_agent_manifest_file">
@@ -66,11 +67,23 @@ <h1>Source code for agntcy_acp.manifest.validator</h1><div class="highlight"><pr
6667

6768

6869

69-
<span class="k">def</span><span class="w"> </span><span class="nf">_descriptor_from_manifest</span><span class="p">(</span><span class="n">manifest_json</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
70-
<span class="c1"># ACP Descriptor is an Agent Manifest without the deployment part</span>
71-
<span class="n">descriptor_json</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">manifest_json</span><span class="p">)</span>
72-
<span class="k">del</span> <span class="n">descriptor_json</span><span class="p">[</span><span class="s2">&quot;deployment&quot;</span><span class="p">]</span>
73-
<span class="k">return</span> <span class="n">descriptor_json</span>
70+
<div class="viewcode-block" id="descriptor_from_manifest_obj">
71+
<a class="viewcode-back" href="../../../agntcy_acp.manifest.html#agntcy_acp.manifest.validator.descriptor_from_manifest_obj">[docs]</a>
72+
<span class="k">def</span><span class="w"> </span><span class="nf">descriptor_from_manifest_obj</span><span class="p">(</span><span class="n">manifest</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="n">AgentManifest</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
73+
<span class="c1"># ACP Descriptor is in the extensions of an Agent Manifest</span>
74+
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">manifest</span><span class="p">,</span> <span class="s2">&quot;extensions&quot;</span><span class="p">):</span>
75+
<span class="k">for</span> <span class="n">ext</span> <span class="ow">in</span> <span class="n">manifest</span><span class="o">.</span><span class="n">extensions</span><span class="p">:</span>
76+
<span class="k">if</span> <span class="n">ext</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">OASF_EXTENSION_NAME_MANIFEST</span><span class="p">:</span>
77+
<span class="n">descriptor_json</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">acp</span>
78+
<span class="k">return</span> <span class="n">descriptor_json</span>
79+
<span class="k">else</span><span class="p">:</span>
80+
<span class="k">for</span> <span class="n">ext</span> <span class="ow">in</span> <span class="n">manifest</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;extensions&quot;</span><span class="p">,</span> <span class="p">[]):</span>
81+
<span class="k">if</span> <span class="n">ext</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="n">OASF_EXTENSION_NAME_MANIFEST</span><span class="p">:</span>
82+
<span class="n">ext_json</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;data&quot;</span><span class="p">,</span> <span class="p">{})</span>
83+
<span class="n">descriptor_json</span> <span class="o">=</span> <span class="n">ext_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;acp&quot;</span><span class="p">,</span> <span class="p">{})</span>
84+
<span class="k">return</span> <span class="n">descriptor_json</span>
85+
<span class="k">return</span> <span class="p">{}</span></div>
86+
7487

7588

7689
<div class="viewcode-block" id="validate_agent_manifest">
@@ -80,13 +93,14 @@ <h1>Source code for agntcy_acp.manifest.validator</h1><div class="highlight"><pr
8093
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentManifest</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
8194
<span class="k">try</span><span class="p">:</span>
8295
<span class="n">manifest</span> <span class="o">=</span> <span class="n">AgentManifest</span><span class="o">.</span><span class="n">model_validate</span><span class="p">(</span><span class="n">manifest_json</span><span class="p">)</span>
83-
<span class="n">descriptor_json</span> <span class="o">=</span> <span class="n">_descriptor_from_manifest</span><span class="p">(</span><span class="n">manifest_json</span><span class="p">)</span>
96+
<span class="n">descriptor_json</span> <span class="o">=</span> <span class="n">descriptor_from_manifest_obj</span><span class="p">(</span><span class="n">manifest_json</span><span class="p">)</span>
8497
<span class="n">validate_agent_descriptor</span><span class="p">(</span><span class="n">descriptor_json</span><span class="p">)</span>
8598
<span class="c1"># TODO: add additional manifest checks</span>
8699
<span class="k">except</span> <span class="p">(</span><span class="n">ValidationError</span><span class="p">,</span> <span class="n">ACPDescriptorValidationException</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
87-
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Validation Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
88100
<span class="k">if</span> <span class="n">raise_exception</span><span class="p">:</span>
89101
<span class="k">raise</span> <span class="n">e</span>
102+
<span class="k">else</span><span class="p">:</span>
103+
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Validation Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
90104
<span class="k">return</span> <span class="kc">None</span>
91105

92106
<span class="k">return</span> <span class="n">manifest</span></div>
@@ -104,9 +118,10 @@ <h1>Source code for agntcy_acp.manifest.validator</h1><div class="highlight"><pr
104118
<span class="c1"># advanced validation</span>
105119
<span class="c1"># generate_agent_oapi(descriptor)</span>
106120
<span class="k">except</span> <span class="p">(</span><span class="n">ValidationError</span><span class="p">,</span> <span class="n">ACPDescriptorValidationException</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
107-
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Validation Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
108121
<span class="k">if</span> <span class="n">raise_exception</span><span class="p">:</span>
109122
<span class="k">raise</span> <span class="n">e</span>
123+
<span class="k">else</span><span class="p">:</span>
124+
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Validation Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
110125
<span class="k">return</span> <span class="kc">None</span>
111126

112127
<span class="k">return</span> <span class="n">descriptor</span></div>

docs/html/_modules/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232

3333
<h1>All modules for which code is available</h1>
3434
<ul><li><a href="agntcy_acp/acp_v0/api_response.html">agntcy_acp.acp_v0.api_response</a></li>
35-
<li><a href="agntcy_acp/acp_v0/async_client/api_client.html">agntcy_acp.acp_v0.async_client.api_client</a></li>
3635
<li><a href="agntcy_acp/acp_v0/exceptions.html">agntcy_acp.acp_v0.exceptions</a></li>
3736
<li><a href="agntcy_acp/acp_v0/models/agent.html">agntcy_acp.acp_v0.models.agent</a></li>
3837
<li><a href="agntcy_acp/acp_v0/models/agent_acp_descriptor.html">agntcy_acp.acp_v0.models.agent_acp_descriptor</a></li>
@@ -75,6 +74,8 @@ <h1>All modules for which code is available</h1>
7574
<li><a href="agntcy_acp/acp_v0/models/thread_search_request.html">agntcy_acp.acp_v0.models.thread_search_request</a></li>
7675
<li><a href="agntcy_acp/acp_v0/models/thread_state.html">agntcy_acp.acp_v0.models.thread_state</a></li>
7776
<li><a href="agntcy_acp/acp_v0/models/thread_status.html">agntcy_acp.acp_v0.models.thread_status</a></li>
77+
<li><a href="agntcy_acp/acp_v0/models/value_run_error_update.html">agntcy_acp.acp_v0.models.value_run_error_update</a></li>
78+
<li><a href="agntcy_acp/acp_v0/models/value_run_interrupt_update.html">agntcy_acp.acp_v0.models.value_run_interrupt_update</a></li>
7879
<li><a href="agntcy_acp/acp_v0/models/value_run_result_update.html">agntcy_acp.acp_v0.models.value_run_result_update</a></li>
7980
<li><a href="agntcy_acp/acp_v0/sync_client/api_client.html">agntcy_acp.acp_v0.sync_client.api_client</a></li>
8081
<li><a href="agntcy_acp/agws_v0/models.html">agntcy_acp.agws_v0.models</a></li>

0 commit comments

Comments
 (0)