Deploying to gh-pages from @ 7569d7c 🚀

dev/classformatron_1_1formats_1_1json_1_1JsonExtractor.html

@@ -180,7 +180,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>An extractor that loads json data to an object from a string. </p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00282">282</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00305">305</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a7a51edd3cc7c24370c809d91e07771dc" name="a7a51edd3cc7c24370c809d91e07771dc"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91e07771dc">&#9670;&#160;</a></span>__init__()</h2>
@@ -220,11 +220,19 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91
 <pre class="fragment">   Currently, the following data types are supported:
 </pre> <div class="fragment"><div class="line">- bool</div>
 <div class="line">- int</div>
-<div class="line">- float</div>
-<div class="line">- str</div>
 </div><!-- fragment --><ul>
-<li>with min_length, max_length and pattern constraints<ul>
-<li>length is measured in UTF-8 character number</li>
+<li>positive int</li>
+<li>negative int</li>
+<li>nonnegative int</li>
+<li>nonpositive int <div class="fragment"><div class="line">- float</div>
+</div><!-- fragment --></li>
+<li>positive float</li>
+<li>negative float</li>
+<li>nonnegative float</li>
+<li>nonpositive float <div class="fragment"><div class="line">- str</div>
+</div><!-- fragment --></li>
+<li>optionally with min_length, max_length and pattern constraints<ul>
+<li>length is measured in UTF-8 character number after json parsing</li>
 <li><em>Warning</em>: too large difference between min_length and max_length can lead to enormous memory consumption!</li>
 <li>pattern is mutually exclusive with min_length and max_length</li>
 <li>pattern will be compiled to a regular expression so all caveats of regular expressions apply</li>
@@ -256,7 +264,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a51edd3cc7c24370c809d91
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1NonterminalExtractor.html#a45c14f79c14b539837ebdd26c3b5567b">formatron.extractor.NonterminalExtractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00319">319</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00354">354</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -291,7 +299,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ad701c17988fe32b164135e
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1Extractor.html#a9efb2a75cf5fc5e0919c235aa1435469">formatron.extractor.Extractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00333">333</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00368">368</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -312,7 +320,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ace660f78408893ab8fb7facd
 
 <p>Reimplemented from <a class="el" href="classformatron_1_1extractor_1_1Extractor.html#ae9abcfb6c5bae5b352de8a97f94be049">formatron.extractor.Extractor</a>.</p>
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00387">387</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00422">422</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -337,7 +345,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aecf88428e414da080f11ed0a
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00323">323</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00358">358</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>
@@ -361,7 +369,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2e72d806c8dffc0136231b81
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00322">322</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
+<p class="definition">Definition at line <a class="el" href="json_8py_source.html#l00357">357</a> of file <a class="el" href="json_8py_source.html">json.py</a>.</p>
 
 </div>
 </div>

dev/doxygen_crawl.html

@@ -416,6 +416,7 @@
 <a href="json__schema_8py.html#aaba012c79d101be93f4d96588c9f8cc2"/>
 <a href="json__schema_8py.html#ab2aeae10eb93ef3a3ca1c50013c6b380"/>
 <a href="json__schema_8py.html#ac742e1e581efccb6cc9742e7a23c25c2"/>
+<a href="json__schema_8py.html#ad187a02f7616ccbb83c00462996a7fe1"/>
 <a href="json__schema_8py.html#af20251afc012b955e29c92922fcc83ef"/>
 <a href="namespaceformatron.html"/>
 <a href="namespaceformatron_1_1config.html"/>
@@ -471,6 +472,7 @@
 <a href="namespaceformatron_1_1schemas_1_1json__schema.html#aaba012c79d101be93f4d96588c9f8cc2"/>
 <a href="namespaceformatron_1_1schemas_1_1json__schema.html#ab2aeae10eb93ef3a3ca1c50013c6b380"/>
 <a href="namespaceformatron_1_1schemas_1_1json__schema.html#ac742e1e581efccb6cc9742e7a23c25c2"/>
