Skip to content

Commit 5acd1f5

Browse files
ianardeeianardee
committed
deploy: 1ec7301 
1 parent f7068ac commit 5acd1f5

10 files changed

Lines changed: 363 additions & 8 deletions

File tree

‎code_samples/v2_classification.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
from mindee import (
2+
ClientV2,
3+
PathInput,
4+
ClassificationParameters,
5+
ClassificationResponse,
6+
)
7+
8+
input_path = "/path/to/the/file.ext"
9+
api_key = "MY_API_KEY"
10+
model_id = "MY_CLASSIFICATION_MODEL_ID"
11+
12+
# Init a new client
13+
mindee_client = ClientV2(api_key)
14+
15+
# Set parameters
16+
params = ClassificationParameters(
17+
# ID of the model, required.
18+
model_id=model_id,
19+
)
20+
21+
# Load a file from disk
22+
input_source = PathInput(input_path)
23+
24+
# Send for processing using polling
25+
response = mindee_client.enqueue_and_get_result(
26+
ClassificationResponse,
27+
input_source,
28+
params,
29+
)
30+
31+
# Print a brief summary of the parsed data
32+
print(response.inference)
33+
34+
# Access the classification result
35+
classification: str = response.inference.result.classification.document_type

‎code_samples/v2_crop.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
from mindee import (
2+
ClientV2,
3+
PathInput,
4+
CropParameters,
5+
CropResponse,
6+
)
7+
8+
input_path = "/path/to/the/file.ext"
9+
api_key = "MY_API_KEY"
10+
model_id = "MY_CROP_MODEL_ID"
11+
12+
# Init a new client
13+
mindee_client = ClientV2(api_key)
14+
15+
# Set parameters
16+
params = CropParameters(
17+
# ID of the model, required.
18+
model_id=model_id,
19+
)
20+
21+
# Load a file from disk
22+
input_source = PathInput(input_path)
23+
24+
# Send for processing using polling
25+
response = mindee_client.enqueue_and_get_result(
26+
CropResponse,
27+
input_source,
28+
params,
29+
)
30+
31+
# Print a brief summary of the parsed data
32+
print(response.inference)
33+
34+
# Access the crop result
35+
crops: list = response.inference.result.crops

code_samples/default_v2.txt renamed to code_samples/v2_extraction.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
from mindee import ClientV2, InferenceParameters, PathInput
1+
from mindee import (
2+
ClientV2,
3+
InferenceParameters,
4+
InferenceResponse,
5+
PathInput,
6+
)
27

