Update Docs
This commit is contained in:
477
web/public/docs/ums/utils/request.html
Normal file
477
web/public/docs/ums/utils/request.html
Normal file
File diff suppressed because one or more lines are too long
@ -161,6 +161,48 @@
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<a class="class" href="#AgentResponse">AgentResponse</a>
|
||||
<ul class="memberlist">
|
||||
<li>
|
||||
<a class="variable" href="#AgentResponse.count">count</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#AgentResponse.msg">msg</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#AgentResponse.error">error</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#AgentResponse.error_msg">error_msg</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
<a class="class" href="#MessageDbRow">MessageDbRow</a>
|
||||
<ul class="memberlist">
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.count">count</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.sender">sender</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.recipient">recipient</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.time">time</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.message">message</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="variable" href="#MessageDbRow.processed">processed</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -558,6 +600,66 @@ It provides validation, allow JSON serialization and works well with <a href="ht
|
||||
</span><span id="L-290"><a href="#L-290"><span class="linenos">290</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-291"><a href="#L-291"><span class="linenos">291</span></a><span class="sd"> The status of the riddle.</span>
|
||||
</span><span id="L-292"><a href="#L-292"><span class="linenos">292</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-293"><a href="#L-293"><span class="linenos">293</span></a>
|
||||
</span><span id="L-294"><a href="#L-294"><span class="linenos">294</span></a><span class="k">class</span> <span class="nc">AgentResponse</span><span class="p">(</span><span class="n">RiddleInformation</span><span class="p">):</span>
|
||||
</span><span id="L-295"><a href="#L-295"><span class="linenos">295</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-296"><a href="#L-296"><span class="linenos">296</span></a><span class="sd"> Returned by the management when receiving an `AgentMessage`.</span>
|
||||
</span><span id="L-297"><a href="#L-297"><span class="linenos">297</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-298"><a href="#L-298"><span class="linenos">298</span></a>
|
||||
</span><span id="L-299"><a href="#L-299"><span class="linenos">299</span></a> <span class="n">count</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="L-300"><a href="#L-300"><span class="linenos">300</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-301"><a href="#L-301"><span class="linenos">301</span></a><span class="sd"> The count of the message (overall numeric id).</span>
|
||||
</span><span id="L-302"><a href="#L-302"><span class="linenos">302</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-303"><a href="#L-303"><span class="linenos">303</span></a>
|
||||
</span><span id="L-304"><a href="#L-304"><span class="linenos">304</span></a> <span class="n">msg</span><span class="p">:</span> <span class="nb">str</span><span class="o">|</span><span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="L-305"><a href="#L-305"><span class="linenos">305</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-306"><a href="#L-306"><span class="linenos">306</span></a><span class="sd"> An additional message.</span>
|
||||
</span><span id="L-307"><a href="#L-307"><span class="linenos">307</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-308"><a href="#L-308"><span class="linenos">308</span></a>
|
||||
</span><span id="L-309"><a href="#L-309"><span class="linenos">309</span></a> <span class="n">error</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="L-310"><a href="#L-310"><span class="linenos">310</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-311"><a href="#L-311"><span class="linenos">311</span></a><span class="sd"> If an error occurred.</span>
|
||||
</span><span id="L-312"><a href="#L-312"><span class="linenos">312</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-313"><a href="#L-313"><span class="linenos">313</span></a>
|
||||
</span><span id="L-314"><a href="#L-314"><span class="linenos">314</span></a> <span class="n">error_msg</span><span class="p">:</span> <span class="nb">str</span><span class="o">|</span><span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="L-315"><a href="#L-315"><span class="linenos">315</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-316"><a href="#L-316"><span class="linenos">316</span></a><span class="sd"> Error message (if `error` )</span>
|
||||
</span><span id="L-317"><a href="#L-317"><span class="linenos">317</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-318"><a href="#L-318"><span class="linenos">318</span></a>
|
||||
</span><span id="L-319"><a href="#L-319"><span class="linenos">319</span></a><span class="k">class</span> <span class="nc">MessageDbRow</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
||||
</span><span id="L-320"><a href="#L-320"><span class="linenos">320</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-321"><a href="#L-321"><span class="linenos">321</span></a><span class="sd"> Object representing a database row.</span>
|
||||
</span><span id="L-322"><a href="#L-322"><span class="linenos">322</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-323"><a href="#L-323"><span class="linenos">323</span></a>
|
||||
</span><span id="L-324"><a href="#L-324"><span class="linenos">324</span></a> <span class="n">count</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="L-325"><a href="#L-325"><span class="linenos">325</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-326"><a href="#L-326"><span class="linenos">326</span></a><span class="sd"> The count (primary key) of the item.</span>
|
||||
</span><span id="L-327"><a href="#L-327"><span class="linenos">327</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-328"><a href="#L-328"><span class="linenos">328</span></a>
|
||||
</span><span id="L-329"><a href="#L-329"><span class="linenos">329</span></a> <span class="n">sender</span> <span class="p">:</span> <span class="nb">str</span>
|
||||
</span><span id="L-330"><a href="#L-330"><span class="linenos">330</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-331"><a href="#L-331"><span class="linenos">331</span></a><span class="sd"> The sender of the message.</span>
|
||||
</span><span id="L-332"><a href="#L-332"><span class="linenos">332</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-333"><a href="#L-333"><span class="linenos">333</span></a>
|
||||
</span><span id="L-334"><a href="#L-334"><span class="linenos">334</span></a> <span class="n">recipient</span> <span class="p">:</span> <span class="nb">str</span>
|
||||
</span><span id="L-335"><a href="#L-335"><span class="linenos">335</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-336"><a href="#L-336"><span class="linenos">336</span></a><span class="sd"> The recipient of the message</span>
|
||||
</span><span id="L-337"><a href="#L-337"><span class="linenos">337</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-338"><a href="#L-338"><span class="linenos">338</span></a>
|
||||
</span><span id="L-339"><a href="#L-339"><span class="linenos">339</span></a> <span class="n">time</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="L-340"><a href="#L-340"><span class="linenos">340</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-341"><a href="#L-341"><span class="linenos">341</span></a><span class="sd"> The time (unix timestamp) the message was received/ sent.</span>
|
||||
</span><span id="L-342"><a href="#L-342"><span class="linenos">342</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-343"><a href="#L-343"><span class="linenos">343</span></a>
|
||||
</span><span id="L-344"><a href="#L-344"><span class="linenos">344</span></a> <span class="n">message</span> <span class="p">:</span> <span class="n">AgentMessage</span>
|
||||
</span><span id="L-345"><a href="#L-345"><span class="linenos">345</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-346"><a href="#L-346"><span class="linenos">346</span></a><span class="sd"> The message received/ sent.</span>
|
||||
</span><span id="L-347"><a href="#L-347"><span class="linenos">347</span></a><span class="sd"> """</span>
|
||||
</span><span id="L-348"><a href="#L-348"><span class="linenos">348</span></a>
|
||||
</span><span id="L-349"><a href="#L-349"><span class="linenos">349</span></a> <span class="n">processed</span> <span class="p">:</span> <span class="nb">bool</span>
|
||||
</span><span id="L-350"><a href="#L-350"><span class="linenos">350</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="L-351"><a href="#L-351"><span class="linenos">351</span></a><span class="sd"> Did the management process the message, i.e., did the tasks necessary for this message (mostly only relevant for received messages).</span>
|
||||
</span><span id="L-352"><a href="#L-352"><span class="linenos">352</span></a><span class="sd"> """</span>
|
||||
</span></pre></div>
|
||||
|
||||
|
||||
@ -752,7 +854,7 @@ about a riddle.</p>
|
||||
</div>
|
||||
<div id="RiddleData.file_plain" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">file_plain</span><span class="annotation">: Annotated[str, AfterValidator(func=<function _check_data_file at 0x104208f40>)]</span>
|
||||
<span class="name">file_plain</span><span class="annotation">: Annotated[str, AfterValidator(func=<function _check_data_file at 0x10428cf40>)]</span>
|
||||
|
||||
|
||||
</div>
|
||||
@ -768,7 +870,7 @@ The file must exist.</p>
|
||||
</div>
|
||||
<div id="RiddleData.file_extracted" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">file_extracted</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=<function _check_data_file at 0x104208f40>)]]</span>
|
||||
<span class="name">file_extracted</span><span class="annotation">: Optional[Annotated[str, AfterValidator(func=<function _check_data_file at 0x10428cf40>)]]</span>
|
||||
|
||||
|
||||
</div>
|
||||
@ -1510,6 +1612,300 @@ Each <em>sub</em> riddle will then get its own id (i.e., <code>ex1-sub1</code>)
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section id="AgentResponse">
|
||||
<input id="AgentResponse-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
|
||||
<div class="attr class">
|
||||
|
||||
<span class="def">class</span>
|
||||
<span class="name">AgentResponse</span><wbr>(<span class="base"><a href="#RiddleInformation">RiddleInformation</a></span>):
|
||||
|
||||
<label class="view-source-button" for="AgentResponse-view-source"><span>View Source</span></label>
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#AgentResponse"></a>
|
||||
<div class="pdoc-code codehilite"><pre><span></span><span id="AgentResponse-295"><a href="#AgentResponse-295"><span class="linenos">295</span></a><span class="k">class</span> <span class="nc">AgentResponse</span><span class="p">(</span><span class="n">RiddleInformation</span><span class="p">):</span>
|
||||
</span><span id="AgentResponse-296"><a href="#AgentResponse-296"><span class="linenos">296</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="AgentResponse-297"><a href="#AgentResponse-297"><span class="linenos">297</span></a><span class="sd"> Returned by the management when receiving an `AgentMessage`.</span>
|
||||
</span><span id="AgentResponse-298"><a href="#AgentResponse-298"><span class="linenos">298</span></a><span class="sd"> """</span>
|
||||
</span><span id="AgentResponse-299"><a href="#AgentResponse-299"><span class="linenos">299</span></a>
|
||||
</span><span id="AgentResponse-300"><a href="#AgentResponse-300"><span class="linenos">300</span></a> <span class="n">count</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="AgentResponse-301"><a href="#AgentResponse-301"><span class="linenos">301</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="AgentResponse-302"><a href="#AgentResponse-302"><span class="linenos">302</span></a><span class="sd"> The count of the message (overall numeric id).</span>
|
||||
</span><span id="AgentResponse-303"><a href="#AgentResponse-303"><span class="linenos">303</span></a><span class="sd"> """</span>
|
||||
</span><span id="AgentResponse-304"><a href="#AgentResponse-304"><span class="linenos">304</span></a>
|
||||
</span><span id="AgentResponse-305"><a href="#AgentResponse-305"><span class="linenos">305</span></a> <span class="n">msg</span><span class="p">:</span> <span class="nb">str</span><span class="o">|</span><span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="AgentResponse-306"><a href="#AgentResponse-306"><span class="linenos">306</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="AgentResponse-307"><a href="#AgentResponse-307"><span class="linenos">307</span></a><span class="sd"> An additional message.</span>
|
||||
</span><span id="AgentResponse-308"><a href="#AgentResponse-308"><span class="linenos">308</span></a><span class="sd"> """</span>
|
||||
</span><span id="AgentResponse-309"><a href="#AgentResponse-309"><span class="linenos">309</span></a>
|
||||
</span><span id="AgentResponse-310"><a href="#AgentResponse-310"><span class="linenos">310</span></a> <span class="n">error</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="AgentResponse-311"><a href="#AgentResponse-311"><span class="linenos">311</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="AgentResponse-312"><a href="#AgentResponse-312"><span class="linenos">312</span></a><span class="sd"> If an error occurred.</span>
|
||||
</span><span id="AgentResponse-313"><a href="#AgentResponse-313"><span class="linenos">313</span></a><span class="sd"> """</span>
|
||||
</span><span id="AgentResponse-314"><a href="#AgentResponse-314"><span class="linenos">314</span></a>
|
||||
</span><span id="AgentResponse-315"><a href="#AgentResponse-315"><span class="linenos">315</span></a> <span class="n">error_msg</span><span class="p">:</span> <span class="nb">str</span><span class="o">|</span><span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
</span><span id="AgentResponse-316"><a href="#AgentResponse-316"><span class="linenos">316</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="AgentResponse-317"><a href="#AgentResponse-317"><span class="linenos">317</span></a><span class="sd"> Error message (if `error` )</span>
|
||||
</span><span id="AgentResponse-318"><a href="#AgentResponse-318"><span class="linenos">318</span></a><span class="sd"> """</span>
|
||||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>Returned by the management when receiving an <code><a href="#AgentMessage">AgentMessage</a></code>.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="AgentResponse.count" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">count</span><span class="annotation">: int</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#AgentResponse.count"></a>
|
||||
|
||||
<div class="docstring"><p>The count of the message (overall numeric id).</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="AgentResponse.msg" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">msg</span><span class="annotation">: str | None</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#AgentResponse.msg"></a>
|
||||
|
||||
<div class="docstring"><p>An additional message.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="AgentResponse.error" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">error</span><span class="annotation">: bool</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#AgentResponse.error"></a>
|
||||
|
||||
<div class="docstring"><p>If an error occurred.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="AgentResponse.error_msg" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">error_msg</span><span class="annotation">: str | None</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#AgentResponse.error_msg"></a>
|
||||
|
||||
<div class="docstring"><p>Error message (if <code><a href="#AgentResponse.error">error</a></code> )</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="inherited">
|
||||
<h5>Inherited Members</h5>
|
||||
<dl>
|
||||
<div><dt>pydantic.main.BaseModel</dt>
|
||||
<dd id="AgentResponse.__init__" class="function">BaseModel</dd>
|
||||
<dd id="AgentResponse.model_extra" class="variable">model_extra</dd>
|
||||
<dd id="AgentResponse.model_fields_set" class="variable">model_fields_set</dd>
|
||||
<dd id="AgentResponse.model_construct" class="function">model_construct</dd>
|
||||
<dd id="AgentResponse.model_copy" class="function">model_copy</dd>
|
||||
<dd id="AgentResponse.model_dump" class="function">model_dump</dd>
|
||||
<dd id="AgentResponse.model_dump_json" class="function">model_dump_json</dd>
|
||||
<dd id="AgentResponse.model_json_schema" class="function">model_json_schema</dd>
|
||||
<dd id="AgentResponse.model_parametrized_name" class="function">model_parametrized_name</dd>
|
||||
<dd id="AgentResponse.model_post_init" class="function">model_post_init</dd>
|
||||
<dd id="AgentResponse.model_rebuild" class="function">model_rebuild</dd>
|
||||
<dd id="AgentResponse.model_validate" class="function">model_validate</dd>
|
||||
<dd id="AgentResponse.model_validate_json" class="function">model_validate_json</dd>
|
||||
<dd id="AgentResponse.model_validate_strings" class="function">model_validate_strings</dd>
|
||||
<dd id="AgentResponse.dict" class="function">dict</dd>
|
||||
<dd id="AgentResponse.json" class="function">json</dd>
|
||||
<dd id="AgentResponse.parse_obj" class="function">parse_obj</dd>
|
||||
<dd id="AgentResponse.parse_raw" class="function">parse_raw</dd>
|
||||
<dd id="AgentResponse.parse_file" class="function">parse_file</dd>
|
||||
<dd id="AgentResponse.from_orm" class="function">from_orm</dd>
|
||||
<dd id="AgentResponse.construct" class="function">construct</dd>
|
||||
<dd id="AgentResponse.copy" class="function">copy</dd>
|
||||
<dd id="AgentResponse.schema" class="function">schema</dd>
|
||||
<dd id="AgentResponse.schema_json" class="function">schema_json</dd>
|
||||
<dd id="AgentResponse.validate" class="function">validate</dd>
|
||||
<dd id="AgentResponse.update_forward_refs" class="function">update_forward_refs</dd>
|
||||
|
||||
</div>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section id="MessageDbRow">
|
||||
<input id="MessageDbRow-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
|
||||
<div class="attr class">
|
||||
|
||||
<span class="def">class</span>
|
||||
<span class="name">MessageDbRow</span><wbr>(<span class="base">pydantic.main.BaseModel</span>):
|
||||
|
||||
<label class="view-source-button" for="MessageDbRow-view-source"><span>View Source</span></label>
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow"></a>
|
||||
<div class="pdoc-code codehilite"><pre><span></span><span id="MessageDbRow-320"><a href="#MessageDbRow-320"><span class="linenos">320</span></a><span class="k">class</span> <span class="nc">MessageDbRow</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
||||
</span><span id="MessageDbRow-321"><a href="#MessageDbRow-321"><span class="linenos">321</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-322"><a href="#MessageDbRow-322"><span class="linenos">322</span></a><span class="sd"> Object representing a database row.</span>
|
||||
</span><span id="MessageDbRow-323"><a href="#MessageDbRow-323"><span class="linenos">323</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-324"><a href="#MessageDbRow-324"><span class="linenos">324</span></a>
|
||||
</span><span id="MessageDbRow-325"><a href="#MessageDbRow-325"><span class="linenos">325</span></a> <span class="n">count</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="MessageDbRow-326"><a href="#MessageDbRow-326"><span class="linenos">326</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-327"><a href="#MessageDbRow-327"><span class="linenos">327</span></a><span class="sd"> The count (primary key) of the item.</span>
|
||||
</span><span id="MessageDbRow-328"><a href="#MessageDbRow-328"><span class="linenos">328</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-329"><a href="#MessageDbRow-329"><span class="linenos">329</span></a>
|
||||
</span><span id="MessageDbRow-330"><a href="#MessageDbRow-330"><span class="linenos">330</span></a> <span class="n">sender</span> <span class="p">:</span> <span class="nb">str</span>
|
||||
</span><span id="MessageDbRow-331"><a href="#MessageDbRow-331"><span class="linenos">331</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-332"><a href="#MessageDbRow-332"><span class="linenos">332</span></a><span class="sd"> The sender of the message.</span>
|
||||
</span><span id="MessageDbRow-333"><a href="#MessageDbRow-333"><span class="linenos">333</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-334"><a href="#MessageDbRow-334"><span class="linenos">334</span></a>
|
||||
</span><span id="MessageDbRow-335"><a href="#MessageDbRow-335"><span class="linenos">335</span></a> <span class="n">recipient</span> <span class="p">:</span> <span class="nb">str</span>
|
||||
</span><span id="MessageDbRow-336"><a href="#MessageDbRow-336"><span class="linenos">336</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-337"><a href="#MessageDbRow-337"><span class="linenos">337</span></a><span class="sd"> The recipient of the message</span>
|
||||
</span><span id="MessageDbRow-338"><a href="#MessageDbRow-338"><span class="linenos">338</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-339"><a href="#MessageDbRow-339"><span class="linenos">339</span></a>
|
||||
</span><span id="MessageDbRow-340"><a href="#MessageDbRow-340"><span class="linenos">340</span></a> <span class="n">time</span> <span class="p">:</span> <span class="nb">int</span>
|
||||
</span><span id="MessageDbRow-341"><a href="#MessageDbRow-341"><span class="linenos">341</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-342"><a href="#MessageDbRow-342"><span class="linenos">342</span></a><span class="sd"> The time (unix timestamp) the message was received/ sent.</span>
|
||||
</span><span id="MessageDbRow-343"><a href="#MessageDbRow-343"><span class="linenos">343</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-344"><a href="#MessageDbRow-344"><span class="linenos">344</span></a>
|
||||
</span><span id="MessageDbRow-345"><a href="#MessageDbRow-345"><span class="linenos">345</span></a> <span class="n">message</span> <span class="p">:</span> <span class="n">AgentMessage</span>
|
||||
</span><span id="MessageDbRow-346"><a href="#MessageDbRow-346"><span class="linenos">346</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-347"><a href="#MessageDbRow-347"><span class="linenos">347</span></a><span class="sd"> The message received/ sent.</span>
|
||||
</span><span id="MessageDbRow-348"><a href="#MessageDbRow-348"><span class="linenos">348</span></a><span class="sd"> """</span>
|
||||
</span><span id="MessageDbRow-349"><a href="#MessageDbRow-349"><span class="linenos">349</span></a>
|
||||
</span><span id="MessageDbRow-350"><a href="#MessageDbRow-350"><span class="linenos">350</span></a> <span class="n">processed</span> <span class="p">:</span> <span class="nb">bool</span>
|
||||
</span><span id="MessageDbRow-351"><a href="#MessageDbRow-351"><span class="linenos">351</span></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="MessageDbRow-352"><a href="#MessageDbRow-352"><span class="linenos">352</span></a><span class="sd"> Did the management process the message, i.e., did the tasks necessary for this message (mostly only relevant for received messages).</span>
|
||||
</span><span id="MessageDbRow-353"><a href="#MessageDbRow-353"><span class="linenos">353</span></a><span class="sd"> """</span>
|
||||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>Object representing a database row.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div id="MessageDbRow.count" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">count</span><span class="annotation">: int</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.count"></a>
|
||||
|
||||
<div class="docstring"><p>The count (primary key) of the item.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="MessageDbRow.sender" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">sender</span><span class="annotation">: str</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.sender"></a>
|
||||
|
||||
<div class="docstring"><p>The sender of the message.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="MessageDbRow.recipient" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">recipient</span><span class="annotation">: str</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.recipient"></a>
|
||||
|
||||
<div class="docstring"><p>The recipient of the message</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="MessageDbRow.time" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">time</span><span class="annotation">: int</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.time"></a>
|
||||
|
||||
<div class="docstring"><p>The time (unix timestamp) the message was received/ sent.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="MessageDbRow.message" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">message</span><span class="annotation">: <a href="#AgentMessage">AgentMessage</a></span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.message"></a>
|
||||
|
||||
<div class="docstring"><p>The message received/ sent.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="MessageDbRow.processed" class="classattr">
|
||||
<div class="attr variable">
|
||||
<span class="name">processed</span><span class="annotation">: bool</span>
|
||||
|
||||
|
||||
</div>
|
||||
<a class="headerlink" href="#MessageDbRow.processed"></a>
|
||||
|
||||
<div class="docstring"><p>Did the management process the message, i.e., did the tasks necessary for this message (mostly only relevant for received messages).</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="inherited">
|
||||
<h5>Inherited Members</h5>
|
||||
<dl>
|
||||
<div><dt>pydantic.main.BaseModel</dt>
|
||||
<dd id="MessageDbRow.__init__" class="function">BaseModel</dd>
|
||||
<dd id="MessageDbRow.model_extra" class="variable">model_extra</dd>
|
||||
<dd id="MessageDbRow.model_fields_set" class="variable">model_fields_set</dd>
|
||||
<dd id="MessageDbRow.model_construct" class="function">model_construct</dd>
|
||||
<dd id="MessageDbRow.model_copy" class="function">model_copy</dd>
|
||||
<dd id="MessageDbRow.model_dump" class="function">model_dump</dd>
|
||||
<dd id="MessageDbRow.model_dump_json" class="function">model_dump_json</dd>
|
||||
<dd id="MessageDbRow.model_json_schema" class="function">model_json_schema</dd>
|
||||
<dd id="MessageDbRow.model_parametrized_name" class="function">model_parametrized_name</dd>
|
||||
<dd id="MessageDbRow.model_post_init" class="function">model_post_init</dd>
|
||||
<dd id="MessageDbRow.model_rebuild" class="function">model_rebuild</dd>
|
||||
<dd id="MessageDbRow.model_validate" class="function">model_validate</dd>
|
||||
<dd id="MessageDbRow.model_validate_json" class="function">model_validate_json</dd>
|
||||
<dd id="MessageDbRow.model_validate_strings" class="function">model_validate_strings</dd>
|
||||
<dd id="MessageDbRow.dict" class="function">dict</dd>
|
||||
<dd id="MessageDbRow.json" class="function">json</dd>
|
||||
<dd id="MessageDbRow.parse_obj" class="function">parse_obj</dd>
|
||||
<dd id="MessageDbRow.parse_raw" class="function">parse_raw</dd>
|
||||
<dd id="MessageDbRow.parse_file" class="function">parse_file</dd>
|
||||
<dd id="MessageDbRow.from_orm" class="function">from_orm</dd>
|
||||
<dd id="MessageDbRow.construct" class="function">construct</dd>
|
||||
<dd id="MessageDbRow.copy" class="function">copy</dd>
|
||||
<dd id="MessageDbRow.schema" class="function">schema</dd>
|
||||
<dd id="MessageDbRow.schema_json" class="function">schema_json</dd>
|
||||
<dd id="MessageDbRow.validate" class="function">validate</dd>
|
||||
<dd id="MessageDbRow.update_forward_refs" class="function">update_forward_refs</dd>
|
||||
|
||||
</div>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
<script>
|
||||
function escapeHTML(html) {
|
||||
|
Reference in New Issue
Block a user