+<a href="namespaceformatron_1_1schemas_1_1json__schema.html#ad187a02f7616ccbb83c00462996a7fe1"/>
 <a href="namespaceformatron_1_1schemas_1_1json__schema.html#af20251afc012b955e29c92922fcc83ef"/>
 <a href="namespaceformatron_1_1schemas_1_1pydantic.html"/>
 <a href="namespaceformatron_1_1schemas_1_1pydantic.html#a0b1aeb9a63626b0e782bc4b9e1ce18cf"/>

dev/formatter_8py_source.html

@@ -677,7 +677,7 @@
 <div class="ttc" id="aclassformatron_1_1extractor_1_1ChoiceExtractor_html"><div class="ttname"><a href="classformatron_1_1extractor_1_1ChoiceExtractor.html">formatron.extractor.ChoiceExtractor</a></div><div class="ttdoc">An extractor that uses multiple extractors to extract data.</div><div class="ttdef"><b>Definition</b> <a href="extractor_8py_source.html#l00194">extractor.py:194</a></div></div>
 <div class="ttc" id="aclassformatron_1_1extractor_1_1LiteralExtractor_html"><div class="ttname"><a href="classformatron_1_1extractor_1_1LiteralExtractor.html">formatron.extractor.LiteralExtractor</a></div><div class="ttdoc">An extractor that extracts a literal string.</div><div class="ttdef"><b>Definition</b> <a href="extractor_8py_source.html#l00143">extractor.py:143</a></div></div>
 <div class="ttc" id="aclassformatron_1_1extractor_1_1SubstringExtractor_html"><div class="ttname"><a href="classformatron_1_1extractor_1_1SubstringExtractor.html">formatron.extractor.SubstringExtractor</a></div><div class="ttdoc">An extractor that extracts a substring of a given string from the input string.</div><div class="ttdef"><b>Definition</b> <a href="extractor_8py_source.html#l00240">extractor.py:240</a></div></div>
-<div class="ttc" id="aclassformatron_1_1formats_1_1json_1_1JsonExtractor_html"><div class="ttname"><a href="classformatron_1_1formats_1_1json_1_1JsonExtractor.html">formatron.formats.json.JsonExtractor</a></div><div class="ttdoc">An extractor that loads json data to an object from a string.</div><div class="ttdef"><b>Definition</b> <a href="json_8py_source.html#l00282">json.py:282</a></div></div>
+<div class="ttc" id="aclassformatron_1_1formats_1_1json_1_1JsonExtractor_html"><div class="ttname"><a href="classformatron_1_1formats_1_1json_1_1JsonExtractor.html">formatron.formats.json.JsonExtractor</a></div><div class="ttdoc">An extractor that loads json data to an object from a string.</div><div class="ttdef"><b>Definition</b> <a href="json_8py_source.html#l00305">json.py:305</a></div></div>
 <div class="ttc" id="aclassformatron_1_1formats_1_1regex_1_1RegexExtractor_html"><div class="ttname"><a href="classformatron_1_1formats_1_1regex_1_1RegexExtractor.html">formatron.formats.regex.RegexExtractor</a></div><div class="ttdoc">An extractor that extracts a string using a regular expression.</div><div class="ttdef"><b>Definition</b> <a href="regex_8py_source.html#l00013">regex.py:13</a></div></div>
 <div class="ttc" id="aclassformatron_1_1formatter_1_1FormatterBase_html"><div class="ttname"><a href="classformatron_1_1formatter_1_1FormatterBase.html">formatron.formatter.FormatterBase</a></div><div class="ttdoc">An abstract Formatter that enforces a format on the string generated by a language model.</div><div class="ttdef"><b>Definition</b> <a href="#l00024">formatter.py:24</a></div></div>
 <div class="ttc" id="aclassformatron_1_1formatter_1_1FormatterBase_html_a469880a21192928e82823cc340a22ce2"><div class="ttname"><a href="classformatron_1_1formatter_1_1FormatterBase.html#a469880a21192928e82823cc340a22ce2">formatron.formatter.FormatterBase._on_completion</a></div><div class="ttdeci">None _on_completion(self, str generated_output)</div><div class="ttdoc">Perform actions when the generation is completed.</div><div class="ttdef"><b>Definition</b> <a href="#l00080">formatter.py:80</a></div></div>