deploy: 6dbe3e2

Author: ianardee

client.html

@@ -1356,8 +1356,74 @@ <h2 id="E">E</h2>
       </ul></li>
       <li><a href="misc/geometry.html#mindee.geometry.Polygon.extend">extend() (Polygon method)</a>
 </li>
-      <li><a href="parsing/common.html#mindee.parsing.common.document.Document.extras">extras (Document attribute)</a>
+      <li><a href="product/fr/bank_account_details_v1.html#mindee.product.fr.bank_account_details.bank_account_details_v1.BankAccountDetailsV1.extras">extras (BankAccountDetailsV1 attribute)</a>
+
+      <ul>
+        <li><a href="product/fr/bank_account_details_v2.html#mindee.product.fr.bank_account_details.bank_account_details_v2.BankAccountDetailsV2.extras">(BankAccountDetailsV2 attribute)</a>
+</li>
+        <li><a href="product/us/bank_check_v1.html#mindee.product.us.bank_check.bank_check_v1.BankCheckV1.extras">(BankCheckV1 attribute)</a>
+</li>
+        <li><a href="product/barcode_reader_v1.html#mindee.product.barcode_reader.barcode_reader_v1.BarcodeReaderV1.extras">(BarcodeReaderV1 attribute)</a>
+</li>
+        <li><a href="product/bill_of_lading_v1.html#mindee.product.bill_of_lading.bill_of_lading_v1.BillOfLadingV1.extras">(BillOfLadingV1 attribute)</a>
+</li>
+        <li><a href="product/business_card_v1.html#mindee.product.business_card.business_card_v1.BusinessCardV1.extras">(BusinessCardV1 attribute)</a>
+</li>
+        <li><a href="product/fr/carte_grise_v1.html#mindee.product.fr.carte_grise.carte_grise_v1.CarteGriseV1.extras">(CarteGriseV1 attribute)</a>
+</li>
+        <li><a href="product/cropper_v1.html#mindee.product.cropper.cropper_v1.CropperV1.extras">(CropperV1 attribute)</a>
+</li>
+        <li><a href="product/custom_v1.html#mindee.product.custom.custom_v1.CustomV1.extras">(CustomV1 attribute)</a>
+</li>
+        <li><a href="product/delivery_note_v1.html#mindee.product.delivery_note.delivery_note_v1.DeliveryNoteV1.extras">(DeliveryNoteV1 attribute)</a>
+</li>
+        <li><a href="parsing/common.html#mindee.parsing.common.document.Document.extras">(Document attribute)</a>
+</li>
+        <li><a href="product/driver_license_v1.html#mindee.product.driver_license.driver_license_v1.DriverLicenseV1.extras">(DriverLicenseV1 attribute)</a>
+</li>
+        <li><a href="product/fr/energy_bill_v1.html#mindee.product.fr.energy_bill.energy_bill_v1.EnergyBillV1.extras">(EnergyBillV1 attribute)</a>
+</li>
+        <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1.FinancialDocumentV1.extras">(FinancialDocumentV1 attribute)</a>
+</li>
+        <li><a href="product/generated_v1.html#mindee.product.generated.generated_v1.GeneratedV1.extras">(GeneratedV1 attribute)</a>
+</li>
+        <li><a href="product/fr/health_card_v1.html#mindee.product.fr.health_card.health_card_v1.HealthCardV1.extras">(HealthCardV1 attribute)</a>
+</li>
+        <li><a href="product/us/healthcare_card_v1.html#mindee.product.us.healthcare_card.healthcare_card_v1.HealthcareCardV1.extras">(HealthcareCardV1 attribute)</a>
 </li>
+        <li><a href="product/fr/id_card_v1.html#mindee.product.fr.id_card.id_card_v1.IdCardV1.extras">(IdCardV1 attribute)</a>
+</li>
+        <li><a href="product/fr/id_card_v2.html#mindee.product.fr.id_card.id_card_v2.IdCardV2.extras">(IdCardV2 attribute)</a>
+</li>
+        <li><a href="product/ind/indian_passport_v1.html#mindee.product.ind.indian_passport.indian_passport_v1.IndianPassportV1.extras">(IndianPassportV1 attribute)</a>
+</li>
+        <li><a href="product/international_id_v2.html#mindee.product.international_id.international_id_v2.InternationalIdV2.extras">(InternationalIdV2 attribute)</a>
+</li>
+        <li><a href="product/invoice_splitter_v1.html#mindee.product.invoice_splitter.invoice_splitter_v1.InvoiceSplitterV1.extras">(InvoiceSplitterV1 attribute)</a>
+</li>
+        <li><a href="product/invoice_v4.html#mindee.product.invoice.invoice_v4.InvoiceV4.extras">(InvoiceV4 attribute)</a>
+</li>
+        <li><a href="product/material_certificate_v1.html#mindee.product.material_certificate.material_certificate_v1.MaterialCertificateV1.extras">(MaterialCertificateV1 attribute)</a>
+</li>
+        <li><a href="product/multi_receipts_detector_v1.html#mindee.product.multi_receipts_detector.multi_receipts_detector_v1.MultiReceiptsDetectorV1.extras">(MultiReceiptsDetectorV1 attribute)</a>
+</li>
+        <li><a href="product/nutrition_facts_label_v1.html#mindee.product.nutrition_facts_label.nutrition_facts_label_v1.NutritionFactsLabelV1.extras">(NutritionFactsLabelV1 attribute)</a>
+</li>
+        <li><a href="product/passport_v1.html#mindee.product.passport.passport_v1.PassportV1.extras">(PassportV1 attribute)</a>
+</li>
+        <li><a href="product/fr/payslip_v2.html#mindee.product.fr.payslip.payslip_v2.PayslipV2.extras">(PayslipV2 attribute)</a>
+</li>
+        <li><a href="product/fr/payslip_v3.html#mindee.product.fr.payslip.payslip_v3.PayslipV3.extras">(PayslipV3 attribute)</a>
+</li>
+        <li><a href="product/receipt_v5.html#mindee.product.receipt.receipt_v5.ReceiptV5.extras">(ReceiptV5 attribute)</a>
+</li>
+        <li><a href="product/resume_v1.html#mindee.product.resume.resume_v1.ResumeV1.extras">(ResumeV1 attribute)</a>
+</li>
+        <li><a href="product/us/us_mail_v2.html#mindee.product.us.us_mail.us_mail_v2.UsMailV2.extras">(UsMailV2 attribute)</a>
+</li>
+        <li><a href="product/us/us_mail_v3.html#mindee.product.us.us_mail.us_mail_v3.UsMailV3.extras">(UsMailV3 attribute)</a>
+</li>
+      </ul></li>
   </ul></td>
 </tr></table>
 

