deploy: 0acd511

Author: ianardee

code_samples/v2_classification.txt

@@ -7,7 +7,7 @@ from mindee import (
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
-model_id = "MY_CLASSIFICATION_MODEL_ID"
+model_id = "MY_MODEL_ID"
 
 # Init a new client
 mindee_client = ClientV2(api_key)

code_samples/v2_crop.txt

@@ -7,7 +7,7 @@ from mindee import (
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
-model_id = "MY_CROP_MODEL_ID"
+model_id = "MY_MODEL_ID"
 
 # Init a new client
 mindee_client = ClientV2(api_key)

code_samples/v2_extraction.txt

@@ -42,3 +42,6 @@ response = mindee_client.enqueue_and_get_result(
 
 # Print a brief summary of the parsed data
 print(response.inference)
+
+# Access the result fields
+fields: dict = response.inference.result.fields

code_samples/v2_ocr.txt

@@ -7,7 +7,7 @@ from mindee import (
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
-model_id = "MY_OCR_MODEL_ID"
+model_id = "MY_MODEL_ID"
 
 # Init a new client
 mindee_client = ClientV2(api_key)
@@ -31,5 +31,5 @@ response = mindee_client.enqueue_and_get_result(
 # Print a brief summary of the parsed data
 print(response.inference)
 
-# Access the ocr result
+# Access the OCR result
 pages: list = response.inference.result.pages

code_samples/v2_split.txt

@@ -7,7 +7,7 @@ from mindee import (
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
-model_id = "MY_SPLIT_MODEL_ID"
+model_id = "MY_MODEL_ID"
 
 # Init a new client
 mindee_client = ClientV2(api_key)

misc/input.html

@@ -286,7 +286,7 @@
 
 <dl class="py class">
 <dt class="sig sig-object py" id="mindee.input.InferenceParameters">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InferenceParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</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">webhook_ids</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">polling_options</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">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">rag</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">raw_text</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">polygon</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">confidence</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">text_context</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">data_schema</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.input.InferenceParameters" title="Link to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InferenceParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</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">webhook_ids</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">polling_options</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">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">_slug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'inferences'</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_text</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">polygon</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">confidence</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">text_context</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">data_schema</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.input.InferenceParameters" title="Link to this definition"></a></dt>
 <dd><p>Inference parameters to set when sending a file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -296,6 +296,7 @@
 <li><p><strong>webhook_ids</strong> (<em>List</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em>)</p></li>
 <li><p><strong>polling_options</strong> (<a class="reference internal" href="#mindee.input.PollingOptions" title="mindee.input.polling_options.PollingOptions"><em>PollingOptions</em></a><em> | </em><em>None</em>)</p></li>
 <li><p><strong>close_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>_slug</strong> (<em>str</em>)</p></li>
 <li><p><strong>rag</strong> (<em>bool</em><em> | </em><em>None</em>)</p></li>
 <li><p><strong>raw_text</strong> (<em>bool</em><em> | </em><em>None</em>)</p></li>
 <li><p><strong>polygon</strong> (<em>bool</em><em> | </em><em>None</em>)</p></li>