numind 0.2.2__tar.gz → 0.3.0__tar.gz

{numind-0.2.2 → numind-0.3.0}/.github/workflows/sdk-auto-update.yml

@@ -83,7 +83,7 @@ jobs:
         run: |
           set -e # Exit immediately if a command exits with a non-zero status.
           echo "Generating new SDK for version ${{ steps.fetch_version.outputs.version }}..."
-          sh sdk_generation/gen_sdk.sh
+          bash sdk_generation/gen_sdk.sh
 
       # Step 8: Create a Pull Request if there are any changes
       - name: Create Pull Request

{numind-0.2.2 → numind-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: numind
-Version: 0.2.2
+Version: 0.3.0
 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
@@ -45,6 +45,8 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9
 Requires-Dist: aiohttp-retry>=2.8.3
 Requires-Dist: aiohttp>=3.8.4
+Requires-Dist: jsonschema
+Requires-Dist: orjson
 Requires-Dist: pydantic>=2.11
 Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: typing-extensions>=4.7.1
@@ -334,7 +336,7 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 
 - API version: 
 - Package version: 1.0.0
-- Generator version: 7.21.0
+- Generator version: 7.22.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ### Documentation for API Endpoints
@@ -345,6 +347,7 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *ContentExtractionApi* | [**get_api_content_extraction_jobs_contentextractionjobid**](docs/ContentExtractionApi.md#get_api_content_extraction_jobs_contentextractionjobid) | **GET** /api/content-extraction/jobs/{contentExtractionJobId} | 
 *ContentExtractionApi* | [**post_api_content_extraction_jobs**](docs/ContentExtractionApi.md#post_api_content_extraction_jobs) | **POST** /api/content-extraction/jobs | 
+*ContentExtractionProjectManagementApi* | [**delete_api_content_extraction_contentprojectid**](docs/ContentExtractionProjectManagementApi.md#delete_api_content_extraction_contentprojectid) | **DELETE** /api/content-extraction/{contentProjectId} | 
 *ContentExtractionProjectManagementApi* | [**get_api_content_extraction**](docs/ContentExtractionProjectManagementApi.md#get_api_content_extraction) | **GET** /api/content-extraction | 
 *ContentExtractionProjectManagementApi* | [**patch_api_content_extraction_contentprojectid**](docs/ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid) | **PATCH** /api/content-extraction/{contentProjectId} | 
 *ContentExtractionProjectManagementApi* | [**patch_api_content_extraction_contentprojectid_settings**](docs/ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid_settings) | **PATCH** /api/content-extraction/{contentProjectId}/settings | 
@@ -381,6 +384,7 @@ Class | Method | HTTP request | Description
 *StructuredExtractionProjectManagementApi* | [**delete_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#delete_api_structured_extraction_structuredprojectid) | **DELETE** /api/structured-extraction/{structuredProjectId} | 
 *StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction) | **GET** /api/structured-extraction | 
 *StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction_structuredprojectid) | **GET** /api/structured-extraction/{structuredProjectId} | 
+*StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction_structuredprojectid_thumbnail**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction_structuredprojectid_thumbnail) | **GET** /api/structured-extraction/{structuredProjectId}/thumbnail | 
 *StructuredExtractionProjectManagementApi* | [**patch_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#patch_api_structured_extraction_structuredprojectid) | **PATCH** /api/structured-extraction/{structuredProjectId} | 
 *StructuredExtractionProjectManagementApi* | [**patch_api_structured_extraction_structuredprojectid_settings**](docs/StructuredExtractionProjectManagementApi.md#patch_api_structured_extraction_structuredprojectid_settings) | **PATCH** /api/structured-extraction/{structuredProjectId}/settings | 
 *StructuredExtractionProjectManagementApi* | [**post_api_structured_extraction**](docs/StructuredExtractionProjectManagementApi.md#post_api_structured_extraction) | **POST** /api/structured-extraction | 
@@ -414,10 +418,8 @@ Class | Method | HTTP request | Description
  - [InformationResponse](docs/InformationResponse.md)
  - [InvalidInformation](docs/InvalidInformation.md)
  - [JobIdResponse](docs/JobIdResponse.md)
- - [JobResponse](docs/JobResponse.md)
  - [JobStatusResponse](docs/JobStatusResponse.md)
- - [PaginatedResponseJobResponse](docs/PaginatedResponseJobResponse.md)
- - [PaginatedResponseStructuredExampleResponse](docs/PaginatedResponseStructuredExampleResponse.md)
+ - [PaginatedResponseT](docs/PaginatedResponseT.md)
  - [ServiceStatus](docs/ServiceStatus.md)
  - [StructuredExampleResponse](docs/StructuredExampleResponse.md)
  - [StructuredExtractionResponse](docs/StructuredExtractionResponse.md)

{numind-0.2.2 → numind-0.3.0}/README.md

@@ -271,7 +271,7 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 
 - API version: 
 - Package version: 1.0.0
-- Generator version: 7.21.0
+- Generator version: 7.22.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ### Documentation for API Endpoints
@@ -282,6 +282,7 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *ContentExtractionApi* | [**get_api_content_extraction_jobs_contentextractionjobid**](docs/ContentExtractionApi.md#get_api_content_extraction_jobs_contentextractionjobid) | **GET** /api/content-extraction/jobs/{contentExtractionJobId} | 
 *ContentExtractionApi* | [**post_api_content_extraction_jobs**](docs/ContentExtractionApi.md#post_api_content_extraction_jobs) | **POST** /api/content-extraction/jobs | 
+*ContentExtractionProjectManagementApi* | [**delete_api_content_extraction_contentprojectid**](docs/ContentExtractionProjectManagementApi.md#delete_api_content_extraction_contentprojectid) | **DELETE** /api/content-extraction/{contentProjectId} | 
 *ContentExtractionProjectManagementApi* | [**get_api_content_extraction**](docs/ContentExtractionProjectManagementApi.md#get_api_content_extraction) | **GET** /api/content-extraction | 
 *ContentExtractionProjectManagementApi* | [**patch_api_content_extraction_contentprojectid**](docs/ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid) | **PATCH** /api/content-extraction/{contentProjectId} | 
 *ContentExtractionProjectManagementApi* | [**patch_api_content_extraction_contentprojectid_settings**](docs/ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid_settings) | **PATCH** /api/content-extraction/{contentProjectId}/settings | 
@@ -318,6 +319,7 @@ Class | Method | HTTP request | Description
 *StructuredExtractionProjectManagementApi* | [**delete_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#delete_api_structured_extraction_structuredprojectid) | **DELETE** /api/structured-extraction/{structuredProjectId} | 
 *StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction) | **GET** /api/structured-extraction | 
 *StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction_structuredprojectid) | **GET** /api/structured-extraction/{structuredProjectId} | 
+*StructuredExtractionProjectManagementApi* | [**get_api_structured_extraction_structuredprojectid_thumbnail**](docs/StructuredExtractionProjectManagementApi.md#get_api_structured_extraction_structuredprojectid_thumbnail) | **GET** /api/structured-extraction/{structuredProjectId}/thumbnail | 
 *StructuredExtractionProjectManagementApi* | [**patch_api_structured_extraction_structuredprojectid**](docs/StructuredExtractionProjectManagementApi.md#patch_api_structured_extraction_structuredprojectid) | **PATCH** /api/structured-extraction/{structuredProjectId} | 
 *StructuredExtractionProjectManagementApi* | [**patch_api_structured_extraction_structuredprojectid_settings**](docs/StructuredExtractionProjectManagementApi.md#patch_api_structured_extraction_structuredprojectid_settings) | **PATCH** /api/structured-extraction/{structuredProjectId}/settings | 
 *StructuredExtractionProjectManagementApi* | [**post_api_structured_extraction**](docs/StructuredExtractionProjectManagementApi.md#post_api_structured_extraction) | **POST** /api/structured-extraction | 
@@ -351,10 +353,8 @@ Class | Method | HTTP request | Description
  - [InformationResponse](docs/InformationResponse.md)
  - [InvalidInformation](docs/InvalidInformation.md)
  - [JobIdResponse](docs/JobIdResponse.md)
- - [JobResponse](docs/JobResponse.md)
  - [JobStatusResponse](docs/JobStatusResponse.md)
- - [PaginatedResponseJobResponse](docs/PaginatedResponseJobResponse.md)
- - [PaginatedResponseStructuredExampleResponse](docs/PaginatedResponseStructuredExampleResponse.md)
+ - [PaginatedResponseT](docs/PaginatedResponseT.md)
  - [ServiceStatus](docs/ServiceStatus.md)
  - [StructuredExampleResponse](docs/StructuredExampleResponse.md)
  - [StructuredExtractionResponse](docs/StructuredExtractionResponse.md)

{numind-0.2.2 → numind-0.3.0}/docs/ContentExtractionApi.md

@@ -94,13 +94,17 @@ 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, temperature=temperature, rasterization_dpi=rasterization_dpi, max_output_tokens=max_output_tokens, 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, timeout=timeout)
 
 
  Extract content from the provided file in markdown format as an async job.
  The response contains extracted markdown together with the reasoning trace.
  The model only accepts images. Therefore, some files are converted to images -
  the **rasterizationDPI** parameter controls their resolution.
+ Parameter resolution order:
+ - `temperature`: request value -> project setting (when `projectId` is provided) -> platform default
+ - `rasterizationDPI`: request value -> project setting (when `projectId` is provided) -> platform default
+ - `maxOutputTokens`: request value -> project setting (when `projectId` is provided) -> platform default
 
 
 #### Response:
@@ -141,13 +145,15 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     api_instance = numind.openapi_client.ContentExtractionApi(api_client)
     file = None # bytes | 
     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)
-    temperature = 3.4 # float | Model temperature (optional). Controls output diversity.  Ranges between 0 and 1. If not specified, the default value 0.0 is used. (optional)
-    rasterization_dpi = 56 # int | Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch (optional).   Ranges between 1 and 300. If not specified, the default value 170 dpi is used. (optional)
-    max_output_tokens = 56 # int | Maximum number of output tokens (optional). Must be positive. Set to 0 for no limit by default. (optional)
+    project_id = 'project_id_example' # str | Optional content project identifier. When provided, project settings are used as fallback for inference parameters; this identifier is also attached to usage and billing events. (optional)
+    temperature = 3.4 # float | Model temperature (optional). Controls output diversity.  Ranges between 0 and 1. Resolution order: request `temperature` -> project setting (when `projectId` is provided) -> default 0.0. (optional)
+    rasterization_dpi = 56 # int | Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch (optional).   Ranges between 1 and 300. Resolution order: request `rasterizationDPI` -> project setting (when `projectId` is provided) -> default 170 dpi. (optional)
+    max_output_tokens = 56 # int | Maximum number of output tokens (optional). Must be positive. Resolution order: request `maxOutputTokens` -> project setting (when `projectId` is provided) -> default 0. Set to 0 for no limit. (optional)
+    enable_thinking = True # bool | Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default true. (optional)
     timeout = 'timeout_example' # str | Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h (optional)
 
     try:
-        api_response = api_instance.post_api_content_extraction_jobs(file, x_organization_id=x_organization_id, temperature=temperature, rasterization_dpi=rasterization_dpi, max_output_tokens=max_output_tokens, timeout=timeout)
+        api_response = api_instance.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, timeout=timeout)
         print("The response of ContentExtractionApi->post_api_content_extraction_jobs:\n")
         pprint(api_response)
     except Exception as e:
@@ -163,9 +169,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **file** | **bytes**|  | 
  **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] 
- **temperature** | **float**| Model temperature (optional). Controls output diversity.  Ranges between 0 and 1. If not specified, the default value 0.0 is used. | [optional] 
- **rasterization_dpi** | **int**| Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch (optional).   Ranges between 1 and 300. If not specified, the default value 170 dpi is used. | [optional] 
- **max_output_tokens** | **int**| Maximum number of output tokens (optional). Must be positive. Set to 0 for no limit by default. | [optional] 
+ **project_id** | **str**| Optional content project identifier. When provided, project settings are used as fallback for inference parameters; this identifier is also attached to usage and billing events. | [optional] 
+ **temperature** | **float**| Model temperature (optional). Controls output diversity.  Ranges between 0 and 1. Resolution order: request `temperature` -> project setting (when `projectId` is provided) -> default 0.0. | [optional] 
+ **rasterization_dpi** | **int**| Resolution used to convert formatted documents (PDFs, etc.) to images, in dot per inch (optional).   Ranges between 1 and 300. Resolution order: request `rasterizationDPI` -> project setting (when `projectId` is provided) -> default 170 dpi. | [optional] 
+ **max_output_tokens** | **int**| Maximum number of output tokens (optional). Must be positive. Resolution order: request `maxOutputTokens` -> project setting (when `projectId` is provided) -> default 0. Set to 0 for no limit. | [optional] 
+ **enable_thinking** | **bool**| Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default true. | [optional] 
  **timeout** | **str**| Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
 
 ### Return type
@@ -186,7 +194,7 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter rasterizationDPI, Invalid value for: query parameter maxOutputTokens, Invalid value for: body |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter rasterizationDPI, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter enableThinking, Invalid value for: body |  -  |
 **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.2.2 → numind-0.3.0}/docs/ContentExtractionProjectManagementApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://nuextract.ai*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_api_content_extraction_contentprojectid**](ContentExtractionProjectManagementApi.md#delete_api_content_extraction_contentprojectid) | **DELETE** /api/content-extraction/{contentProjectId} | 
 [**get_api_content_extraction**](ContentExtractionProjectManagementApi.md#get_api_content_extraction) | **GET** /api/content-extraction | 
 [**patch_api_content_extraction_contentprojectid**](ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid) | **PATCH** /api/content-extraction/{contentProjectId} | 
 [**patch_api_content_extraction_contentprojectid_settings**](ContentExtractionProjectManagementApi.md#patch_api_content_extraction_contentprojectid_settings) | **PATCH** /api/content-extraction/{contentProjectId}/settings | 
@@ -11,6 +12,80 @@ Method | HTTP request | Description
 [**post_api_content_extraction_contentprojectid_reset_settings**](ContentExtractionProjectManagementApi.md#post_api_content_extraction_contentprojectid_reset_settings) | **POST** /api/content-extraction/{contentProjectId}/reset-settings | 
 
 
+# **delete_api_content_extraction_contentprojectid**
+> delete_api_content_extraction_contentprojectid(content_project_id, x_organization_id=x_organization_id)
+
+
+Delete a **Content Extraction Project**. This action cannot be undone.
+    
+
+### Example
+
+* OAuth Authentication (oauth2Auth):
+
+```python
+import numind.openapi_client
+from numind.openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://nuextract.ai
+# See configuration.py for a list of all supported configuration parameters.
+configuration = numind.openapi_client.Configuration(
+    host = "https://nuextract.ai"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+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.ContentExtractionProjectManagementApi(api_client)
+    content_project_id = 'content_project_id_example' # str | Unique content extraction project 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)
+
+    try:
+        api_instance.delete_api_content_extraction_contentprojectid(content_project_id, x_organization_id=x_organization_id)
+    except Exception as e:
+        print("Exception when calling ContentExtractionProjectManagementApi->delete_api_content_extraction_contentprojectid: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_project_id** | **str**| Unique content extraction project 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] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[oauth2Auth](../README.md#oauth2Auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** |  |  -  |
+**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)
+
 # **get_api_content_extraction**
 > List[ContentProjectResponse] get_api_content_extraction(x_organization_id=x_organization_id)
 
@@ -212,7 +287,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = numind.openapi_client.ContentExtractionProjectManagementApi(api_client)
     content_project_id = 'content_project_id_example' # str | Unique content extraction project identifier.
-    update_content_project_settings_request = {"temperature":0,"rasterizationDPI":170,"maxOutputTokens":0} # UpdateContentProjectSettingsRequest | 
+    update_content_project_settings_request = {"temperature":0,"rasterizationDPI":170,"maxOutputTokens":0,"enableThinking":true} # UpdateContentProjectSettingsRequest | 
     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:

{numind-0.2.2 → numind-0.3.0}/docs/ContentProjectSettingsResponse.md

@@ -8,7 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **temperature** | **float** | Model temperature. | 
 **rasterization_dpi** | **int** | Resolution used to convert formatted documents to images. | 
-**max_output_tokens** | **int** | Maximum number of output tokens (optional). Must be positive. Set to 0 for no limit. | 
+**max_output_tokens** | **int** | Maximum number of output tokens. Must be positive. Set to 0 for no limit. | 
+**enable_thinking** | **bool** | Enable thinking/reasoning. | 
 
 ## Example
 

{numind-0.2.2 → numind-0.3.0}/docs/DocumentResponse.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **doc_info** | [**DocumentInfo**](DocumentInfo.md) | Basic document information. | 
 **owner_user** | **str** | Document owner. | 
 **owner_organization** | **str** | Document owning organization (if any). | [optional] 
-**content_type** | **str** | Mime type of the document. | 
 **created_at** | **str** | Document creation date. | 
 
 ## Example

{numind-0.2.2 → numind-0.3.0}/docs/DocumentsApi.md

@@ -170,7 +170,7 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** |  |  * Content-Type - MIME type of document content <br>  * Cache-Control -  <br>  |
+**200** |  |  * Content-Type - MIME type of the thumbnail image <br>  * Cache-Control -  <br>  |
 **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.2.2 → numind-0.3.0}/docs/FileResponse.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **file_name** | **str** | Filename of the initial file. | [optional] 
 **owner_user** | **str** | File owner. | 
 **owner_organization** | **str** | File owning organization (if any). | [optional] 
-**content_type** | **str** | Mime type of the file. | 
 **created_at** | **str** | File creation date. | 
 
 ## Example

{numind-0.2.2 → numind-0.3.0}/docs/FilesApi.md

@@ -168,7 +168,7 @@ Name | Type | Description  | Notes
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** |  |  * Content-Type - MIME type of document content <br>  |
+**200** |  |  * Content-Type - MIME type of the thumbnail image <br>  |
 **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.2.2 → numind-0.3.0}/docs/InferenceApi.md

@@ -16,7 +16,10 @@ Method | HTTP request | Description
 
 
  Extract content from the provided document in markdown format as an async job.
- Inference **temperature** can be set in the project settings.
+ Inference parameters are resolved from the project settings first, then platform defaults when absent:
+ - `temperature`: project setting -> platform default
+ - `maxOutputTokens`: project setting -> platform default
+ - `rasterizationDPI`: project setting -> platform default (used only when document conversion is needed upstream)
 
 #### Response:
  Returns a JSON containing the job ID that can be used to retrieve the job status and results.
@@ -108,7 +111,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_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, 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, timeout=timeout)
 
 
  Performs structured information extraction inference on the provided document as an async job.
@@ -166,10 +169,11 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     max_example_token_number = 56 # int | Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. (optional)
     max_example_number = 56 # int | Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. (optional)
     min_example_similarity = 3.4 # float | Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. (optional)
+    enable_thinking = True # bool | Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. (optional)
     timeout = 'timeout_example' # str | Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h (optional)
 
     try:
-        api_response = api_instance.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, timeout=timeout)
+        api_response = api_instance.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, timeout=timeout)
         print("The response of InferenceApi->post_api_structured_extraction_structuredprojectid_jobs_document_documentid:\n")
         pprint(api_response)
     except Exception as e:
@@ -191,6 +195,7 @@ Name | Type | Description  | Notes
  **max_example_token_number** | **int**| Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. | [optional] 
  **max_example_number** | **int**| Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. | [optional] 
  **min_example_similarity** | **float**| Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. | [optional] 
+ **enable_thinking** | **bool**| Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. | [optional] 
  **timeout** | **str**| Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
 
 ### Return type
@@ -211,13 +216,13 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: query parameter enableThinking |  -  |
 **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_text**
-> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs_text(structured_project_id, text_request, 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, timeout=timeout)
+> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs_text(structured_project_id, text_request, 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, timeout=timeout)
 
 
  Performs structured information extraction inference on the provided text as an async job.
@@ -277,10 +282,11 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     max_example_token_number = 56 # int | Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. (optional)
     max_example_number = 56 # int | Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. (optional)
     min_example_similarity = 3.4 # float | Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. (optional)
+    enable_thinking = True # bool | Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. (optional)
     timeout = 'timeout_example' # str | Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h (optional)
 
     try:
-        api_response = api_instance.post_api_structured_extraction_structuredprojectid_jobs_text(structured_project_id, text_request, 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, timeout=timeout)
+        api_response = api_instance.post_api_structured_extraction_structuredprojectid_jobs_text(structured_project_id, text_request, 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, timeout=timeout)
         print("The response of InferenceApi->post_api_structured_extraction_structuredprojectid_jobs_text:\n")
         pprint(api_response)
     except Exception as e:
@@ -302,6 +308,7 @@ Name | Type | Description  | Notes
  **max_example_token_number** | **int**| Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. | [optional] 
  **max_example_number** | **int**| Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. | [optional] 
  **min_example_similarity** | **float**| Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. | [optional] 
+ **enable_thinking** | **bool**| Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. | [optional] 
  **timeout** | **str**| Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
 
 ### Return type
@@ -322,7 +329,7 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: body |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: query parameter enableThinking, Invalid value for: body |  -  |
 **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.2.2 → numind-0.3.0}/docs/JobsApi.md

@@ -10,7 +10,7 @@ Method | HTTP request | Description
 
 
 # **get_api_jobs**
-> PaginatedResponseJobResponse get_api_jobs(x_organization_id=x_organization_id, organization=organization, skip=skip, per_page=per_page)
+> PaginatedResponseT get_api_jobs(x_organization_id=x_organization_id, organization=organization, skip=skip, per_page=per_page)
 
 
  List all jobs for the authenticated user with pagination support.
@@ -25,7 +25,7 @@ Method | HTTP request | Description
 
 ```python
 import numind.openapi_client
-from numind.models.paginated_response_job_response import PaginatedResponseJobResponse
+from numind.models.paginated_response_t import PaginatedResponseT
 from numind.openapi_client.rest import ApiException
 from pprint import pprint
 
@@ -73,7 +73,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**PaginatedResponseJobResponse**](PaginatedResponseJobResponse.md)
+[**PaginatedResponseT**](PaginatedResponseT.md)
 
 ### Authorization
 

numind-0.3.0/docs/PaginatedResponseT.md

@@ -0,0 +1,32 @@
+# PaginatedResponseT
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **int** | Total number of items available. | 
+**skip** | **int** | Number of items skipped. | 
+**per_page** | **int** | Number of items per page. | 
+**items** | [**List[StructuredExampleResponse]**](StructuredExampleResponse.md) | List of items. | [optional] 
+
+## Example
+
+```python
+from numind.models.paginated_response_t import PaginatedResponseT
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PaginatedResponseT from a JSON string
+paginated_response_t_instance = PaginatedResponseT.from_json(json)
+# print the JSON string representation of the object
+print(PaginatedResponseT.to_json())
+
+# convert the object into a dict
+paginated_response_t_dict = paginated_response_t_instance.to_dict()
+# create an instance of PaginatedResponseT from a dict
+paginated_response_t_from_dict = PaginatedResponseT.from_dict(paginated_response_t_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.2.2 → numind-0.3.0}/docs/StructuredDataExtractionApi.md

@@ -95,7 +95,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_structured_extraction_structuredprojectid_jobs**
-> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, temperature=temperature, dpi=dpi, 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, timeout=timeout)
+> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, temperature=temperature, dpi=dpi, 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, timeout=timeout)
 
 
  Extract structured information from the provided text or file as an async job. Some files are converted to images -
@@ -154,10 +154,11 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
     max_example_token_number = 56 # int | Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. (optional)
     max_example_number = 56 # int | Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. (optional)
     min_example_similarity = 3.4 # float | Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. (optional)
+    enable_thinking = True # bool | Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. (optional)
     timeout = 'timeout_example' # str | Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h (optional)
 
     try:
-        api_response = api_instance.post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, temperature=temperature, dpi=dpi, 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, timeout=timeout)
+        api_response = api_instance.post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, temperature=temperature, dpi=dpi, 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, timeout=timeout)
         print("The response of StructuredDataExtractionApi->post_api_structured_extraction_structuredprojectid_jobs:\n")
         pprint(api_response)
     except Exception as e:
@@ -180,6 +181,7 @@ Name | Type | Description  | Notes
  **max_example_token_number** | **int**| Controls the maximum number of tokens that can be allocated to the examples.  Must be positive. Ranges in the context window of the model. | [optional] 
  **max_example_number** | **int**| Controls the maximum number of examples to use.  Must be positive. Set to 0 for no limit. | [optional] 
  **min_example_similarity** | **float**| Controls the minimum similarity between the document and the examples.  Must be between 0 and 1. Set to 0 for any similarity and 1 for exact match. | [optional] 
+ **enable_thinking** | **bool**| Enable thinking/reasoning (optional). Resolution order: request `enableThinking` -> project setting (when `projectId` is provided) -> default false. | [optional] 
  **timeout** | **str**| Max time to wait for the processing completion.   Format examples: 1000ms, 10s, 1m, 1h | [optional] 
 
 ### Return type
@@ -200,7 +202,7 @@ Name | Type | Description  | Notes
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** |  |  -  |
-**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter dpi, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: body |  -  |
+**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter dpi, Invalid value for: query parameter maxOutputTokens, Invalid value for: query parameter maxExampleTokenNumber, Invalid value for: query parameter maxExampleNumber, Invalid value for: query parameter minExampleSimilarity, Invalid value for: query parameter enableThinking, Invalid value for: body |  -  |
 **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.2.2 → numind-0.3.0}/docs/StructuredExtractionExamplesApi.md

@@ -95,7 +95,7 @@ void (empty response body)
 [[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)
 
 # **get_api_structured_extraction_structuredprojectid_examples**
-> PaginatedResponseStructuredExampleResponse get_api_structured_extraction_structuredprojectid_examples(structured_project_id, x_organization_id=x_organization_id, skip=skip, per_page=per_page)
+> PaginatedResponseT get_api_structured_extraction_structuredprojectid_examples(structured_project_id, x_organization_id=x_organization_id, skip=skip, per_page=per_page)
 
 
 Return a list of **Examples** associated to the specified **Structured Extraction Project** with pagination support.
@@ -112,7 +112,7 @@ Return a list of **Examples** associated to the specified **Structured Extractio
 
 ```python
 import numind.openapi_client
-from numind.models.paginated_response_structured_example_response import PaginatedResponseStructuredExampleResponse
+from numind.models.paginated_response_t import PaginatedResponseT
 from numind.openapi_client.rest import ApiException
 from pprint import pprint
 
@@ -160,7 +160,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**PaginatedResponseStructuredExampleResponse**](PaginatedResponseStructuredExampleResponse.md)
+[**PaginatedResponseT**](PaginatedResponseT.md)
 
 ### Authorization