genindex.html

@@ -341,7 +341,7 @@ <h1>Mindee HTTP<a class="headerlink" href="#mindee-http" title="Permalink to thi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="mindee.mindee_http.Endpoint.predict_async_req_post">
-<span class="sig-name descname"><span class="pre">predict_async_req_post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_words</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">close_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cropper</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mindee.mindee_http.Endpoint.predict_async_req_post" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">predict_async_req_post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_words</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">close_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cropper</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workflow_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mindee.mindee_http.Endpoint.predict_async_req_post" title="Permalink to this definition"></a></dt>
 <dd><p>Make an asynchronous request to POST a document for prediction.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -351,6 +351,8 @@ <h1>Mindee HTTP<a class="headerlink" href="#mindee-http" title="Permalink to thi
 <li><p><strong>close_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, default: <code class="docutils literal notranslate"><span class="pre">True</span></code>) – Whether to <cite>close()</cite> the file after parsing it.</p></li>
 <li><p><strong>cropper</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) – Including Mindee cropping results.</p></li>
 <li><p><strong>full_text</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) – Whether to include the full OCR text response in compatible APIs.</p></li>
+<li><p><strong>workflow_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], default: <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Workflow ID.</p></li>
+<li><p><strong>rag</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>, default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) – If set, will enable Retrieval-Augmented Generation.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>

misc/mindee_http.html

@@ -136,7 +136,7 @@ <h3>Document<a class="headerlink" href="#document" title="Permalink to this head
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.parsing.common.document.Document.extras">
-<span class="sig-name descname"><span class="pre">extras</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">Extras</span></code><span class="pre">]</span></em><a class="headerlink" href="#mindee.parsing.common.document.Document.extras" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">extras</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">Extras</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindee.parsing.common.document.Document.extras" title="Permalink to this definition"></a></dt>
 <dd><p>Potential Extras fields sent back along the prediction</p>
 </dd></dl>
 
@@ -166,7 +166,7 @@ <h3>Document<a class="headerlink" href="#document" title="Permalink to this head
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.parsing.common.document.Document.ocr">
-<span class="sig-name descname"><span class="pre">ocr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><a class="reference internal" href="#mindee.parsing.common.ocr.ocr.Ocr" title="mindee.parsing.common.ocr.ocr.Ocr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ocr</span></code></a><span class="pre">]</span></em><a class="headerlink" href="#mindee.parsing.common.document.Document.ocr" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">ocr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><a class="reference internal" href="#mindee.parsing.common.ocr.ocr.Ocr" title="mindee.parsing.common.ocr.ocr.Ocr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ocr</span></code></a><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindee.parsing.common.document.Document.ocr" title="Permalink to this definition"></a></dt>
 <dd><p>Potential raw text results read by the OCR (limited feature)</p>
 </dd></dl>
 
@@ -195,7 +195,7 @@ <h3>Page<a class="headerlink" href="#page" title="Permalink to this heading">
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.parsing.common.page.Page.orientation">
-<span class="sig-name descname"><span class="pre">orientation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><a class="reference internal" href="#mindee.parsing.common.orientation.OrientationField" title="mindee.parsing.common.orientation.OrientationField"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrientationField</span></code></a><span class="pre">]</span></em><a class="headerlink" href="#mindee.parsing.common.page.Page.orientation" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">orientation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><a class="reference internal" href="#mindee.parsing.common.orientation.OrientationField" title="mindee.parsing.common.orientation.OrientationField"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrientationField</span></code></a><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindee.parsing.common.page.Page.orientation" title="Permalink to this definition"></a></dt>
 <dd><p>Orientation of the page</p>
 </dd></dl>
 
@@ -344,13 +344,13 @@ <h3>Job<a class="headerlink" href="#job" title="Permalink to this heading"></
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.parsing.common.job.Job.available_at">
-<span class="sig-name descname"><span class="pre">available_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code><span class="pre">]</span></em><a class="headerlink" href="#mindee.parsing.common.job.Job.available_at" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">available_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindee.parsing.common.job.Job.available_at" title="Permalink to this definition"></a></dt>
 <dd><p>Timestamp of the request after it has been completed.</p>
 </dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.parsing.common.job.Job.error">
-<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code><span class="pre">]]</span></em><a class="headerlink" href="#mindee.parsing.common.job.Job.error" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code><span class="pre">]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mindee.parsing.common.job.Job.error" title="Permalink to this definition"></a></dt>
 <dd><p>Information about an error that occurred during the job processing.</p>
 </dd></dl>