Skip to content

Commit

Permalink
🔖 Version 4.16.0 (#292)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianMindee authored Dec 13, 2024
1 parent 6a72a77 commit 2dcf781
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 9 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Mindee Python API Library Changelog

## v4.16.0 - 2024-12-13
### Changes
* :sparkles: allow local downloading of remote sources
* :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1


## v4.15.1 - 2024-11-28
### Changes
* :arrow_up: update pylint
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ result = mindee_client.parse(product.us.BankCheckV1, input_doc)
print(result.document)
```

#### Custom Document (API Builder)
#### Custom Documents (docTI & Custom APIs)

```python
from mindee import Client, product
Expand All @@ -92,8 +92,8 @@ input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Parse the file.
# The endpoint must be specified since it cannot be determined from the class.
result = mindee_client.parse(
product.CustomV1,
result = mindee_client.enqueue_and_parse(
product.GeneratedV1,
input_doc,
endpoint=my_endpoint
)
Expand Down
2 changes: 1 addition & 1 deletion docs/extras/guide/custom_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: 622b805aaec68102ea7fcbc2
slug: python-api-builder
parentDoc: 609808f773b0b90051d839de
---
> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the DocTI API documentation, you can find it [here](https://developers.mindee.com/docs/generated-api-python).
> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the docTI API documentation, you can find it [here](https://developers.mindee.com/docs/generated-api-python).
# Quick-Start

Expand Down
8 changes: 4 additions & 4 deletions docs/extras/guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,20 +209,20 @@ Simply setting the correct class and passing the input document is enough:
result = mindee_client.parse(product.InvoiceV4, input_doc)
```

### Custom Documents
### Custom Documents (docTI & Custom APIs)

The endpoint to use must be created beforehands and subsequently passed to the `endpoint` argument of the `parse` method:
The endpoint to use must be created beforehand and subsequently passed to the `endpoint` argument of the `enqueue_and_parse` method:

```python
custom_endpoint = mindee_client.create_endpoint(
"my-endpoin-url",
"my-account-name",
# "my-version" # optional
)
result = mindee_client.parse(product.CustomV1, input_doc, endpoint=custom_endpoint)
result = mindee_client.enqueue_and_parse(product.GeneratedV1, input_doc, endpoint=custom_endpoint)
```

This is because the `CustomV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.
This is because the `GeneratedV1` class is enough to handle the return processing, but the actual endpoint needs to be specified.


## Processing the Response
Expand Down
2 changes: 1 addition & 1 deletion mindee/versions.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import sys

__version__ = "4.15.1"
__version__ = "4.16.0"

PYTHON_VERSION = f"{sys.version_info[0]}.{sys.version_info[1]}"

Expand Down

0 comments on commit 2dcf781

Please sign in to comment.