38
input_path = "/path/to/the/file.ext"
49
api_key = "MY_API_KEY"
@@ -29,8 +34,10 @@ params = InferenceParameters(
2934
input_source = PathInput(input_path)
3035

3136
# Send for processing
32-
response = mindee_client.enqueue_and_get_inference(
33-
input_source, params
37+
response = mindee_client.enqueue_and_get_result(
38+
InferenceResponse,
39+
input_source,
40+
params,
3441
)
3542

3643
# Print a brief summary of the parsed data

‎code_samples/v2_ocr.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
from mindee import (
2+
ClientV2,
3+
PathInput,
4+
OCRParameters,
5+
OCRResponse,
6+
)
7+
8+
input_path = "/path/to/the/file.ext"
9+
api_key = "MY_API_KEY"
10+
model_id = "MY_OCR_MODEL_ID"
11+
12+
# Init a new client
13+
mindee_client = ClientV2(api_key)
14+
15+
# Set parameters
16+
params = OCRParameters(
17+
# ID of the model, required.
18+
model_id=model_id,
19+
)
20+
21+
# Load a file from disk
22+
input_source = PathInput(input_path)
23+
24+
# Send for processing using polling
25+
response = mindee_client.enqueue_and_get_result(
26+
OCRResponse,
27+
input_source,
28+
params,
29+
)
30+
31+
# Print a brief summary of the parsed data
32+
print(response.inference)
33+
34+
# Access the ocr result
35+
pages: list = response.inference.result.pages

‎code_samples/v2_split.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
from mindee import (
2+
ClientV2,
3+
PathInput,
4+
SplitParameters,
5+
SplitResponse,
6+
)
7+
8+
input_path = "/path/to/the/file.ext"
9+
api_key = "MY_API_KEY"
10+
model_id = "MY_SPLIT_MODEL_ID"
11+
12+
# Init a new client
13+
mindee_client = ClientV2(api_key)
14+
15+
# Set parameters
16+
params = SplitParameters(
17+
# ID of the model, required.
18+
model_id=model_id,
19+
)
20+
21+
# Load a file from disk
22+
input_source = PathInput(input_path)
23+
24+
# Send for processing using polling
25+
response = mindee_client.enqueue_and_get_result(
26+
SplitResponse,
27+
input_source,
28+
params,
29+
)
30+
31+
# Print a brief summary of the parsed data
32+
print(response.inference)
33+
34+
# Access the split result
35+
splits: list = response.inference.result.splits

‎genindex.html‎

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,12 @@ <h2 id="A">A</h2>
183183
</li>
184184
<li><a href="product/ind/indian_passport_v1.html#mindee.product.ind.indian_passport.indian_passport_v1_document.IndianPassportV1Document.address3">address3 (IndianPassportV1Document attribute)</a>
185185
</li>
186-
<li><a href="misc/input.html#mindee.input.WorkflowOptions.alias">alias (WorkflowOptions attribute)</a>
186+
<li><a href="misc/input.html#mindee.input.BaseParameters.alias">alias (BaseParameters attribute)</a>
187+
188+
<ul>
189+
<li><a href="misc/input.html#mindee.input.WorkflowOptions.alias">(WorkflowOptions attribute)</a>
187190
</li>
191+
</ul></li>
188192
<li><a href="parsing/common.html#mindee.parsing.common.ocr.ocr_page.OcrPage.all_lines">all_lines (OcrPage property)</a>
189193
</li>
190194
<li><a href="parsing/common.html#mindee.parsing.common.ocr.ocr_page.OcrPage.all_words">all_words (OcrPage property)</a>
@@ -352,6 +356,8 @@ <h2 id="B">B</h2>
352356
<li><a href="misc/mindee_http.html#mindee.mindee_http.BaseEndpoint">BaseEndpoint (class in mindee.mindee_http)</a>
353357
</li>
354358
<li><a href="parsing/standard.html#mindee.parsing.standard.base.BaseField">BaseField (class in mindee.parsing.standard.base)</a>
359+
</li>
360+
<li><a href="misc/input.html#mindee.input.BaseParameters">BaseParameters (class in mindee.input)</a>
355361
</li>
356362
<li><a href="parsing/standard.html#mindee.parsing.standard.tax.TaxField.basis">basis (TaxField attribute)</a>
357363
</li>
@@ -646,6 +652,8 @@ <h2 id="C">C</h2>
646652
<li><a href="client.html#mindee.client.Client">Client (class in mindee.client)</a>
647653
</li>
648654
<li><a href="misc/input.html#mindee.input.LocalInputSource.close">close() (LocalInputSource method)</a>
655+
</li>
656+
<li><a href="misc/input.html#mindee.input.BaseParameters.close_file">close_file (BaseParameters attribute)</a>
649657
</li>
650658
<li><a href="parsing/standard.html#mindee.parsing.standard.tax.TaxField.code">code (TaxField attribute)</a>
651659
</li>
@@ -735,6 +743,8 @@ <h2 id="C">C</h2>
735743
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_line_item.FinancialDocumentV1LineItem.confidence">(FinancialDocumentV1LineItem attribute)</a>
736744
</li>
737745
<li><a href="product/us/healthcare_card_v1.html#mindee.product.us.healthcare_card.healthcare_card_v1_copay.HealthcareCardV1Copay.confidence">(HealthcareCardV1Copay attribute)</a>
746+
</li>
747+
<li><a href="misc/input.html#mindee.input.InferenceParameters.confidence">(InferenceParameters attribute)</a>
738748
</li>
739749
<li><a href="product/invoice_splitter_v1.html#mindee.product.invoice_splitter.invoice_splitter_v1_invoice_page_group.InvoiceSplitterV1InvoicePageGroup.confidence">(InvoiceSplitterV1InvoicePageGroup attribute)</a>
740750
</li>
@@ -963,6 +973,8 @@ <h2 id="D">D</h2>
963973
<li><a href="product/nutrition_facts_label_v1.html#mindee.product.nutrition_facts_label.nutrition_facts_label_v1_trans_fat.NutritionFactsLabelV1TransFat.daily_value">(NutritionFactsLabelV1TransFat attribute)</a>
964974
</li>
965975
</ul></li>
976+
<li><a href="misc/input.html#mindee.input.InferenceParameters.data_schema">data_schema (InferenceParameters attribute)</a>
977+
</li>
966978
<li><a href="product/us/bank_check_v1.html#mindee.product.us.bank_check.bank_check_v1_document.BankCheckV1Document.date">date (BankCheckV1Document attribute)</a>
967979

968980
<ul>
@@ -1597,6 +1609,14 @@ <h2 id="G">G</h2>
15971609
</ul></li>
15981610
</ul></td>
15991611
<td style="width: 33%; vertical-align: top;"><ul>
1612+
<li><a href="misc/input.html#mindee.input.BaseParameters.get_enqueue_slug">get_enqueue_slug() (BaseParameters class method)</a>
1613+
</li>
1614+
<li><a href="misc/input.html#mindee.input.BaseParameters.get_form_data">get_form_data() (BaseParameters method)</a>
1615+
1616+
<ul>
1617+
<li><a href="misc/input.html#mindee.input.InferenceParameters.get_form_data">(InferenceParameters method)</a>
1618+
</li>
1619+
</ul></li>
16001620
<li><a href="misc/input.html#mindee.input.LocalResponse.get_hmac_signature">get_hmac_signature() (LocalResponse method)</a>
16011621
</li>
16021622
<li><a href="product/generated_v1.html#mindee.product.generated.generated_v1.GeneratedV1Document.get_list_fields">get_list_fields() (GeneratedV1Document method)</a>
@@ -1768,6 +1788,8 @@ <h2 id="I">I</h2>
17681788
<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>
17691789
</li>
17701790
<li><a href="parsing/common.html#mindee.parsing.common.document.Document.inference">inference (Document attribute)</a>
1791+
</li>
1792+
<li><a href="misc/input.html#mindee.input.InferenceParameters">InferenceParameters (class in mindee.input)</a>
17711793
</li>
17721794
<li><a href="misc/input.html#mindee.input.PollingOptions.initial_delay_sec">initial_delay_sec (PollingOptions attribute)</a>
17731795
</li>
@@ -1810,11 +1832,11 @@ <h2 id="I">I</h2>
18101832
<li><a href="parsing/standard.html#mindee.parsing.standard.date.DateField.is_computed">is_computed (DateField attribute)</a>
18111833
</li>
18121834
<li><a href="parsing/generated.html#mindee.parsing.generated.is_generated_object">is_generated_object() (in module mindee.parsing.generated)</a>
1813-
</li>
1814-
<li><a href="misc/input.html#mindee.input.LocalInputSource.is_pdf">is_pdf() (LocalInputSource method)</a>
18151835
</li>
18161836
</ul></td>
18171837
<td style="width: 33%; vertical-align: top;"><ul>
1838+
<li><a href="misc/input.html#mindee.input.LocalInputSource.is_pdf">is_pdf() (LocalInputSource method)</a>
1839+
</li>
18181840
<li><a href="misc/input.html#mindee.input.LocalInputSource.is_pdf_empty">is_pdf_empty() (LocalInputSource method)</a>
18191841
</li>
18201842
<li><a href="misc/geometry.html#mindee.geometry.is_point_in_polygon_x">is_point_in_polygon_x() (in module mindee.geometry)</a>
@@ -2118,6 +2140,8 @@ <h2 id="M">M</h2>
21182140
<li><a href="misc/geometry.html#mindee.geometry.MinMax">MinMax (class in mindee.geometry)</a>
21192141
</li>
21202142
<li><a href="product/business_card_v1.html#mindee.product.business_card.business_card_v1_document.BusinessCardV1Document.mobile_number">mobile_number (BusinessCardV1Document attribute)</a>
2143+
</li>
2144+
<li><a href="misc/input.html#mindee.input.BaseParameters.model_id">model_id (BaseParameters attribute)</a>
21212145
</li>
21222146
<li>
21232147
module
@@ -2813,6 +2837,8 @@ <h2 id="P">P</h2>
28132837
</li>
28142838
</ul></li>
28152839
<li><a href="misc/geometry.html#mindee.geometry.Point">Point (class in mindee.geometry)</a>
2840+
</li>
2841+
<li><a href="misc/input.html#mindee.input.BaseParameters.polling_options">polling_options (BaseParameters attribute)</a>
28162842
</li>
28172843
<li><a href="misc/input.html#mindee.input.PollingOptions">PollingOptions (class in mindee.input)</a>
28182844
</li>
@@ -2854,6 +2880,8 @@ <h2 id="P">P</h2>
28542880
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_line_item.FinancialDocumentV1LineItem.polygon">(FinancialDocumentV1LineItem attribute)</a>
28552881
</li>
28562882
<li><a href="product/us/healthcare_card_v1.html#mindee.product.us.healthcare_card.healthcare_card_v1_copay.HealthcareCardV1Copay.polygon">(HealthcareCardV1Copay attribute)</a>
2883+
</li>
2884+
<li><a href="misc/input.html#mindee.input.InferenceParameters.polygon">(InferenceParameters attribute)</a>
28572885
</li>
28582886
<li><a href="product/invoice_splitter_v1.html#mindee.product.invoice_splitter.invoice_splitter_v1_invoice_page_group.InvoiceSplitterV1InvoicePageGroup.polygon">(InvoiceSplitterV1InvoicePageGroup attribute)</a>
28592887
</li>
@@ -3168,8 +3196,12 @@ <h2 id="Q">Q</h2>
31683196
<h2 id="R">R</h2>
31693197
<table style="width: 100%" class="indextable genindextable"><tr>
31703198
<td style="width: 33%; vertical-align: top;"><ul>
3171-
<li><a href="misc/input.html#mindee.input.WorkflowOptions.rag">rag (WorkflowOptions attribute)</a>
3199+
<li><a href="misc/input.html#mindee.input.InferenceParameters.rag">rag (InferenceParameters attribute)</a>
3200+
3201+
<ul>
3202+
<li><a href="misc/input.html#mindee.input.WorkflowOptions.rag">(WorkflowOptions attribute)</a>
31723203
</li>
3204+
</ul></li>
31733205
<li><a href="product/fr/payslip_v2.html#mindee.product.fr.payslip.payslip_v2_salary_detail.PayslipV2SalaryDetail.rate">rate (PayslipV2SalaryDetail attribute)</a>
31743206

31753207
<ul>
@@ -3179,6 +3211,8 @@ <h2 id="R">R</h2>
31793211
</li>
31803212
</ul></li>
31813213
<li><a href="parsing/common.html#mindee.parsing.common.api_response.ApiResponse.raw_http">raw_http (ApiResponse property)</a>
3214+
</li>
3215+
<li><a href="misc/input.html#mindee.input.InferenceParameters.raw_text">raw_text (InferenceParameters attribute)</a>
31823216
</li>
31833217
<li><a href="parsing/standard.html#mindee.parsing.standard.text.StringField.raw_value">raw_value (StringField attribute)</a>
31843218
</li>
@@ -3561,6 +3595,8 @@ <h2 id="T">T</h2>
35613595
<li><a href="parsing/standard.html#mindee.parsing.standard.tax.TaxField">TaxField (class in mindee.parsing.standard.tax)</a>
35623596
</li>
35633597
<li><a href="parsing/common.html#mindee.parsing.common.ocr.ocr_word.OcrWord.text">text (OcrWord attribute)</a>
3598+
</li>
3599+
<li><a href="misc/input.html#mindee.input.InferenceParameters.text_context">text_context (InferenceParameters attribute)</a>
35643600
</li>
35653601
<li><a href="product/financial_document_v1.html#mindee.product.financial_document.financial_document_v1_document.FinancialDocumentV1Document.time">time (FinancialDocumentV1Document attribute)</a>
35663602

@@ -3884,6 +3920,8 @@ <h2 id="V">V</h2>
38843920
<h2 id="W">W</h2>
38853921
<table style="width: 100%" class="indextable genindextable"><tr>
38863922
<td style="width: 33%; vertical-align: top;"><ul>
3923+
<li><a href="misc/input.html#mindee.input.BaseParameters.webhook_ids">webhook_ids (BaseParameters attribute)</a>
3924+
</li>
38873925
<li><a href="product/business_card_v1.html#mindee.product.business_card.business_card_v1_document.BusinessCardV1Document.website">website (BusinessCardV1Document attribute)</a>
38883926
</li>
38893927
<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>

‎misc/index.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,10 @@ <h1>Misc<a class="headerlink" href="#misc" title="Link to this heading"></a><
124124
</li>
125125
<li class="toctree-l1"><a class="reference internal" href="input.html">Input</a><ul>
126126
<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>
127+
<li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.BaseParameters"><code class="docutils literal notranslate"><span class="pre">BaseParameters</span></code></a></li>
127128
<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>
128129
<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>
130+
<li class="toctree-l2"><a class="reference internal" href="input.html#mindee.input.InferenceParameters"><code class="docutils literal notranslate"><span class="pre">InferenceParameters</span></code></a></li>
129131
<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>
130132
<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>
131133
<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>

0 commit comments

Comments
 (0)