Skip to content

Commit 786ccdf

Browse files
sebastianMindeesebastianMindee
committed
deploy: ba0fa1e 
1 parent d08896a commit 786ccdf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+2538
-1075
lines changed

‎_sources/product/driver_license_v1.rst.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Driver License V1
2+
-----------------
3+
4+
**Sample Code:**
5+
6+
.. literalinclude:: /extras/code_samples/driver_license_v1.txt
7+
:language: Python
8+
9+
.. autoclass:: mindee.product.driver_license.driver_license_v1.DriverLicenseV1
10+
:members:
11+
:inherited-members:
12+
13+
.. autoclass:: mindee.product.driver_license.driver_license_v1_document.DriverLicenseV1Document
14+
:members:
15+
:inherited-members:

‎_sources/product/fr/health_card_v1.rst.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Health Card V1
2+
--------------
3+
4+
**Sample Code:**
5+
6+
.. literalinclude:: /extras/code_samples/french_healthcard_v1.txt
7+
:language: Python
8+
9+
.. autoclass:: mindee.product.fr.health_card.health_card_v1.HealthCardV1
10+
:members:
11+
:inherited-members:
12+
13+
.. autoclass:: mindee.product.fr.health_card.health_card_v1_document.HealthCardV1Document
14+
:members:
15+
:inherited-members:

‎_sources/product/fr/payslip_v3.rst.txt‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Payslip V3
2+
----------
3+
4+
**Sample Code:**
5+
6+
.. literalinclude:: /extras/code_samples/payslip_fra_v3.txt
7+
:language: Python
8+
9+
.. autoclass:: mindee.product.fr.payslip.payslip_v3.PayslipV3
10+
:members:
11+
:inherited-members:
12+
13+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_document.PayslipV3Document
14+
:members:
15+
:inherited-members:
16+
17+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_pay_period.PayslipV3PayPeriod
18+
:members:
19+
:inherited-members:
20+
21+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_employee.PayslipV3Employee
22+
:members:
23+
:inherited-members:
24+
25+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_employer.PayslipV3Employer
26+
:members:
27+
:inherited-members:
28+
29+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_bank_account_detail.PayslipV3BankAccountDetail
30+
:members:
31+
:inherited-members:
32+
33+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_employment.PayslipV3Employment
34+
:members:
35+
:inherited-members:
36+
37+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_salary_detail.PayslipV3SalaryDetail
38+
:members:
39+
:inherited-members:
40+
41+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_pay_detail.PayslipV3PayDetail
42+
:members:
43+
:inherited-members:
44+
45+
.. autoclass:: mindee.product.fr.payslip.payslip_v3_paid_time_off.PayslipV3PaidTimeOff
46+
:members:
47+
:inherited-members:

‎_sources/product/international_id_v1.rst.txt‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎client.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.create_endpoint"><code class="docutils literal notranslate"><span class="pre">Client.create_endpoint()</span></code></a></li>
5252
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.enqueue"><code class="docutils literal notranslate"><span class="pre">Client.enqueue()</span></code></a></li>
5353
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.enqueue_and_parse"><code class="docutils literal notranslate"><span class="pre">Client.enqueue_and_parse()</span></code></a></li>
54+
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.execute_workflow"><code class="docutils literal notranslate"><span class="pre">Client.execute_workflow()</span></code></a></li>
5455
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.load_prediction"><code class="docutils literal notranslate"><span class="pre">Client.load_prediction()</span></code></a></li>
5556
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.parse"><code class="docutils literal notranslate"><span class="pre">Client.parse()</span></code></a></li>
5657
<li class="toctree-l4"><a class="reference internal" href="#mindee.client.Client.parse_queued"><code class="docutils literal notranslate"><span class="pre">Client.parse_queued()</span></code></a></li>
@@ -184,6 +185,29 @@ <h2>Client<a class="headerlink" href="#client" title="Permalink to this heading"
184185
</dl>
185186
</dd></dl>
186187

