deploy: 8d2539a

mindee · May 21, 2024 · ac9b3fb · ac9b3fb
1 parent 13f748f
commit ac9b3fb
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 8 deletions.
diff --git a/genindex.html b/genindex.html
@@ -680,13 +680,15 @@ <h2 id="D">D</h2>
         <li><a href="product/eu/driver_license_v1.html#mindee.product.eu.driver_license.driver_license_v1_page.DriverLicenseV1Page.document_id">(DriverLicenseV1Page attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="product/resume_v1.html#mindee.product.resume.resume_v1_document.ResumeV1Document.document_language">document_language (ResumeV1Document attribute)</a>
 </li>
-      <li><a href="product/fr/id_card_v2.html#mindee.product.fr.id_card.id_card_v2_document.IdCardV2Document.document_number">document_number (IdCardV2Document attribute)</a>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.document_number">document_number (FinancialDocumentV1Document attribute)</a>
 
       <ul>
+        <li><a href="product/fr/id_card_v2.html#mindee.product.fr.id_card.id_card_v2_document.IdCardV2Document.document_number">(IdCardV2Document attribute)</a>
+</li>
         <li><a href="product/fr/id_card_v2.html#mindee.product.fr.id_card.id_card_v2_page.IdCardV2Page.document_number">(IdCardV2Page attribute)</a>
 </li>
         <li><a href="product/international_id_v1.html#mindee.product.international_id.international_id_v1_document.InternationalIdV1Document.document_number">(InternationalIdV1Document attribute)</a>
@@ -2177,6 +2179,12 @@ <h2 id="R">R</h2>
 </li>
       <li><a href="misc/input.html#mindee.input.LocalInputSource.read_contents">read_contents() (LocalInputSource method)</a>
 </li>
+      <li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.receipt_number">receipt_number (FinancialDocumentV1Document attribute)</a>
+
+      <ul>
+        <li><a href="product/receipt_v5.html#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.receipt_number">(ReceiptV5Document attribute)</a>
+</li>
+      </ul></li>
       <li><a href="product/multi_receipts_detector_v1.html#mindee.product.multi_receipts_detector.multi_receipts_detector_v1_document.MultiReceiptsDetectorV1Document.receipts">receipts (MultiReceiptsDetectorV1Document attribute)</a>
 </li>
       <li><a href="product/receipt_v4.html#mindee.product.receipt.receipt_v4.ReceiptV4">ReceiptV4 (class in mindee.product.receipt.receipt_v4)</a>

diff --git a/guide/expense_receipts_v5.md b/guide/expense_receipts_v5.md
@@ -220,6 +220,13 @@ for line_items_elem in result.document.inference.prediction.line_items:
 print(result.document.inference.prediction.locale.value)
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#stringfield)): The receipt number or identifier.
+
+```py
+print(result.document.inference.prediction.receipt_number.value)
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
 

diff --git a/guide/financial_document_v1.md b/guide/financial_document_v1.md
@@ -275,6 +275,13 @@ print(result.document.inference.prediction.customer_name.value)
 print(result.document.inference.prediction.date.value)
 ```
 
+## Document Number
+**document_number** ([StringField](#stringfield)): The document number or identifier.
+
+```py
+print(result.document.inference.prediction.document_number.value)
+```
+
 ## Document Type
 **document_type** ([ClassificationField](#classificationfield)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
@@ -290,7 +297,7 @@ print(result.document.inference.prediction.due_date.value)
 ```
 
 ## Invoice Number
-**invoice_number** ([StringField](#stringfield)): The invoice number or identifier.
+**invoice_number** ([StringField](#stringfield)): The invoice number or identifier only if document is an invoice.
 
 ```py
 print(result.document.inference.prediction.invoice_number.value)
@@ -311,6 +318,13 @@ for line_items_elem in result.document.inference.prediction.line_items:
 print(result.document.inference.prediction.locale.value)
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#stringfield)): The receipt number or identifier only if document is a receipt.
+
+```py
+print(result.document.inference.prediction.receipt_number.value)
+```
+
 ## Reference Numbers
 **reference_numbers** (List[[StringField](#stringfield)]): List of Reference numbers, including PO number.
 

diff --git a/objects.inv b/objects.inv
diff --git a/product/financial_document_v1.html b/product/financial_document_v1.html
@@ -191,7 +191,7 @@ <h1>Financial Document V1<a class="headerlink" href="#financial-document-v1" tit
 <dl class="py class">
 <dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FinancialDocumentV1Document</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_prediction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document" title="Permalink to this definition"></a></dt>
-<dd><p>Financial Document API version 1.6 document data.</p>
+<dd><p>Financial Document API version 1.7 document data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -242,6 +242,12 @@ <h1>Financial Document V1<a class="headerlink" href="#financial-document-v1" tit
 <dd><p>The date the purchase was made.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.document_number">
+<span class="sig-name descname"><span class="pre">document_number</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.text.StringField" title="mindee.parsing.standard.text.StringField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringField</span></code></a></em><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.document_number" title="Permalink to this definition"></a></dt>
+<dd><p>The document number or identifier.</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.document_type">
 <span class="sig-name descname"><span class="pre">document_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.classification.ClassificationField" title="mindee.parsing.standard.classification.ClassificationField"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClassificationField</span></code></a></em><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.document_type" title="Permalink to this definition"></a></dt>
@@ -257,7 +263,7 @@ <h1>Financial Document V1<a class="headerlink" href="#financial-document-v1" tit
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.invoice_number">
 <span class="sig-name descname"><span class="pre">invoice_number</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.text.StringField" title="mindee.parsing.standard.text.StringField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringField</span></code></a></em><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.invoice_number" title="Permalink to this definition"></a></dt>
-<dd><p>The invoice number or identifier.</p>
+<dd><p>The invoice number or identifier only if document is an invoice.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -272,6 +278,12 @@ <h1>Financial Document V1<a class="headerlink" href="#financial-document-v1" tit
 <dd><p>The locale detected on the document.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.receipt_number">
+<span class="sig-name descname"><span class="pre">receipt_number</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.text.StringField" title="mindee.parsing.standard.text.StringField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringField</span></code></a></em><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.receipt_number" title="Permalink to this definition"></a></dt>
+<dd><p>The receipt number or identifier only if document is a receipt.</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.reference_numbers">
 <span class="sig-name descname"><span class="pre">reference_numbers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code><span class="pre">[</span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.text.StringField" title="mindee.parsing.standard.text.StringField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringField</span></code></a><span class="pre">]</span></em><a class="headerlink" href="#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.reference_numbers" title="Permalink to this definition"></a></dt>

diff --git a/product/receipt_v5.html b/product/receipt_v5.html
@@ -191,7 +191,7 @@ <h1>Receipt V5<a class="headerlink" href="#receipt-v5" title="Permalink to this
 <dl class="py class">
 <dt class="sig sig-object py" id="mindee.product.receipt.receipt_v5_document.ReceiptV5Document">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ReceiptV5Document</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_prediction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mindee.product.receipt.receipt_v5_document.ReceiptV5Document" title="Permalink to this definition"></a></dt>
-<dd><p>Receipt API version 5.1 document data.</p>
+<dd><p>Receipt API version 5.2 document data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
@@ -230,6 +230,12 @@ <h1>Receipt V5<a class="headerlink" href="#receipt-v5" title="Permalink to this
 <dd><p>The locale detected on the document.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="mindee.product.receipt.receipt_v5_document.ReceiptV5Document.receipt_number">
+<span class="sig-name descname"><span class="pre">receipt_number</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.text.StringField" title="mindee.parsing.standard.text.StringField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StringField</span></code></a></em><a class="headerlink" href="#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.receipt_number" title="Permalink to this definition"></a></dt>
+<dd><p>The receipt number or identifier.</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="mindee.product.receipt.receipt_v5_document.ReceiptV5Document.subcategory">
 <span class="sig-name descname"><span class="pre">subcategory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../parsing/standard.html#mindee.parsing.standard.classification.ClassificationField" title="mindee.parsing.standard.classification.ClassificationField"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClassificationField</span></code></a></em><a class="headerlink" href="#mindee.product.receipt.receipt_v5_document.ReceiptV5Document.subcategory" title="Permalink to this definition"></a></dt>

diff --git a/searchindex.js b/searchindex.js