numind 0.4.2__tar.gz → 0.4.4__tar.gz

{numind-0.4.2 → numind-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: numind
-Version: 0.4.2
+Version: 0.4.4
 Summary: SDK to interact with the NuMind models API.
 Project-URL: Homepage, https://github.com/numindai/nuextract-platform-sdk
 Project-URL: Repository, https://github.com/numindai/nuextract-platform-sdk.git
@@ -353,6 +353,8 @@ Everything you can do on the web platform can be done via API -
 - Uploading a file to a **File** via `POST /api/files` (up to 2 weeks storage)
 - Starting a structured extraction **Job** via `POST /api/structured-extraction/{structuredProjectId}/jobs`
 - Reading a structured extraction **Job** result via `GET /api/structured-extraction/jobs/{structuredExtractionJobId}`
+- Starting a localization **Job** from a completed structured extraction via `POST /api/localization/jobs/from-extraction/{sourceJobId}`
+- Reading localization via `GET /api/localization/jobs/{localizationJobId}` (check progress with `GET /api/jobs/{localizationJobId}/status`)
 - Adding an **Example** to a **Structured Extraction Project** via `POST /api/structured-extraction/{structuredProjectId}/examples`
 
 ##### Content extraction
@@ -405,9 +407,16 @@ Class | Method | HTTP request | Description
 *JobsApi* | [**get_api_jobs_jobid_status**](docs/JobsApi.md#get_api_jobs_jobid_status) | **GET** /api/jobs/{jobId}/status | 
 *JobsApi* | [**get_api_jobs_jobid_stream**](docs/JobsApi.md#get_api_jobs_jobid_stream) | **GET** /api/jobs/{jobId}/stream | 
 *JobsApi* | [**post_api_jobs_jobid_cancel**](docs/JobsApi.md#post_api_jobs_jobid_cancel) | **POST** /api/jobs/{jobId}/cancel | 
+*LocalizationApi* | [**get_api_localization_jobs_localizationjobid**](docs/LocalizationApi.md#get_api_localization_jobs_localizationjobid) | **GET** /api/localization/jobs/{localizationJobId} | 
+*LocalizationApi* | [**post_api_localization_jobs_from_extraction_sourcejobid**](docs/LocalizationApi.md#post_api_localization_jobs_from_extraction_sourcejobid) | **POST** /api/localization/jobs/from-extraction/{sourceJobId} | 
+*ProjectImportExportApi* | [**get_api_extraction_export_jobs_jobid_download**](docs/ProjectImportExportApi.md#get_api_extraction_export_jobs_jobid_download) | **GET** /api/extraction/export/jobs/{jobId}/download | 
 *ProjectImportExportApi* | [**get_api_extraction_projectkind_projectid_export**](docs/ProjectImportExportApi.md#get_api_extraction_projectkind_projectid_export) | **GET** /api/extraction/{projectKind}/{projectId}/export | 
 *ProjectImportExportApi* | [**post_api_extraction_import**](docs/ProjectImportExportApi.md#post_api_extraction_import) | **POST** /api/extraction/import | 
+*ProjectImportExportApi* | [**post_api_extraction_import_jobs**](docs/ProjectImportExportApi.md#post_api_extraction_import_jobs) | **POST** /api/extraction/import/jobs | 
+*ProjectImportExportApi* | [**post_api_extraction_projectkind_projectid_export_jobs**](docs/ProjectImportExportApi.md#post_api_extraction_projectkind_projectid_export_jobs) | **POST** /api/extraction/{projectKind}/{projectId}/export/jobs | 
+*StructuredDataExtractionApi* | [**get_api_localization_jobs_localizationjobid**](docs/StructuredDataExtractionApi.md#get_api_localization_jobs_localizationjobid) | **GET** /api/localization/jobs/{localizationJobId} | 
 *StructuredDataExtractionApi* | [**get_api_structured_extraction_jobs_structuredextractionjobid**](docs/StructuredDataExtractionApi.md#get_api_structured_extraction_jobs_structuredextractionjobid) | **GET** /api/structured-extraction/jobs/{structuredExtractionJobId} | 
+*StructuredDataExtractionApi* | [**post_api_localization_jobs_from_extraction_sourcejobid**](docs/StructuredDataExtractionApi.md#post_api_localization_jobs_from_extraction_sourcejobid) | **POST** /api/localization/jobs/from-extraction/{sourceJobId} | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_jobs**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_jobs) | **POST** /api/structured-extraction/jobs | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_structuredprojectid_jobs**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_structuredprojectid_jobs) | **POST** /api/structured-extraction/{structuredProjectId}/jobs | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_structuredprojectid_jobs_text**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_structuredprojectid_jobs_text) | **POST** /api/structured-extraction/{structuredProjectId}/jobs/text | 
@@ -437,6 +446,7 @@ Class | Method | HTTP request | Description
 
 ### Documentation For Models
 
+ - [BoundingBox](docs/BoundingBox.md)
  - [Content](docs/Content.md)
  - [ContentExtractionResponse](docs/ContentExtractionResponse.md)
  - [ContentProjectResponse](docs/ContentProjectResponse.md)
@@ -448,6 +458,7 @@ Class | Method | HTTP request | Description
  - [CreateContentProjectRequest](docs/CreateContentProjectRequest.md)
  - [CreateOrUpdateStructuredExampleRequest](docs/CreateOrUpdateStructuredExampleRequest.md)
  - [CreateStructuredProjectRequest](docs/CreateStructuredProjectRequest.md)
+ - [DiscardedLocalizationItem](docs/DiscardedLocalizationItem.md)
  - [DocumentInfo](docs/DocumentInfo.md)
  - [DocumentResponse](docs/DocumentResponse.md)
  - [Error](docs/Error.md)
@@ -463,6 +474,8 @@ Class | Method | HTTP request | Description
  - [JobIdResponse](docs/JobIdResponse.md)
  - [JobReportResponse](docs/JobReportResponse.md)
  - [JobStatusResponse](docs/JobStatusResponse.md)
+ - [LocalizationResponse](docs/LocalizationResponse.md)
+ - [LocalizationValue](docs/LocalizationValue.md)
  - [PaginatedResponseT](docs/PaginatedResponseT.md)
  - [PostProcessingErrorResponse](docs/PostProcessingErrorResponse.md)
  - [PostProcessingRepairResponse](docs/PostProcessingRepairResponse.md)

{numind-0.4.2 → numind-0.4.4}/README.md

@@ -277,6 +277,8 @@ Everything you can do on the web platform can be done via API -
 - Uploading a file to a **File** via `POST /api/files` (up to 2 weeks storage)
 - Starting a structured extraction **Job** via `POST /api/structured-extraction/{structuredProjectId}/jobs`
 - Reading a structured extraction **Job** result via `GET /api/structured-extraction/jobs/{structuredExtractionJobId}`
+- Starting a localization **Job** from a completed structured extraction via `POST /api/localization/jobs/from-extraction/{sourceJobId}`
+- Reading localization via `GET /api/localization/jobs/{localizationJobId}` (check progress with `GET /api/jobs/{localizationJobId}/status`)
 - Adding an **Example** to a **Structured Extraction Project** via `POST /api/structured-extraction/{structuredProjectId}/examples`
 
 ##### Content extraction
@@ -329,9 +331,16 @@ Class | Method | HTTP request | Description
 *JobsApi* | [**get_api_jobs_jobid_status**](docs/JobsApi.md#get_api_jobs_jobid_status) | **GET** /api/jobs/{jobId}/status | 
 *JobsApi* | [**get_api_jobs_jobid_stream**](docs/JobsApi.md#get_api_jobs_jobid_stream) | **GET** /api/jobs/{jobId}/stream | 
 *JobsApi* | [**post_api_jobs_jobid_cancel**](docs/JobsApi.md#post_api_jobs_jobid_cancel) | **POST** /api/jobs/{jobId}/cancel | 
+*LocalizationApi* | [**get_api_localization_jobs_localizationjobid**](docs/LocalizationApi.md#get_api_localization_jobs_localizationjobid) | **GET** /api/localization/jobs/{localizationJobId} | 
+*LocalizationApi* | [**post_api_localization_jobs_from_extraction_sourcejobid**](docs/LocalizationApi.md#post_api_localization_jobs_from_extraction_sourcejobid) | **POST** /api/localization/jobs/from-extraction/{sourceJobId} | 
+*ProjectImportExportApi* | [**get_api_extraction_export_jobs_jobid_download**](docs/ProjectImportExportApi.md#get_api_extraction_export_jobs_jobid_download) | **GET** /api/extraction/export/jobs/{jobId}/download | 
 *ProjectImportExportApi* | [**get_api_extraction_projectkind_projectid_export**](docs/ProjectImportExportApi.md#get_api_extraction_projectkind_projectid_export) | **GET** /api/extraction/{projectKind}/{projectId}/export | 
 *ProjectImportExportApi* | [**post_api_extraction_import**](docs/ProjectImportExportApi.md#post_api_extraction_import) | **POST** /api/extraction/import | 
+*ProjectImportExportApi* | [**post_api_extraction_import_jobs**](docs/ProjectImportExportApi.md#post_api_extraction_import_jobs) | **POST** /api/extraction/import/jobs | 
+*ProjectImportExportApi* | [**post_api_extraction_projectkind_projectid_export_jobs**](docs/ProjectImportExportApi.md#post_api_extraction_projectkind_projectid_export_jobs) | **POST** /api/extraction/{projectKind}/{projectId}/export/jobs | 
+*StructuredDataExtractionApi* | [**get_api_localization_jobs_localizationjobid**](docs/StructuredDataExtractionApi.md#get_api_localization_jobs_localizationjobid) | **GET** /api/localization/jobs/{localizationJobId} | 
 *StructuredDataExtractionApi* | [**get_api_structured_extraction_jobs_structuredextractionjobid**](docs/StructuredDataExtractionApi.md#get_api_structured_extraction_jobs_structuredextractionjobid) | **GET** /api/structured-extraction/jobs/{structuredExtractionJobId} | 
+*StructuredDataExtractionApi* | [**post_api_localization_jobs_from_extraction_sourcejobid**](docs/StructuredDataExtractionApi.md#post_api_localization_jobs_from_extraction_sourcejobid) | **POST** /api/localization/jobs/from-extraction/{sourceJobId} | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_jobs**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_jobs) | **POST** /api/structured-extraction/jobs | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_structuredprojectid_jobs**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_structuredprojectid_jobs) | **POST** /api/structured-extraction/{structuredProjectId}/jobs | 
 *StructuredDataExtractionApi* | [**post_api_structured_extraction_structuredprojectid_jobs_text**](docs/StructuredDataExtractionApi.md#post_api_structured_extraction_structuredprojectid_jobs_text) | **POST** /api/structured-extraction/{structuredProjectId}/jobs/text | 
@@ -361,6 +370,7 @@ Class | Method | HTTP request | Description
 
 ### Documentation For Models
 
+ - [BoundingBox](docs/BoundingBox.md)
  - [Content](docs/Content.md)
  - [ContentExtractionResponse](docs/ContentExtractionResponse.md)
  - [ContentProjectResponse](docs/ContentProjectResponse.md)
@@ -372,6 +382,7 @@ Class | Method | HTTP request | Description
  - [CreateContentProjectRequest](docs/CreateContentProjectRequest.md)
  - [CreateOrUpdateStructuredExampleRequest](docs/CreateOrUpdateStructuredExampleRequest.md)
  - [CreateStructuredProjectRequest](docs/CreateStructuredProjectRequest.md)
+ - [DiscardedLocalizationItem](docs/DiscardedLocalizationItem.md)
  - [DocumentInfo](docs/DocumentInfo.md)
  - [DocumentResponse](docs/DocumentResponse.md)
  - [Error](docs/Error.md)
@@ -387,6 +398,8 @@ Class | Method | HTTP request | Description
  - [JobIdResponse](docs/JobIdResponse.md)
  - [JobReportResponse](docs/JobReportResponse.md)
  - [JobStatusResponse](docs/JobStatusResponse.md)
+ - [LocalizationResponse](docs/LocalizationResponse.md)
+ - [LocalizationValue](docs/LocalizationValue.md)
  - [PaginatedResponseT](docs/PaginatedResponseT.md)
  - [PostProcessingErrorResponse](docs/PostProcessingErrorResponse.md)
  - [PostProcessingRepairResponse](docs/PostProcessingRepairResponse.md)

numind-0.4.4/docs/BoundingBox.md

@@ -0,0 +1,30 @@
+# BoundingBox
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **int** | One-based document page number. | 
+**bbox** | **List[float]** | Normalized [x1, y1, x2, y2] coordinates (0–1). | 
+
+## Example
+
+```python
+from numind.models.bounding_box import BoundingBox
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoundingBox from a JSON string
+bounding_box_instance = BoundingBox.from_json(json)
+# print the JSON string representation of the object
+print(BoundingBox.to_json())
+
+# convert the object into a dict
+bounding_box_dict = bounding_box_instance.to_dict()
+# create an instance of BoundingBox from a dict
+bounding_box_from_dict = BoundingBox.from_dict(bounding_box_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

{numind-0.4.2 → numind-0.4.4}/docs/ContentExtractionApi.md

@@ -102,7 +102,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **post_api_content_extraction_jobs**
-> JobIdResponse post_api_content_extraction_jobs(file, x_organization_id=x_organization_id, project_id=project_id, temperature=temperature, rasterization_dpi=rasterization_dpi, max_output_tokens=max_output_tokens, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout)
+> JobIdResponse post_api_content_extraction_jobs(file, x_organization_id=x_organization_id, project_id=project_id, temperature=temperature, rasterization_dpi=rasterization_dpi, max_output_tokens=max_output_tokens, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout, low_priority=low_priority)
 
 
  Extract content from the provided file in markdown format as an async job.
@@ -165,6 +165,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     random_seed = "random_seed_example"  # str | Inference seed setting. Use a string containing a 64-bit integer for a fixed seed, or `random` to generate one for each inference. (optional)
     image_width = "image_width_example"  # str | Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. (optional)
     timeout = "timeout_example"  # str | Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h (optional)
+    low_priority = False  # bool | Submit this job with lower scheduling priority in the job queue and inference engine. (optional) (default to False)
 
     try:
         api_response = api_instance.post_api_content_extraction_jobs(
@@ -180,6 +181,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
             random_seed=random_seed,
             image_width=image_width,
             timeout=timeout,
+            low_priority=low_priority,
         )
         print(
             "The response of ContentExtractionApi->post_api_content_extraction_jobs:\n"
@@ -211,6 +213,7 @@ Name | Type | Description  | Notes
  **random_seed** | **str**| Inference seed setting. Use a string containing a 64-bit integer for a fixed seed, or `random` to generate one for each inference. | [optional] 
  **image_width** | **str**| Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. | [optional] 
  **timeout** | **str**| Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
+ **low_priority** | **bool**| Submit this job with lower scheduling priority in the job queue and inference engine. | [optional] [default to False]
 
 ### Return type
 
@@ -230,7 +233,7 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection, Invalid value for: body |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection, Invalid value for: body, Invalid value for: query parameter lowPriority |  -  |
 **0** |  |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

numind-0.4.4/docs/DiscardedLocalizationItem.md

@@ -0,0 +1,33 @@
+# DiscardedLocalizationItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **str** |  | 
+**reason** | **str** |  | 
+**value** | **str** | JSON preview of the rejected value, capped at 80 characters; absent for missing fields. Parsed boxes use {page, bbox} with a one-based document page number and normalized coordinates. For invalid_page, the page is outside the document and retains the one-based model page number. Other rejected values, including unexpected fields, retain raw model JSON. | [optional] 
+
+## Example
+
+```python
+from numind.models.discarded_localization_item import DiscardedLocalizationItem
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DiscardedLocalizationItem from a JSON string
+discarded_localization_item_instance = DiscardedLocalizationItem.from_json(json)
+# print the JSON string representation of the object
+print(DiscardedLocalizationItem.to_json())
+
+# convert the object into a dict
+discarded_localization_item_dict = discarded_localization_item_instance.to_dict()
+# create an instance of DiscardedLocalizationItem from a dict
+discarded_localization_item_from_dict = DiscardedLocalizationItem.from_dict(
+    discarded_localization_item_dict
+)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

{numind-0.4.2 → numind-0.4.4}/docs/DocumentInfo.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **file_name** | **str** | Filename of the initial file if any.     **None** for text input. | 
 **possible_transformations** | **List[str]** | Possible transformations that can be done with this document. | [optional] 
 **dpi** | **int** | Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch. | [optional] 
-**part_count** | **int** | Number of image parts in this document. | 
+**part_count** | **int** | Number of pages in this document. | 
 **type** | **str** |  | 
 **text** | **str** | The text content of the document. | 
 

{numind-0.4.2 → numind-0.4.4}/docs/ImageInfo.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **file_name** | **str** | Filename of the initial file. | 
 **possible_transformations** | **List[str]** | Possible transformations that can be done with this document. | [optional] 
 **dpi** | **int** | Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch. | [optional] 
-**part_count** | **int** | Number of image parts in this document. | 
+**part_count** | **int** | Number of pages in this document. | 
 **type** | **str** |  | 
 
 ## Example

{numind-0.4.2 → numind-0.4.4}/docs/InferenceApi.md

@@ -10,7 +10,7 @@ Method | HTTP request | Description
 
 
 # **post_api_content_extraction_contentprojectid_jobs_document_documentid**
-> JobIdResponse post_api_content_extraction_contentprojectid_jobs_document_documentid(content_project_id, document_id, x_organization_id=x_organization_id, timeout=timeout)
+> JobIdResponse post_api_content_extraction_contentprojectid_jobs_document_documentid(content_project_id, document_id, x_organization_id=x_organization_id, timeout=timeout, low_priority=low_priority)
 
 
  Extract content from the provided document in markdown format as an async job.
@@ -67,6 +67,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     document_id = "document_id_example"  # str | Unique document identifier.
     x_organization_id = "x_organization_id_example"  # str | Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. (optional)
     timeout = "timeout_example"  # str | Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h (optional)
+    low_priority = False  # bool | Submit this job with lower scheduling priority in the job queue and inference engine. (optional) (default to False)
 
     try:
         api_response = api_instance.post_api_content_extraction_contentprojectid_jobs_document_documentid(
@@ -74,6 +75,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
             document_id,
             x_organization_id=x_organization_id,
             timeout=timeout,
+            low_priority=low_priority,
         )
         print(
             "The response of InferenceApi->post_api_content_extraction_contentprojectid_jobs_document_documentid:\n"
@@ -97,6 +99,7 @@ Name | Type | Description  | Notes
  **document_id** | **str**| Unique document identifier. | 
  **x_organization_id** | **str**| Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. | [optional] 
  **timeout** | **str**| Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
+ **low_priority** | **bool**| Submit this job with lower scheduling priority in the job queue and inference engine. | [optional] [default to False]
 
 ### Return type
 
@@ -109,19 +112,20 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: application/json, text/plain
 
 ### HTTP response details
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
+**400** | Invalid value for: query parameter lowPriority |  -  |
 **0** |  |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **post_api_structured_extraction_structuredprojectid_jobs_document_documentid**
-> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs_document_documentid(structured_project_id, document_id, x_organization_id=x_organization_id, temperature=temperature, max_output_tokens=max_output_tokens, max_example_token_number=max_example_token_number, max_example_number=max_example_number, min_example_similarity=min_example_similarity, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout)
+> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs_document_documentid(structured_project_id, document_id, x_organization_id=x_organization_id, temperature=temperature, max_output_tokens=max_output_tokens, max_example_token_number=max_example_token_number, max_example_number=max_example_number, min_example_similarity=min_example_similarity, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout, low_priority=low_priority)
 
 
  Performs structured information extraction inference on the provided document as an async job.
@@ -191,6 +195,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     random_seed = "random_seed_example"  # str | Inference seed setting. Use a string containing a 64-bit integer for a fixed seed, or `random` to generate one for each inference. (optional)
     image_width = "image_width_example"  # str | Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. (optional)
     timeout = "timeout_example"  # str | Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h (optional)
+    low_priority = False  # bool | Submit this job with lower scheduling priority in the job queue and inference engine. (optional) (default to False)
 
     try:
         api_response = api_instance.post_api_structured_extraction_structuredprojectid_jobs_document_documentid(
@@ -208,6 +213,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
             random_seed=random_seed,
             image_width=image_width,
             timeout=timeout,
+            low_priority=low_priority,
         )
         print(
             "The response of InferenceApi->post_api_structured_extraction_structuredprojectid_jobs_document_documentid:\n"
@@ -241,6 +247,7 @@ Name | Type | Description  | Notes
  **random_seed** | **str**| Inference seed setting. Use a string containing a 64-bit integer for a fixed seed, or `random` to generate one for each inference. | [optional] 
  **image_width** | **str**| Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. | [optional] 
  **timeout** | **str**| Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
+ **low_priority** | **bool**| Submit this job with lower scheduling priority in the job queue and inference engine. | [optional] [default to False]
 
 ### Return type
 
@@ -260,13 +267,13 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection, Invalid value for: query parameter lowPriority |  -  |
 **0** |  |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **post_api_template_generation_jobs_document_documentid**
-> JobIdResponse post_api_template_generation_jobs_document_documentid(document_id, x_organization_id=x_organization_id, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, image_width=image_width, timeout=timeout)
+> JobIdResponse post_api_template_generation_jobs_document_documentid(document_id, x_organization_id=x_organization_id, enable_thinking=enable_thinking, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, image_width=image_width, timeout=timeout, low_priority=low_priority)
 
 
  Derive a template from the provided **Document** as an async job.
@@ -323,6 +330,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     )
     image_width = "image_width_example"  # str | Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. (optional)
     timeout = "timeout_example"  # str | Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h (optional)
+    low_priority = False  # bool | Submit this job with lower scheduling priority in the job queue and inference engine. (optional) (default to False)
 
     try:
         api_response = (
@@ -334,6 +342,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
                 loop_detection=loop_detection,
                 image_width=image_width,
                 timeout=timeout,
+                low_priority=low_priority,
             )
         )
         print(
@@ -361,6 +370,7 @@ Name | Type | Description  | Notes
  **loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional] 
  **image_width** | **str**| Original standalone images only (not PDF/TIFF or converted pages). Use automatic for a 1280 px short side, original to preserve the upload, or a positive integer for the upright image width in pixels. Aspect ratio is preserved; upscaling is allowed. | [optional] 
  **timeout** | **str**| Execution timeout for the async inference job. If omitted, the server default of 60m is used.   If provided below the server-configured minimum (5m by default), the effective timeout is clamped to that minimum.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
+ **low_priority** | **bool**| Submit this job with lower scheduling priority in the job queue and inference engine. | [optional] [default to False]
 
 ### Return type
 
@@ -380,7 +390,7 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection |  -  |
+**400** | Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection, Invalid value for: query parameter lowPriority |  -  |
 **0** |  |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

numind-0.4.2/docs/ProjectImportExportApi.md → numind-0.4.4/docs/LocalizationApi.md

@@ -1,17 +1,27 @@
-# numind.openapi_client.ProjectImportExportApi
+# numind.openapi_client.LocalizationApi
 
 All URIs are relative to *https://nuextract.ai*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_api_extraction_projectkind_projectid_export**](ProjectImportExportApi.md#get_api_extraction_projectkind_projectid_export) | **GET** /api/extraction/{projectKind}/{projectId}/export | 
-[**post_api_extraction_import**](ProjectImportExportApi.md#post_api_extraction_import) | **POST** /api/extraction/import | 
+[**get_api_localization_jobs_localizationjobid**](LocalizationApi.md#get_api_localization_jobs_localizationjobid) | **GET** /api/localization/jobs/{localizationJobId} | 
+[**post_api_localization_jobs_from_extraction_sourcejobid**](LocalizationApi.md#post_api_localization_jobs_from_extraction_sourcejobid) | **POST** /api/localization/jobs/from-extraction/{sourceJobId} | 
 
 
-# **get_api_extraction_projectkind_projectid_export**
-> bytes get_api_extraction_projectkind_projectid_export(project_kind, project_id, x_organization_id=x_organization_id)
+# **get_api_localization_jobs_localizationjobid**
+> LocalizationResponse get_api_localization_jobs_localizationjobid(localization_job_id, x_organization_id=x_organization_id)
 
-Exports a project as a zip archive.
+
+Retrieve the result of a completed localization job.
+
+The result follows the extraction's structure, with lists of `{page, bbox}` objects at leaves.
+`page` is a one-based document page number.
+`bbox` contains normalized `[x1, y1, x2, y2]` coordinates (0–1).
+
+Returns `200 OK` for a complete result or `206 Partial Content` with all available boxes,
+`discardedLocalizationItems` and `diagnostics` explaining any partial result.
+`400 JobNotCompleted` if pending or running; `403 QuotaExceeded` if the job failed its quota check.
+    
 
 ### Example
 
@@ -19,6 +29,7 @@ Exports a project as a zip archive.
 
 ```python
 import numind.openapi_client
+from numind.models.localization_response import LocalizationResponse
 from numind.openapi_client.rest import ApiException
 from pprint import pprint
 
@@ -36,22 +47,21 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 # Enter a context with an instance of the API client
 with numind.openapi_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = numind.openapi_client.ProjectImportExportApi(api_client)
-    project_kind = "project_kind_example"  # str | Project kind to export.
-    project_id = "project_id_example"  # str | Unique project identifier.
+    api_instance = numind.openapi_client.LocalizationApi(api_client)
+    localization_job_id = "localization_job_id_example"  # str |
     x_organization_id = "x_organization_id_example"  # str | Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. (optional)
 
     try:
-        api_response = api_instance.get_api_extraction_projectkind_projectid_export(
-            project_kind, project_id, x_organization_id=x_organization_id
+        api_response = api_instance.get_api_localization_jobs_localizationjobid(
+            localization_job_id, x_organization_id=x_organization_id
         )
         print(
-            "The response of ProjectImportExportApi->get_api_extraction_projectkind_projectid_export:\n"
+            "The response of LocalizationApi->get_api_localization_jobs_localizationjobid:\n"
         )
         pprint(api_response)
     except Exception as e:
         print(
-            "Exception when calling ProjectImportExportApi->get_api_extraction_projectkind_projectid_export: %s\n"
+            "Exception when calling LocalizationApi->get_api_localization_jobs_localizationjobid: %s\n"
             % e
         )
 ```
@@ -63,13 +73,12 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_kind** | **str**| Project kind to export. | 
- **project_id** | **str**| Unique project identifier. | 
+ **localization_job_id** | **str**|  | 
  **x_organization_id** | **str**| Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. | [optional] 
 
 ### Return type
 
-**bytes**
+[**LocalizationResponse**](LocalizationResponse.md)
 
 ### Authorization
 
@@ -78,22 +87,35 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/zip, text/plain, application/json
+ - **Accept**: application/json
 
 ### HTTP response details
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** |  |  * Content-Type -  <br>  * Content-Disposition -  <br>  * X-Filename -  <br>  |
-**400** | Invalid value for: path parameter projectKind |  -  |
-**0** |  |  -  |
+**200** | Job completed successfully. |  -  |
+**206** | Job completed with a partial result. |  -  |
+**400** | Invalid request or job not completed (JobNotCompleted). |  -  |
+**401** | Missing or invalid authentication. |  -  |
+**403** | Localization is disabled, access is denied, or quota is exceeded (QuotaExceeded). |  -  |
+**404** | Job, project or document not found in the active scope. |  -  |
+**409** | Localization job canceled (JobCanceled). |  -  |
+**429** | Localization job failed with a rate-limit error. |  -  |
+**500** | Localization job failed or timed out (JobTimeout), or its stored result is unreadable. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **post_api_extraction_import**
-> ImportProjectResponse post_api_extraction_import(body, x_organization_id=x_organization_id)
+# **post_api_localization_jobs_from_extraction_sourcejobid**
+> JobIdResponse post_api_localization_jobs_from_extraction_sourcejobid(source_job_id, x_organization_id=x_organization_id, low_priority=low_priority)
+
 
-Imports a project from a zip archive.
+Start localization inference from a completed structured extraction job, with or without a project.
+The extraction must have no partial error, and its document must contain image pages.
+Uses the source job's temperature, maxOutputTokens, loopDetection and randomSeed settings.
+
+Returns a `jobId`. Poll GET `/api/jobs/{jobId}/status`, then retrieve the completed result
+with GET `/api/localization/jobs/{jobId}`.
+    
 
 ### Example
 
@@ -101,7 +123,7 @@ Imports a project from a zip archive.
 
 ```python
 import numind.openapi_client
-from numind.models.import_project_response import ImportProjectResponse
+from numind.models.job_id_response import JobIdResponse
 from numind.openapi_client.rest import ApiException
 from pprint import pprint
 
@@ -119,19 +141,26 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 # Enter a context with an instance of the API client
 with numind.openapi_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = numind.openapi_client.ProjectImportExportApi(api_client)
-    body = None  # bytes |
+    api_instance = numind.openapi_client.LocalizationApi(api_client)
+    source_job_id = "source_job_id_example"  # str |
     x_organization_id = "x_organization_id_example"  # str | Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. (optional)
+    low_priority = False  # bool | Submit this job with lower scheduling priority in the job queue and inference engine. (optional) (default to False)
 
     try:
-        api_response = api_instance.post_api_extraction_import(
-            body, x_organization_id=x_organization_id
+        api_response = (
+            api_instance.post_api_localization_jobs_from_extraction_sourcejobid(
+                source_job_id,
+                x_organization_id=x_organization_id,
+                low_priority=low_priority,
+            )
+        )
+        print(
+            "The response of LocalizationApi->post_api_localization_jobs_from_extraction_sourcejobid:\n"
         )
-        print("The response of ProjectImportExportApi->post_api_extraction_import:\n")
         pprint(api_response)
     except Exception as e:
         print(
-            "Exception when calling ProjectImportExportApi->post_api_extraction_import: %s\n"
+            "Exception when calling LocalizationApi->post_api_localization_jobs_from_extraction_sourcejobid: %s\n"
             % e
         )
 ```
@@ -143,12 +172,13 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | **bytes**|  | 
+ **source_job_id** | **str**|  | 
  **x_organization_id** | **str**| Optional organization to use for this request.   No header means that the user personal account will be used.   This token is *only* used by the _frontend_ application and *will be ignored if used with the API*. When using the api, the organization used will be the one of the api key. | [optional] 
+ **low_priority** | **bool**| Submit this job with lower scheduling priority in the job queue and inference engine. | [optional] [default to False]
 
 ### Return type
 
-[**ImportProjectResponse**](ImportProjectResponse.md)
+[**JobIdResponse**](JobIdResponse.md)
 
 ### Authorization
 
@@ -156,16 +186,19 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/octet-stream
- - **Accept**: application/json, text/plain
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 ### HTTP response details
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: body |  -  |
-**0** |  |  -  |
+**400** | Invalid request or job not completed (JobNotCompleted). |  -  |
+**401** | Missing or invalid authentication. |  -  |
+**403** | Localization is disabled or access is denied. |  -  |
+**404** | Job, project or document not found in the active scope. |  -  |
+**500** | Invalid stored job data or internal error. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

numind-0.4.4/docs/LocalizationResponse.md

@@ -0,0 +1,37 @@
+# LocalizationResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**localization** | [**Dict[str, Optional[LocalizationValue]]**](LocalizationValue.md) | Localization groups. Each field contains a list of boxes with a one-based document page number and a bbox array of normalized [x1, y1, x2, y2] coordinates (0–1). | 
+**discarded_localization_items_count** | **int** | Number of localization validation errors. | 
+**discarded_localization_items** | [**List[DiscardedLocalizationItem]**](DiscardedLocalizationItem.md) | Localization validation errors, including invalid boxes and missing or unexpected fields. | [optional] 
+**diagnostics** | **List[str]** | Diagnostics explaining why results are partial. | [optional] 
+**input_tokens** | **int** | Input tokens used for localization inference, when available. | [optional] 
+**output_tokens** | **int** | Output tokens used for localization inference, when available. | [optional] 
+**raw_model_output** | **str** | Exact model content before localization post-processing. | 
+
+## Example
+
+```python
+from numind.models.localization_response import LocalizationResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of LocalizationResponse from a JSON string
+localization_response_instance = LocalizationResponse.from_json(json)
+# print the JSON string representation of the object
+print(LocalizationResponse.to_json())
+
+# convert the object into a dict
+localization_response_dict = localization_response_instance.to_dict()
+# create an instance of LocalizationResponse from a dict
+localization_response_from_dict = LocalizationResponse.from_dict(
+    localization_response_dict
+)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+