deploy: da49749

Author: ianardee

code_samples/default_v2.txt

@@ -1,10 +1,4 @@
-#
-# Install the Python client library by running:
-# pip install mindee
-#
-
-from mindee import ClientV2, InferencePredictOptions
-from mindee.parsing.v2 import InferenceResponse, PollingResponse
+from mindee import ClientV2, InferenceParameters
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
@@ -13,12 +7,21 @@ model_id = "MY_MODEL_ID"
 # Init a new client
 mindee_client = ClientV2(api_key)
 
+# Set inference paramters
+params = InferenceParameters(
+    # ID of the model, required.
+    model_id=model_id,
+    # If set to `True`, will enable Retrieval-Augmented Generation.
+    rag=False,
+)
+
 # Load a file from disk
-input_doc = mindee_client.source_from_path(input_path)
-options = InferencePredictOptions(model_id=model_id)
+input_source = mindee_client.source_from_path(input_path)
 
-# Parse the file.
-response: InferenceResponse = mindee_client.enqueue_and_parse(input_doc, options)
+# Upload the file
+response = mindee_client.enqueue_and_get_inference(
+    input_source, params
+)
 
 # Print a brief summary of the parsed data
 print(response.inference)

genindex.html

@@ -182,12 +182,8 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="product/ind/indian_passport_v1.html#mindee.product.ind.indian_passport.indian_passport_v1_document.IndianPassportV1Document.address3">address3 (IndianPassportV1Document attribute)</a>
 </li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.alias">alias (InferencePredictOptions attribute)</a>
-
-      <ul>
-        <li><a href="misc/input.html#mindee.input.WorkflowOptions.alias">(WorkflowOptions attribute)</a>
+      <li><a href="misc/input.html#mindee.input.WorkflowOptions.alias">alias (WorkflowOptions attribute)</a>
 </li>
-      </ul></li>
       <li><a href="parsing/common.html#mindee.parsing.common.ocr.ocr_page.OcrPage.all_lines">all_lines (OcrPage property)</a>
 </li>
       <li><a href="parsing/common.html#mindee.parsing.common.ocr.ocr_page.OcrPage.all_words">all_words (OcrPage property)</a>