188+
<dl class="py method">
189+
<dt class="sig sig-object py" id="mindee.client.Client.execute_workflow">
190+
<span class="sig-name descname"><span class="pre">execute_workflow</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">workflow_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">page_options</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.client.Client.execute_workflow" title="Permalink to this definition"></a></dt>
191+
<dd><p>Send the document to a workflow execution.</p>
192+
<dl class="field-list simple">
193+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
194+
<dd class="field-odd"><ul class="simple">
195+
<li><p><strong>input_source</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<a class="reference internal" href="misc/input.html#mindee.input.LocalInputSource" title="mindee.input.sources.LocalInputSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalInputSource</span></code></a>, <a class="reference internal" href="misc/input.html#mindee.input.UrlInputSource" title="mindee.input.sources.UrlInputSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">UrlInputSource</span></code></a>]) – The document/source file to use.
196+
Has to be created beforehand.</p></li>
197+
<li><p><strong>workflow_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the workflow.</p></li>
198+
<li><p><strong>page_options</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="misc/input.html#mindee.input.PageOptions" title="mindee.input.page_options.PageOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PageOptions</span></code></a>], default: <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If set, remove pages from the document as specified. This is done before sending the file to the server. It is useful to avoid page limitations.</p></li>
199+
<li><p><strong>options</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="misc/input.html#mindee.input.WorkflowOptions" title="mindee.input.workflow_options.WorkflowOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">WorkflowOptions</span></code></a>], default: <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Options for the workflow.</p></li>
200+
</ul>
201+
</dd>
202+
<dt class="field-even">Return type<span class="colon">:</span></dt>
203+
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">WorkflowResponse</span></code></p>
204+
</dd>
205+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
206+
<dd class="field-odd"><p></p>
207+
</dd>
208+
</dl>
209+
</dd></dl>
210+
187211
<dl class="py method">
188212
<dt class="sig sig-object py" id="mindee.client.Client.load_prediction">
189213
<span class="sig-name descname"><span class="pre">load_prediction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product_class</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_response</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mindee.client.Client.load_prediction" title="Permalink to this definition"></a></dt>

‎code_samples/driver_license_v1_async.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
from mindee import Client, product, AsyncPredictResponse
2+
3+
# Init a new client
4+
mindee_client = Client(api_key="my-api-key")
5+
6+
# Load a file from disk
7+
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
8+
9+
# Load a file from disk and enqueue it.
10+
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
11+
product.DriverLicenseV1,
12+
input_doc,
13+
)
14+
15+
# Print a brief summary of the parsed data
16+
print(result.document)

‎code_samples/french_healthcard_v1_async.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
from mindee import Client, product, AsyncPredictResponse
2+
3+
# Init a new client
4+
mindee_client = Client(api_key="my-api-key")
5+
6+
# Load a file from disk
7+
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
8+
9+
# Load a file from disk and enqueue it.
10+
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
11+
product.fr.HealthCardV1,
12+
input_doc,
13+
)
14+
15+
# Print a brief summary of the parsed data
16+
print(result.document)

‎code_samples/payslip_fra_v3_async.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
from mindee import Client, product, AsyncPredictResponse
2+
3+
# Init a new client
4+
mindee_client = Client(api_key="my-api-key")
5+
6+
# Load a file from disk
7+
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
8+
9+
# Load a file from disk and enqueue it.
10+
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
11+
product.fr.PayslipV3,
12+
input_doc,
13+
)
14+
15+
# Print a brief summary of the parsed data
16+
print(result.document)

‎code_samples/workflow_execution.txt‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
from mindee import Client, WorkflowResponse
2+
from mindee.parsing.common import ExecutionPriority
3+
4+
# Init a new client
5+
mindee_client = Client(api_key: "my-api-key")
6+
7+
workflow_id = "workflow-id"
8+
9+
# Load a file from disk
10+
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
11+
12+
# Send the file to the workflow.
13+
result: WorkflowResponse = mindee_client.execute_workflow(
14+
input_doc,
15+
workflow_id,
16+
# Optionally, add an alias and a priority to the workflow.
17+
# alias="my-alias",
18+
# priority=ExecutionPriority.LOW
19+
)
20+
21+
# Print the ID of the execution to make sure it worked.
22+
print(result.execution.id)

0 commit comments

Comments
 (0)