diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d7793db..b1eeb94b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index f9faf4ae..ac4b2fea 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 ) diff --git a/docs/extras/guide/custom_v1.md b/docs/extras/guide/custom_v1.md index 4c04ca98..6adf73ba 100644 --- a/docs/extras/guide/custom_v1.md +++ b/docs/extras/guide/custom_v1.md @@ -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 diff --git a/docs/extras/guide/getting_started.md b/docs/extras/guide/getting_started.md index 9628276f..7b9936a3 100644 --- a/docs/extras/guide/getting_started.md +++ b/docs/extras/guide/getting_started.md @@ -209,9 +209,9 @@ 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( @@ -219,10 +219,10 @@ custom_endpoint = mindee_client.create_endpoint( "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 diff --git a/mindee/versions.py b/mindee/versions.py index 28dd778c..8bdccdca 100644 --- a/mindee/versions.py +++ b/mindee/versions.py @@ -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]}"