@@ -198,8 +194,6 @@ <h2 id="A">A</h2>
         <li><a href="product/fr/id_card_v2.html#mindee.product.fr.id_card.id_card_v2_page.IdCardV2Page.alternate_name">(IdCardV2Page attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="product/us/bank_check_v1.html#mindee.product.us.bank_check.bank_check_v1_document.BankCheckV1Document.amount">amount (BankCheckV1Document attribute)</a>
 
       <ul>
@@ -212,6 +206,8 @@ <h2 id="A">A</h2>
         <li><a href="product/fr/payslip_v3.html#mindee.product.fr.payslip.payslip_v3_salary_detail.PayslipV3SalaryDetail.amount">(PayslipV3SalaryDetail attribute)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="parsing/standard.html#mindee.parsing.standard.amount.AmountField">AmountField (class in mindee.parsing.standard.amount)</a>
 </li>
       <li><a href="misc/mindee_http.html#mindee.mindee_http.CustomEndpoint.annotations_req_del">annotations_req_del() (CustomEndpoint method)</a>
@@ -251,6 +247,8 @@ <h2 id="A">A</h2>
       <li><a href="parsing/common.html#mindee.parsing.common.api_response.ApiResponse">ApiResponse (class in mindee.parsing.common.api_response)</a>
 </li>
       <li><a href="misc/geometry.html#mindee.geometry.Polygon.append">append() (Polygon method)</a>
+</li>
+      <li><a href="misc/input.html#mindee.input.LocalInputSource.apply_page_options">apply_page_options() (LocalInputSource method)</a>
 </li>
       <li><a href="misc/geometry.html#mindee.geometry.BBox.area">area (BBox property)</a>
 </li>
@@ -655,8 +653,6 @@ <h2 id="C">C</h2>
       <li><a href="client.html#mindee.client.Client">Client (class in mindee.client)</a>
 </li>
       <li><a href="misc/input.html#mindee.input.LocalInputSource.close">close() (LocalInputSource method)</a>
-</li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.close_file">close_file (InferencePredictOptions attribute)</a>
 </li>
       <li><a href="parsing/standard.html#mindee.parsing.standard.tax.TaxField.code">code (TaxField attribute)</a>
 </li>
@@ -1510,12 +1506,8 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="product/fr/carte_grise_v1.html#mindee.product.fr.carte_grise.carte_grise_v1_document.CarteGriseV1Document.formula_number">formula_number (CarteGriseV1Document attribute)</a>
 </li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.full_text">full_text (InferencePredictOptions attribute)</a>
-
-      <ul>
-        <li><a href="misc/input.html#mindee.input.WorkflowOptions.full_text">(WorkflowOptions attribute)</a>
+      <li><a href="misc/input.html#mindee.input.WorkflowOptions.full_text">full_text (WorkflowOptions attribute)</a>
 </li>
-      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -1797,8 +1789,6 @@ <h2 id="I">I</h2>
       <li><a href="product/ind/indian_passport_v1.html#mindee.product.ind.indian_passport.indian_passport_v1_document.IndianPassportV1Document">IndianPassportV1Document (class in mindee.product.ind.indian_passport.indian_passport_v1_document)</a>
 </li>
       <li><a href="parsing/common.html#mindee.parsing.common.document.Document.inference">inference (Document attribute)</a>
-</li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions">InferencePredictOptions (class in mindee.input)</a>
 </li>
       <li><a href="misc/input.html#mindee.input.PollingOptions.initial_delay_sec">initial_delay_sec (PollingOptions attribute)</a>
 </li>
@@ -1844,10 +1834,10 @@ <h2 id="I">I</h2>
       </ul></li>
       <li><a href="parsing/standard.html#mindee.parsing.standard.date.DateField.is_computed">is_computed (DateField attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="parsing/generated.html#mindee.parsing.generated.is_generated_object">is_generated_object() (in module mindee.parsing.generated)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="misc/input.html#mindee.input.LocalInputSource.is_pdf">is_pdf() (LocalInputSource method)</a>
 </li>
       <li><a href="misc/input.html#mindee.input.LocalInputSource.is_pdf_empty">is_pdf_empty() (LocalInputSource method)</a>
@@ -2147,8 +2137,6 @@ <h2 id="M">M</h2>
       <li><a href="misc/geometry.html#mindee.geometry.MinMax">MinMax (class in mindee.geometry)</a>
 </li>
       <li><a href="product/business_card_v1.html#mindee.product.business_card.business_card_v1_document.BusinessCardV1Document.mobile_number">mobile_number (BusinessCardV1Document attribute)</a>
-</li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.model_id">model_id (InferencePredictOptions attribute)</a>
 </li>
       <li>
     module
@@ -2600,8 +2588,6 @@ <h2 id="P">P</h2>
 </li>
       </ul></li>
       <li><a href="product/ind/indian_passport_v1.html#mindee.product.ind.indian_passport.indian_passport_v1_document.IndianPassportV1Document.page_number">page_number (IndianPassportV1Document attribute)</a>
-</li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.page_options">page_options (InferencePredictOptions attribute)</a>
 </li>
       <li><a href="misc/input.html#mindee.input.PageOptions">PageOptions (class in mindee.input)</a>
 </li>
@@ -2852,8 +2838,6 @@ <h2 id="P">P</h2>
 </li>
       </ul></li>
       <li><a href="misc/geometry.html#mindee.geometry.Point">Point (class in mindee.geometry)</a>
-</li>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.polling_options">polling_options (InferencePredictOptions attribute)</a>
 </li>
       <li><a href="misc/input.html#mindee.input.PollingOptions">PollingOptions (class in mindee.input)</a>
 </li>
@@ -3225,12 +3209,8 @@ <h2 id="Q">Q</h2>
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.rag">rag (InferencePredictOptions attribute)</a>
-
-      <ul>
-        <li><a href="misc/input.html#mindee.input.WorkflowOptions.rag">(WorkflowOptions attribute)</a>
+      <li><a href="misc/input.html#mindee.input.WorkflowOptions.rag">rag (WorkflowOptions attribute)</a>
 </li>
-      </ul></li>
       <li><a href="product/fr/payslip_v2.html#mindee.product.fr.payslip.payslip_v2_salary_detail.PayslipV2SalaryDetail.rate">rate (PayslipV2SalaryDetail attribute)</a>
 
       <ul>
@@ -3981,8 +3961,6 @@ <h2 id="V">V</h2>
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="misc/input.html#mindee.input.InferencePredictOptions.webhook_ids">webhook_ids (InferencePredictOptions attribute)</a>
-</li>
       <li><a href="product/business_card_v1.html#mindee.product.business_card.business_card_v1_document.BusinessCardV1Document.website">website (BusinessCardV1Document attribute)</a>
 </li>
       <li><a href="product/bill_of_lading_v1.html#mindee.product.bill_of_lading.bill_of_lading_v1_carrier_item.BillOfLadingV1CarrierItem.weight_unit">weight_unit (BillOfLadingV1CarrierItem attribute)</a>

guide/getting_started.md

@@ -219,7 +219,7 @@ custom_endpoint = mindee_client.create_endpoint(
     "my-account-name",
     # "my-version" # optional
 )
-result = mindee_client.enqueue_and_parse(product.GeneratedV1, input_doc, endpoint=custom_endpoint)
+result = mindee_client.enqueue_and_get_inference(product.GeneratedV1, input_doc, endpoint=custom_endpoint)
 ```
 
 This is because the `GeneratedV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.

misc/index.html

@@ -125,7 +125,6 @@ <h1>Misc<a class="headerlink" href="#misc" title="Permalink to this heading">
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.Base64Input"><code class="docutils literal notranslate"><span class="pre">Base64Input</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.BytesInput"><code class="docutils literal notranslate"><span class="pre">BytesInput</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.FileInput"><code class="docutils literal notranslate"><span class="pre">FileInput</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.InferencePredictOptions"><code class="docutils literal notranslate"><span class="pre">InferencePredictOptions</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.InputType"><code class="docutils literal notranslate"><span class="pre">InputType</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.LocalInputSource"><code class="docutils literal notranslate"><span class="pre">LocalInputSource</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.LocalResponse"><code class="docutils literal notranslate"><span class="pre">LocalResponse</span></code></a></li>