numind 0.4.1__tar.gz → 0.4.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {numind-0.4.1 → numind-0.4.2}/PKG-INFO +2 -1
- {numind-0.4.1 → numind-0.4.2}/README.md +1 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ContentExtractionApi.md +11 -7
- {numind-0.4.1 → numind-0.4.2}/docs/ContentExtractionProjectManagementApi.md +8 -6
- {numind-0.4.1 → numind-0.4.2}/docs/ContentExtractionResponse.md +1 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ContentProjectSettingsResponse.md +3 -2
- numind-0.4.2/docs/ContentProjectSettingsResponseImageWidth.md +39 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ContentSettingsPatch.md +3 -2
- {numind-0.4.1 → numind-0.4.2}/docs/ConvertRequest.md +1 -0
- {numind-0.4.1 → numind-0.4.2}/docs/FilesApi.md +7 -2
- {numind-0.4.1 → numind-0.4.2}/docs/InferenceApi.md +18 -12
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredDataExtractionApi.md +30 -21
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredExtractionProjectManagementApi.md +12 -7
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredExtractionResponse.md +1 -0
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredProjectSettingsResponse.md +4 -3
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredSettingsPatch.md +4 -3
- {numind-0.4.1 → numind-0.4.2}/docs/TemplateGenerationApi.md +14 -8
- {numind-0.4.1 → numind-0.4.2}/pyproject.toml +1 -1
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/pyproject_base.toml +1 -1
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/__init__.py +3 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content_extraction_response.py +15 -1
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content_project_settings_response.py +18 -5
- numind-0.4.2/src/numind/models/content_project_settings_response_image_width.py +162 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content_settings_patch.py +20 -5
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/convert_request.py +17 -1
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_extraction_response.py +15 -1
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_project_settings_response.py +20 -7
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_settings_patch.py +22 -7
- {numind-0.4.1 → numind-0.4.2}/src/numind/numind.py +18 -13
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/__init__.py +4 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/content_extraction_api.py +61 -30
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/content_extraction_project_management_api.py +6 -6
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/files_api.py +3 -3
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/inference_api.py +110 -48
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/structured_data_extraction_api.py +140 -78
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/structured_extraction_project_management_api.py +6 -6
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/template_generation_api.py +86 -24
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/__init__.py +4 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/content_extraction_api.py +61 -30
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/content_extraction_project_management_api.py +6 -6
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/files_api.py +3 -3
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/inference_api.py +110 -48
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/structured_data_extraction_api.py +140 -78
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/structured_extraction_project_management_api.py +6 -6
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/template_generation_api.py +86 -24
- {numind-0.4.1 → numind-0.4.2}/tests/conftest.py +1 -1
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_content.py +8 -6
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_content_extraction_response.py +3 -1
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_content_project_response.py +8 -6
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_content_project_settings_response.py +7 -5
- numind-0.4.2/tests/openapi_client/test_content_project_settings_response_image_width.py +55 -0
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_content_settings_patch.py +4 -3
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_convert_request.py +3 -1
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_import_project_response.py +10 -8
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_structured.py +10 -8
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_extraction_response.py +3 -1
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_structured_project_response.py +10 -8
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_project_settings_response.py +9 -7
- {numind-0.4.1/tests/openapi_client_async → numind-0.4.2/tests/openapi_client}/test_structured_settings_patch.py +5 -4
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_content.py +8 -6
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_content_extraction_response.py +3 -1
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_content_project_response.py +8 -6
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_content_project_settings_response.py +7 -5
- numind-0.4.2/tests/openapi_client_async/test_content_project_settings_response_image_width.py +55 -0
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_content_settings_patch.py +4 -3
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_convert_request.py +3 -1
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_import_project_response.py +10 -8
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_structured.py +10 -8
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_extraction_response.py +3 -1
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_structured_project_response.py +10 -8
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_project_settings_response.py +9 -7
- {numind-0.4.1/tests/openapi_client → numind-0.4.2/tests/openapi_client_async}/test_structured_settings_patch.py +5 -4
- {numind-0.4.1 → numind-0.4.2}/tests/test_extract_structured_data.py +35 -12
- {numind-0.4.1 → numind-0.4.2}/tests/test_project.py +10 -3
- {numind-0.4.1 → numind-0.4.2}/.github/codecov.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/dependabot.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/workflows/lint.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/workflows/publish-pypi.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/workflows/sdk-auto-update.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/workflows/tests.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.github/workflows/update-api-build-version-repo-var.yml +0 -0
- {numind-0.4.1 → numind-0.4.2}/.gitignore +0 -0
- {numind-0.4.1 → numind-0.4.2}/LICENSE +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/Content.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ContentProjectResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ContentProjectSettingsResponseRasterizationDPI.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/CreateContentProjectRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/CreateOrUpdateStructuredExampleRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/CreateStructuredProjectRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/DefaultApi.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/DocumentInfo.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/DocumentResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/DocumentsApi.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/Error.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/FileResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/HealthResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ImageInfo.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ImportProjectResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/InferenceStatus.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/InferenceStatusResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/InferenceValidationError.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/InformationResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/InvalidInformation.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/JobIdResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/JobReportResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/JobStatusResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/JobsApi.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/PaginatedResponseT.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/PostProcessingErrorResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/PostProcessingRepairResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/PostProcessingReportResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ProjectImportExportApi.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ReferenceProjectResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ServiceStatus.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/Structured.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredExampleResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredExtractionExamplesApi.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredInferenceExample.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/StructuredProjectResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/TemplateRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/TemplateResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/TextInfo.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/TextRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/UpdateContentProjectRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/UpdateStructuredProjectRequest.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/ValidInformation.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/docs/VersionResponse.md +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/.openapi-generator-ignore +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/adapt_openapi_client_init.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/adapt_pyproject.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/collate_documentation_readme.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/config.json +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/gen_sdk.sh +0 -0
- {numind-0.4.1 → numind-0.4.2}/sdk_generation/remove_unused_models_from_openapi_spec_file.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/api_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/constants.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/exceptions.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/content_project_settings_response_rasterization_dpi.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/create_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/create_or_update_structured_example_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/create_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/document_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/document_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/file_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/health_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/image_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/import_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/inference_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/inference_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/inference_validation_error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/information_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/invalid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/job_id_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/job_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/job_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/paginated_response_t.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/post_processing_error_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/post_processing_repair_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/post_processing_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/reference_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/service_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_example_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_inference_example.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/structured_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/template_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/template_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/text_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/text_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/update_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/update_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/valid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/models/version_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/CLDR likelySubtags.xml +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/CLDR supplementalData.xml +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/IANA language subtag registry.txt +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/IANA tlds.txt +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ISO 15924.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ISO 3166-1.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ISO 3166-2.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ISO 4217 list-one.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ISO 4217 list-three.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/iso-639-3.tab +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/iso-639-3_Retirements.tab +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/_iso_data/ucum-essence.xml +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/constants.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/data_correction.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/data_validation.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/models.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/_utils.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/base.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/bic.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/country.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/currency.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/date_time.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/duration.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/email_address.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/geolocation.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/iban.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/integer.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/language.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/language_tag.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/number.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/phone_number.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/region.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/rfc3987.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/script.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/string_.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/unit_code.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/url.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/types/verbatim_string.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/data_validation/utils.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/template_conversion/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/template_conversion/constants.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/template_conversion/json_schema.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/template_conversion/pydantic.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/nuextract_utils/template_conversion/validation.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/default_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/documents_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/jobs_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/project_import_export_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api/structured_extraction_examples_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/api_client.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/configuration.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/py.typed +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client/rest.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/default_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/documents_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/jobs_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/project_import_export_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api/structured_extraction_examples_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/api_client.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/configuration.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/py.typed +0 -0
- {numind-0.4.1 → numind-0.4.2}/src/numind/openapi_client_async/rest.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/json_schema_test_cases/1.json +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/nuextract_utils/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/nuextract_utils/test_error_detection.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/nuextract_utils/test_optional_dependencies.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_content_extraction_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_content_extraction_project_management_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_content_project_settings_response_rasterization_dpi.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_create_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_create_or_update_structured_example_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_create_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_default_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_document_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_document_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_documents_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_file_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_files_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_health_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_image_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_inference_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_inference_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_inference_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_inference_validation_error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_information_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_invalid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_job_id_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_job_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_job_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_jobs_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_paginated_response_t.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_post_processing_error_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_post_processing_repair_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_post_processing_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_project_import_export_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_reference_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_service_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_data_extraction_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_example_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_extraction_examples_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_extraction_project_management_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_structured_inference_example.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_template_generation_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_template_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_template_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_text_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_text_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_update_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_update_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_valid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client/test_version_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/__init__.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_content_extraction_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_content_extraction_project_management_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_content_project_settings_response_rasterization_dpi.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_create_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_create_or_update_structured_example_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_create_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_default_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_document_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_document_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_documents_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_file_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_files_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_health_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_image_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_inference_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_inference_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_inference_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_inference_validation_error.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_information_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_invalid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_job_id_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_job_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_job_status_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_jobs_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_paginated_response_t.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_post_processing_error_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_post_processing_repair_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_post_processing_report_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_project_import_export_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_reference_project_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_service_status.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_data_extraction_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_example_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_extraction_examples_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_extraction_project_management_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_structured_inference_example.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_template_generation_api.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_template_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_template_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_text_info.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_text_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_update_content_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_update_structured_project_request.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_valid_information.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/openapi_client_async/test_version_response.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_cases/vacation/examples.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_cases/vacation/files/tahiti.docx +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_cases/vacation/files_examples/kyoto.docx +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_cases/vacation/schema.json +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_cases/vacation/texts.csv +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_conversion_json_schema.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_conversion_pydantic.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_json_schema_descriptions.py +0 -0
- {numind-0.4.1 → numind-0.4.2}/tests/test_numarkdown.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: numind
|
|
3
|
-
Version: 0.4.
|
|
3
|
+
Version: 0.4.2
|
|
4
4
|
Summary: SDK to interact with the NuMind models API.
|
|
5
5
|
Project-URL: Homepage, https://github.com/numindai/nuextract-platform-sdk
|
|
6
6
|
Project-URL: Repository, https://github.com/numindai/nuextract-platform-sdk.git
|
|
@@ -441,6 +441,7 @@ Class | Method | HTTP request | Description
|
|
|
441
441
|
- [ContentExtractionResponse](docs/ContentExtractionResponse.md)
|
|
442
442
|
- [ContentProjectResponse](docs/ContentProjectResponse.md)
|
|
443
443
|
- [ContentProjectSettingsResponse](docs/ContentProjectSettingsResponse.md)
|
|
444
|
+
- [ContentProjectSettingsResponseImageWidth](docs/ContentProjectSettingsResponseImageWidth.md)
|
|
444
445
|
- [ContentProjectSettingsResponseRasterizationDPI](docs/ContentProjectSettingsResponseRasterizationDPI.md)
|
|
445
446
|
- [ContentSettingsPatch](docs/ContentSettingsPatch.md)
|
|
446
447
|
- [ConvertRequest](docs/ConvertRequest.md)
|
|
@@ -365,6 +365,7 @@ Class | Method | HTTP request | Description
|
|
|
365
365
|
- [ContentExtractionResponse](docs/ContentExtractionResponse.md)
|
|
366
366
|
- [ContentProjectResponse](docs/ContentProjectResponse.md)
|
|
367
367
|
- [ContentProjectSettingsResponse](docs/ContentProjectSettingsResponse.md)
|
|
368
|
+
- [ContentProjectSettingsResponseImageWidth](docs/ContentProjectSettingsResponseImageWidth.md)
|
|
368
369
|
- [ContentProjectSettingsResponseRasterizationDPI](docs/ContentProjectSettingsResponseRasterizationDPI.md)
|
|
369
370
|
- [ContentSettingsPatch](docs/ContentSettingsPatch.md)
|
|
370
371
|
- [ConvertRequest](docs/ConvertRequest.md)
|
|
@@ -16,6 +16,7 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
#### Response:
|
|
18
18
|
Returns a markdown string representing the extracted content.
|
|
19
|
+
`isTruncated` is true when at least one document part stops at a token limit; the combined result may be incomplete.
|
|
19
20
|
|
|
20
21
|
#### Error Responses:
|
|
21
22
|
`404 Not Found` - If a content extraction job with the specified ID does not exist.
|
|
@@ -101,7 +102,7 @@ Name | Type | Description | Notes
|
|
|
101
102
|
[[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)
|
|
102
103
|
|
|
103
104
|
# **post_api_content_extraction_jobs**
|
|
104
|
-
> 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, timeout=timeout)
|
|
105
|
+
> 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)
|
|
105
106
|
|
|
106
107
|
|
|
107
108
|
Extract content from the provided file in markdown format as an async job.
|
|
@@ -121,7 +122,7 @@ Name | Type | Description | Notes
|
|
|
121
122
|
#### Settings:
|
|
122
123
|
Request settings override the project settings when `projectId` is provided; otherwise omitted settings use platform defaults.
|
|
123
124
|
Platform defaults: temperature 0.8, rasterization DPI `automatic`,
|
|
124
|
-
output token budget
|
|
125
|
+
output token budget 20000, thinking enabled, thinking token budget 15000,
|
|
125
126
|
loop detection enabled, and random seed `2022`.
|
|
126
127
|
|
|
127
128
|
|
|
@@ -155,13 +156,14 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
155
156
|
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)
|
|
156
157
|
temperature = 3.4 # float | Model temperature. Controls output diversity. Ranges between 0 and 2. (optional)
|
|
157
158
|
rasterization_dpi = "rasterization_dpi_example" # str | Resolution used to convert formatted documents (PDFs, etc.) to images, in dots per inch. Use 'automatic' or an integer between 1 and 600. Numeric strings are also accepted. Ignored for files that are already images or text. (optional)
|
|
158
|
-
max_output_tokens =
|
|
159
|
+
max_output_tokens = "max_output_tokens_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
159
160
|
enable_thinking = True # bool | Enable thinking/reasoning. (optional)
|
|
160
|
-
thinking_token_budget =
|
|
161
|
+
thinking_token_budget = "thinking_token_budget_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
161
162
|
loop_detection = (
|
|
162
163
|
True # bool | Stop the generation when the model repeats itself. (optional)
|
|
163
164
|
)
|
|
164
165
|
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)
|
|
166
|
+
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)
|
|
165
167
|
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)
|
|
166
168
|
|
|
167
169
|
try:
|
|
@@ -176,6 +178,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
176
178
|
thinking_token_budget=thinking_token_budget,
|
|
177
179
|
loop_detection=loop_detection,
|
|
178
180
|
random_seed=random_seed,
|
|
181
|
+
image_width=image_width,
|
|
179
182
|
timeout=timeout,
|
|
180
183
|
)
|
|
181
184
|
print(
|
|
@@ -201,11 +204,12 @@ Name | Type | Description | Notes
|
|
|
201
204
|
**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]
|
|
202
205
|
**temperature** | **float**| Model temperature. Controls output diversity. Ranges between 0 and 2. | [optional]
|
|
203
206
|
**rasterization_dpi** | **str**| Resolution used to convert formatted documents (PDFs, etc.) to images, in dots per inch. Use 'automatic' or an integer between 1 and 600. Numeric strings are also accepted. Ignored for files that are already images or text. | [optional]
|
|
204
|
-
**max_output_tokens** | **
|
|
207
|
+
**max_output_tokens** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
205
208
|
**enable_thinking** | **bool**| Enable thinking/reasoning. | [optional]
|
|
206
|
-
**thinking_token_budget** | **
|
|
209
|
+
**thinking_token_budget** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
207
210
|
**loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional]
|
|
208
211
|
**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]
|
|
212
|
+
**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]
|
|
209
213
|
**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]
|
|
210
214
|
|
|
211
215
|
### Return type
|
|
@@ -226,7 +230,7 @@ Name | Type | Description | Notes
|
|
|
226
230
|
| Status code | Description | Response headers |
|
|
227
231
|
|-------------|-------------|------------------|
|
|
228
232
|
**200** | | - |
|
|
229
|
-
**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter
|
|
233
|
+
**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection, Invalid value for: body | - |
|
|
230
234
|
**0** | | - |
|
|
231
235
|
|
|
232
236
|
[[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)
|
|
@@ -315,11 +315,12 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
315
315
|
content_settings_patch = {
|
|
316
316
|
"temperature": 0.8,
|
|
317
317
|
"rasterizationDPI": "automatic",
|
|
318
|
-
"maxOutputTokens":
|
|
318
|
+
"maxOutputTokens": "20000",
|
|
319
319
|
"enableThinking": true,
|
|
320
|
-
"thinkingTokenBudget": 15000,
|
|
320
|
+
"thinkingTokenBudget": "15000",
|
|
321
321
|
"loopDetection": true,
|
|
322
322
|
"randomSeed": "2022",
|
|
323
|
+
"imageWidth": "automatic",
|
|
323
324
|
} # ContentSettingsPatch |
|
|
324
325
|
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)
|
|
325
326
|
|
|
@@ -396,9 +397,10 @@ A **Project** is created with default settings:
|
|
|
396
397
|
---------|---------|
|
|
397
398
|
`temperature` | 0.8 |
|
|
398
399
|
`rasterizationDPI` | `automatic` |
|
|
399
|
-
`
|
|
400
|
+
`imageWidth` | `automatic` |
|
|
401
|
+
`maxOutputTokens` | 20000 |
|
|
400
402
|
`enableThinking` | true |
|
|
401
|
-
`thinkingTokenBudget` | 15000 (
|
|
403
|
+
`thinkingTokenBudget` | 15000 (`Unlimited` for no limit) |
|
|
402
404
|
`loopDetection` | true |
|
|
403
405
|
`randomSeed` | 2022 (-9223372036854775808 to 9223372036854775807, or `random`) |
|
|
404
406
|
|
|
@@ -503,9 +505,9 @@ Default values are:
|
|
|
503
505
|
-----------|--------|
|
|
504
506
|
`temperature` | 0.8 |
|
|
505
507
|
`rasterizationDPI` | `automatic` |
|
|
506
|
-
`maxOutputTokens` |
|
|
508
|
+
`maxOutputTokens` | 20000 |
|
|
507
509
|
`enableThinking` | true |
|
|
508
|
-
`thinkingTokenBudget` | 15000 (
|
|
510
|
+
`thinkingTokenBudget` | 15000 (`Unlimited` for no limit) |
|
|
509
511
|
`loopDetection` | true |
|
|
510
512
|
`randomSeed` | 2022 (-9223372036854775808 to 9223372036854775807, or `random`) |
|
|
511
513
|
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**logprobs** | **float** | Logprob of the inference result (sum of logprobs of all tokens). |
|
|
15
15
|
**output_token_probability** | **float** | Geometric mean of the output token probabilities. |
|
|
16
16
|
**random_seed** | **int** | Random seed used for this inference. |
|
|
17
|
+
**is_truncated** | **bool** | True when at least one document part stopped at a token limit. The result may be incomplete. |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -8,11 +8,12 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**temperature** | **float** | Model temperature. Controls output diversity. Ranges between 0 and 2. |
|
|
10
10
|
**rasterization_dpi** | [**ContentProjectSettingsResponseRasterizationDPI**](ContentProjectSettingsResponseRasterizationDPI.md) | |
|
|
11
|
-
**max_output_tokens** | **
|
|
11
|
+
**max_output_tokens** | **str** | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. |
|
|
12
12
|
**enable_thinking** | **bool** | Enable thinking/reasoning. |
|
|
13
|
-
**thinking_token_budget** | **
|
|
13
|
+
**thinking_token_budget** | **str** | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. |
|
|
14
14
|
**loop_detection** | **bool** | Stop the generation when the model repeats itself. |
|
|
15
15
|
**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. |
|
|
16
|
+
**image_width** | [**ContentProjectSettingsResponseImageWidth**](ContentProjectSettingsResponseImageWidth.md) | |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# ContentProjectSettingsResponseImageWidth
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```python
|
|
13
|
+
from numind.models.content_project_settings_response_image_width import (
|
|
14
|
+
ContentProjectSettingsResponseImageWidth,
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
# TODO update the JSON string below
|
|
18
|
+
json = "{}"
|
|
19
|
+
# create an instance of ContentProjectSettingsResponseImageWidth from a JSON string
|
|
20
|
+
content_project_settings_response_image_width_instance = (
|
|
21
|
+
ContentProjectSettingsResponseImageWidth.from_json(json)
|
|
22
|
+
)
|
|
23
|
+
# print the JSON string representation of the object
|
|
24
|
+
print(ContentProjectSettingsResponseImageWidth.to_json())
|
|
25
|
+
|
|
26
|
+
# convert the object into a dict
|
|
27
|
+
content_project_settings_response_image_width_dict = (
|
|
28
|
+
content_project_settings_response_image_width_instance.to_dict()
|
|
29
|
+
)
|
|
30
|
+
# create an instance of ContentProjectSettingsResponseImageWidth from a dict
|
|
31
|
+
content_project_settings_response_image_width_from_dict = (
|
|
32
|
+
ContentProjectSettingsResponseImageWidth.from_dict(
|
|
33
|
+
content_project_settings_response_image_width_dict
|
|
34
|
+
)
|
|
35
|
+
)
|
|
36
|
+
```
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -7,11 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**temperature** | **float** | Model temperature. Controls output diversity. Ranges between 0 and 2. | [optional]
|
|
9
9
|
**rasterization_dpi** | [**ContentProjectSettingsResponseRasterizationDPI**](ContentProjectSettingsResponseRasterizationDPI.md) | | [optional]
|
|
10
|
-
**max_output_tokens** | **
|
|
10
|
+
**max_output_tokens** | **str** | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
11
11
|
**enable_thinking** | **bool** | Enable thinking/reasoning. | [optional]
|
|
12
|
-
**thinking_token_budget** | **
|
|
12
|
+
**thinking_token_budget** | **str** | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
13
13
|
**loop_detection** | **bool** | Stop the generation when the model repeats itself. | [optional]
|
|
14
14
|
**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]
|
|
15
|
+
**image_width** | [**ContentProjectSettingsResponseImageWidth**](ContentProjectSettingsResponseImageWidth.md) | | [optional]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**rasterization_dpi** | [**ContentProjectSettingsResponseRasterizationDPI**](ContentProjectSettingsResponseRasterizationDPI.md) | |
|
|
9
9
|
**token_budget_type** | **str** | Token budget allocation used while converting the document: `per-page` applies a separate budget to each page, while `all-pages` shares one budget across the entire document. |
|
|
10
|
+
**image_width** | [**ContentProjectSettingsResponseImageWidth**](ContentProjectSettingsResponseImageWidth.md) | |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -260,7 +260,12 @@ Name | Type | Description | Notes
|
|
|
260
260
|
|
|
261
261
|
Convert the **File** into a **Document**
|
|
262
262
|
|
|
263
|
-
- For ***text
|
|
263
|
+
- For ***text files***, the content is used as-is.
|
|
264
|
+
- For ***original standalone raster images***, optional `imageWidth` controls resizing:
|
|
265
|
+
`"automatic"` sets the short side to 1280 pixels, a positive integer sets horizontal width,
|
|
266
|
+
and `"original"` bypasses processing. Omission defaults to `"original"`.
|
|
267
|
+
Aspect ratio is preserved and upscaling is allowed. Original upload bytes are retained.
|
|
268
|
+
This setting never applies to images produced from PDF, TIFF, or other document conversions.
|
|
264
269
|
- For ***other supported file types*** (e.g., PDFs, WORD, PPTX, Excel),
|
|
265
270
|
the file is ***converted to an image*** in the background,
|
|
266
271
|
using the **conversion parameters** provided in the request body (e.g., `rasterizationDPI`).
|
|
@@ -269,7 +274,7 @@ Example request bodies: `{"rasterizationDPI":"automatic","tokenBudgetType":"all-
|
|
|
269
274
|
`{"rasterizationDPI":155,"tokenBudgetType":"per-page"}` for fixed resolution, or `{"rasterizationDPI":"200","tokenBudgetType":"all-pages"}` for a numeric string.
|
|
270
275
|
The `automatic` keyword is case-insensitive. Fixed DPI must be a whole number from 1 to 600, inclusive;
|
|
271
276
|
responses encode fixed DPI as a number. Unlike a partial project settings update, this body requires
|
|
272
|
-
`rasterizationDPI` and `tokenBudgetType` (`all-pages` or `per-page`)
|
|
277
|
+
`rasterizationDPI` and `tokenBudgetType` (`all-pages` or `per-page`) are required; omitted or `null` values are rejected,
|
|
273
278
|
as are `0`, `601`, and `155.5` for `rasterizationDPI`.
|
|
274
279
|
|
|
275
280
|
The resulting image is then saved as a **Document** and can be used for inference or further processing.
|
|
@@ -121,7 +121,7 @@ Name | Type | Description | Notes
|
|
|
121
121
|
[[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)
|
|
122
122
|
|
|
123
123
|
# **post_api_structured_extraction_structuredprojectid_jobs_document_documentid**
|
|
124
|
-
> 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, timeout=timeout)
|
|
124
|
+
> 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)
|
|
125
125
|
|
|
126
126
|
|
|
127
127
|
Performs structured information extraction inference on the provided document as an async job.
|
|
@@ -179,16 +179,17 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
179
179
|
document_id = "document_id_example" # str | Unique document identifier.
|
|
180
180
|
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)
|
|
181
181
|
temperature = 3.4 # float | Model temperature. Controls output diversity. Ranges between 0 and 2. (optional)
|
|
182
|
-
max_output_tokens =
|
|
182
|
+
max_output_tokens = "max_output_tokens_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
183
183
|
max_example_token_number = 56 # int | Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. (optional)
|
|
184
|
-
max_example_number =
|
|
184
|
+
max_example_number = "max_example_number_example" # str | Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. (optional)
|
|
185
185
|
min_example_similarity = 3.4 # float | 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)
|
|
186
186
|
enable_thinking = True # bool | Enable thinking/reasoning. (optional)
|
|
187
|
-
thinking_token_budget =
|
|
187
|
+
thinking_token_budget = "thinking_token_budget_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
188
188
|
loop_detection = (
|
|
189
189
|
True # bool | Stop the generation when the model repeats itself. (optional)
|
|
190
190
|
)
|
|
191
191
|
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)
|
|
192
|
+
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)
|
|
192
193
|
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)
|
|
193
194
|
|
|
194
195
|
try:
|
|
@@ -205,6 +206,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
205
206
|
thinking_token_budget=thinking_token_budget,
|
|
206
207
|
loop_detection=loop_detection,
|
|
207
208
|
random_seed=random_seed,
|
|
209
|
+
image_width=image_width,
|
|
208
210
|
timeout=timeout,
|
|
209
211
|
)
|
|
210
212
|
print(
|
|
@@ -229,14 +231,15 @@ Name | Type | Description | Notes
|
|
|
229
231
|
**document_id** | **str**| Unique document identifier. |
|
|
230
232
|
**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]
|
|
231
233
|
**temperature** | **float**| Model temperature. Controls output diversity. Ranges between 0 and 2. | [optional]
|
|
232
|
-
**max_output_tokens** | **
|
|
234
|
+
**max_output_tokens** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
233
235
|
**max_example_token_number** | **int**| Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. | [optional]
|
|
234
|
-
**max_example_number** | **
|
|
236
|
+
**max_example_number** | **str**| Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. | [optional]
|
|
235
237
|
**min_example_similarity** | **float**| 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]
|
|
236
238
|
**enable_thinking** | **bool**| Enable thinking/reasoning. | [optional]
|
|
237
|
-
**thinking_token_budget** | **
|
|
239
|
+
**thinking_token_budget** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
238
240
|
**loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional]
|
|
239
241
|
**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]
|
|
242
|
+
**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]
|
|
240
243
|
**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]
|
|
241
244
|
|
|
242
245
|
### Return type
|
|
@@ -257,13 +260,13 @@ Name | Type | Description | Notes
|
|
|
257
260
|
| Status code | Description | Response headers |
|
|
258
261
|
|-------------|-------------|------------------|
|
|
259
262
|
**200** | | - |
|
|
260
|
-
**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter
|
|
263
|
+
**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 | - |
|
|
261
264
|
**0** | | - |
|
|
262
265
|
|
|
263
266
|
[[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)
|
|
264
267
|
|
|
265
268
|
# **post_api_template_generation_jobs_document_documentid**
|
|
266
|
-
> 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, timeout=timeout)
|
|
269
|
+
> 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)
|
|
267
270
|
|
|
268
271
|
|
|
269
272
|
Derive a template from the provided **Document** as an async job.
|
|
@@ -314,10 +317,11 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
314
317
|
document_id = "document_id_example" # str | Unique document identifier.
|
|
315
318
|
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)
|
|
316
319
|
enable_thinking = True # bool | Enable thinking/reasoning. (optional)
|
|
317
|
-
thinking_token_budget =
|
|
320
|
+
thinking_token_budget = "thinking_token_budget_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
318
321
|
loop_detection = (
|
|
319
322
|
True # bool | Stop the generation when the model repeats itself. (optional)
|
|
320
323
|
)
|
|
324
|
+
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)
|
|
321
325
|
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)
|
|
322
326
|
|
|
323
327
|
try:
|
|
@@ -328,6 +332,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
328
332
|
enable_thinking=enable_thinking,
|
|
329
333
|
thinking_token_budget=thinking_token_budget,
|
|
330
334
|
loop_detection=loop_detection,
|
|
335
|
+
image_width=image_width,
|
|
331
336
|
timeout=timeout,
|
|
332
337
|
)
|
|
333
338
|
)
|
|
@@ -352,8 +357,9 @@ Name | Type | Description | Notes
|
|
|
352
357
|
**document_id** | **str**| Unique document identifier. |
|
|
353
358
|
**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]
|
|
354
359
|
**enable_thinking** | **bool**| Enable thinking/reasoning. | [optional]
|
|
355
|
-
**thinking_token_budget** | **
|
|
360
|
+
**thinking_token_budget** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
356
361
|
**loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional]
|
|
362
|
+
**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]
|
|
357
363
|
**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]
|
|
358
364
|
|
|
359
365
|
### Return type
|
|
@@ -374,7 +380,7 @@ Name | Type | Description | Notes
|
|
|
374
380
|
| Status code | Description | Response headers |
|
|
375
381
|
|-------------|-------------|------------------|
|
|
376
382
|
**200** | | - |
|
|
377
|
-
**400** | Invalid value for: query parameter enableThinking, Invalid value for: query parameter
|
|
383
|
+
**400** | Invalid value for: query parameter enableThinking, Invalid value for: query parameter loopDetection | - |
|
|
378
384
|
**0** | | - |
|
|
379
385
|
|
|
380
386
|
[[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)
|
|
@@ -20,7 +20,8 @@ Method | HTTP request | Description
|
|
|
20
20
|
Returns a JSON representing the extracted information.
|
|
21
21
|
In case the extraction fails, an empty template is returned.
|
|
22
22
|
HTTP code 206 is returned when the response contains an inference error, including whenever the model does not finish normally.
|
|
23
|
-
|
|
23
|
+
`isTruncated` is true when the model stops at a token limit, even if the output also contains invalid JSON.
|
|
24
|
+
The existing `error` field and HTTP status still report validation errors; `isTruncated` independently indicates that the result may be incomplete.
|
|
24
25
|
|
|
25
26
|
#### Error Responses:
|
|
26
27
|
`404 Not Found` - If an extraction job with the specified ID does not exist.
|
|
@@ -120,6 +121,8 @@ Name | Type | Description | Notes
|
|
|
120
121
|
|
|
121
122
|
The `request` JSON contains the schema, optional instructions, optional settings, and optional example outputs.
|
|
122
123
|
Example files themselves are not embedded in JSON; they are attached as `exampleFiles` multipart parts.
|
|
124
|
+
`settings.imageWidth` accepts `"automatic"`, `"original"`, or a positive integer width.
|
|
125
|
+
It applies only to original standalone images, including uploaded examples; converted document pages use DPI.
|
|
123
126
|
`settings.rasterizationDPI` accepts `"automatic"` or an integer from 1 to 600, such as `200`. Numeric strings such as `"200"` are also accepted.
|
|
124
127
|
|
|
125
128
|
#### Request JSON:
|
|
@@ -135,12 +138,12 @@ Name | Type | Description | Notes
|
|
|
135
138
|
"settings": {
|
|
136
139
|
"temperature": 0.2,
|
|
137
140
|
"rasterizationDPI": 200,
|
|
138
|
-
"maxOutputTokens": 2048,
|
|
141
|
+
"maxOutputTokens": "2048",
|
|
139
142
|
"maxExampleTokenNumber": 12000,
|
|
140
|
-
"maxExampleNumber": 3,
|
|
143
|
+
"maxExampleNumber": "3",
|
|
141
144
|
"minExampleSimilarity": 0,
|
|
142
145
|
"enableThinking": false,
|
|
143
|
-
"thinkingTokenBudget": 8000,
|
|
146
|
+
"thinkingTokenBudget": "8000",
|
|
144
147
|
"loopDetection": true,
|
|
145
148
|
"randomSeed": "99"
|
|
146
149
|
},
|
|
@@ -179,6 +182,7 @@ curl -X POST "$BASE_URL/structured-extraction/jobs" \
|
|
|
179
182
|
`maxExampleTokenNumber`, `maxExampleNumber`, `minExampleSimilarity`, `enableThinking`,
|
|
180
183
|
`thinkingTokenBudget`, `loopDetection` and `randomSeed`. `randomSeed` must be a string containing a 64-bit integer or `random`.
|
|
181
184
|
Omitted settings use the server defaults for structured extraction.
|
|
185
|
+
`maxExampleNumber` defaults to `"5"`; use `"0"` for no examples, a positive integer string for a limit, or `"Unlimited"` for no count limit.
|
|
182
186
|
|
|
183
187
|
`examples` is optional. Each example must contain a `result` object that conforms to `schema`.
|
|
184
188
|
|
|
@@ -277,7 +281,7 @@ Name | Type | Description | Notes
|
|
|
277
281
|
[[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)
|
|
278
282
|
|
|
279
283
|
# **post_api_structured_extraction_structuredprojectid_jobs**
|
|
280
|
-
> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, dpi=dpi, 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, timeout=timeout)
|
|
284
|
+
> JobIdResponse post_api_structured_extraction_structuredprojectid_jobs(structured_project_id, body, x_organization_id=x_organization_id, dpi=dpi, 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)
|
|
281
285
|
|
|
282
286
|
|
|
283
287
|
Extract structured information from the provided text or file as an async job. Some files are converted to images -
|
|
@@ -336,16 +340,17 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
336
340
|
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)
|
|
337
341
|
dpi = "dpi_example" # str | Resolution used to convert formatted documents (PDFs, etc.) to images, in dots per inch. Use 'automatic' or an integer between 1 and 600. Numeric strings are also accepted. Ignored for files that are already images or text. (optional)
|
|
338
342
|
temperature = 3.4 # float | Model temperature. Controls output diversity. Ranges between 0 and 2. (optional)
|
|
339
|
-
max_output_tokens =
|
|
343
|
+
max_output_tokens = "max_output_tokens_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
340
344
|
max_example_token_number = 56 # int | Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. (optional)
|
|
341
|
-
max_example_number =
|
|
345
|
+
max_example_number = "max_example_number_example" # str | Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. (optional)
|
|
342
346
|
min_example_similarity = 3.4 # float | 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)
|
|
343
347
|
enable_thinking = True # bool | Enable thinking/reasoning. (optional)
|
|
344
|
-
thinking_token_budget =
|
|
348
|
+
thinking_token_budget = "thinking_token_budget_example" # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
345
349
|
loop_detection = (
|
|
346
350
|
True # bool | Stop the generation when the model repeats itself. (optional)
|
|
347
351
|
)
|
|
348
352
|
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)
|
|
353
|
+
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)
|
|
349
354
|
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)
|
|
350
355
|
|
|
351
356
|
try:
|
|
@@ -364,6 +369,7 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
364
369
|
thinking_token_budget=thinking_token_budget,
|
|
365
370
|
loop_detection=loop_detection,
|
|
366
371
|
random_seed=random_seed,
|
|
372
|
+
image_width=image_width,
|
|
367
373
|
timeout=timeout,
|
|
368
374
|
)
|
|
369
375
|
)
|
|
@@ -390,14 +396,15 @@ Name | Type | Description | Notes
|
|
|
390
396
|
**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]
|
|
391
397
|
**dpi** | **str**| Resolution used to convert formatted documents (PDFs, etc.) to images, in dots per inch. Use 'automatic' or an integer between 1 and 600. Numeric strings are also accepted. Ignored for files that are already images or text. | [optional]
|
|
392
398
|
**temperature** | **float**| Model temperature. Controls output diversity. Ranges between 0 and 2. | [optional]
|
|
393
|
-
**max_output_tokens** | **
|
|
399
|
+
**max_output_tokens** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
394
400
|
**max_example_token_number** | **int**| Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. | [optional]
|
|
395
|
-
**max_example_number** | **
|
|
401
|
+
**max_example_number** | **str**| Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. | [optional]
|
|
396
402
|
**min_example_similarity** | **float**| 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]
|
|
397
403
|
**enable_thinking** | **bool**| Enable thinking/reasoning. | [optional]
|
|
398
|
-
**thinking_token_budget** | **
|
|
404
|
+
**thinking_token_budget** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
399
405
|
**loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional]
|
|
400
406
|
**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]
|
|
407
|
+
**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]
|
|
401
408
|
**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]
|
|
402
409
|
|
|
403
410
|
### Return type
|
|
@@ -418,13 +425,13 @@ Name | Type | Description | Notes
|
|
|
418
425
|
| Status code | Description | Response headers |
|
|
419
426
|
|-------------|-------------|------------------|
|
|
420
427
|
**200** | | - |
|
|
421
|
-
**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter
|
|
428
|
+
**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 | - |
|
|
422
429
|
**0** | | - |
|
|
423
430
|
|
|
424
431
|
[[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)
|
|
425
432
|
|
|
426
433
|
# **post_api_structured_extraction_structuredprojectid_jobs_text**
|
|
427
|
-
> 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, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, timeout=timeout)
|
|
434
|
+
> 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, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout)
|
|
428
435
|
|
|
429
436
|
|
|
430
437
|
Performs structured information extraction inference on the provided text as an async job.
|
|
@@ -486,18 +493,19 @@ with numind.openapi_client.ApiClient(configuration) as api_client:
|
|
|
486
493
|
text_request = {text=[EXAMPLE ONLY] Your order (ID: o-89123) has been successfully processed. The customer ID for this order is c-20485. It was placed on March 10, 2024, at 11:15 AM UTC and is now marked as shipped. The total amount charged is $149.99 USD. The items in this order include: Product ID p-00876 with a quantity of 1 at a unit price of $79.99, and Product ID p-00321 with a quantity of 2 at a unit price of $35.00. The shipping address is 782 Pine St, Austin, TX, 73301, USA. The customer has requested: "Leave package at the front door." Additional delivery preferences include no signature required and standard delivery. The estimated delivery date is March 15, 2024, by 5:00 PM UTC.} # TextRequest |
|
|
487
494
|
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)
|
|
488
495
|
temperature = 3.4 # float | Model temperature. Controls output diversity. Ranges between 0 and 2. (optional)
|
|
489
|
-
max_output_tokens =
|
|
496
|
+
max_output_tokens = 'max_output_tokens_example' # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
490
497
|
max_example_token_number = 56 # int | Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. (optional)
|
|
491
|
-
max_example_number =
|
|
498
|
+
max_example_number = 'max_example_number_example' # str | Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. (optional)
|
|
492
499
|
min_example_similarity = 3.4 # float | 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)
|
|
493
500
|
enable_thinking = True # bool | Enable thinking/reasoning. (optional)
|
|
494
|
-
thinking_token_budget =
|
|
501
|
+
thinking_token_budget = 'thinking_token_budget_example' # str | Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. (optional)
|
|
495
502
|
loop_detection = True # bool | Stop the generation when the model repeats itself. (optional)
|
|
496
503
|
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)
|
|
504
|
+
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)
|
|
497
505
|
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)
|
|
498
506
|
|
|
499
507
|
try:
|
|
500
|
-
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, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, timeout=timeout)
|
|
508
|
+
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, thinking_token_budget=thinking_token_budget, loop_detection=loop_detection, random_seed=random_seed, image_width=image_width, timeout=timeout)
|
|
501
509
|
print("The response of StructuredDataExtractionApi->post_api_structured_extraction_structuredprojectid_jobs_text:\n")
|
|
502
510
|
pprint(api_response)
|
|
503
511
|
except Exception as e:
|
|
@@ -515,14 +523,15 @@ Name | Type | Description | Notes
|
|
|
515
523
|
**text_request** | [**TextRequest**](TextRequest.md)| |
|
|
516
524
|
**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]
|
|
517
525
|
**temperature** | **float**| Model temperature. Controls output diversity. Ranges between 0 and 2. | [optional]
|
|
518
|
-
**max_output_tokens** | **
|
|
526
|
+
**max_output_tokens** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
519
527
|
**max_example_token_number** | **int**| Maximum number of tokens allocated to smart examples. Must be between 0 and 130000, within the model's context window. | [optional]
|
|
520
|
-
**max_example_number** | **
|
|
528
|
+
**max_example_number** | **str**| Maximum number of examples to use. Given as a string: 0 for no examples, a positive integer string for a limit, or Unlimited for no count limit. | [optional]
|
|
521
529
|
**min_example_similarity** | **float**| 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]
|
|
522
530
|
**enable_thinking** | **bool**| Enable thinking/reasoning. | [optional]
|
|
523
|
-
**thinking_token_budget** | **
|
|
531
|
+
**thinking_token_budget** | **str**| Maximum number of tokens for the corresponding budget (output or thinking). Given as a string: a strictly positive integer string, or Unlimited for no limit; zero is invalid. The thinking budget is only used when thinking is enabled. | [optional]
|
|
524
532
|
**loop_detection** | **bool**| Stop the generation when the model repeats itself. | [optional]
|
|
525
533
|
**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]
|
|
534
|
+
**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]
|
|
526
535
|
**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]
|
|
527
536
|
|
|
528
537
|
### Return type
|
|
@@ -543,7 +552,7 @@ Name | Type | Description | Notes
|
|
|
543
552
|
| Status code | Description | Response headers |
|
|
544
553
|
|-------------|-------------|------------------|
|
|
545
554
|
**200** | | - |
|
|
546
|
-
**400** | Invalid value for: query parameter temperature, Invalid value for: query parameter
|
|
555
|
+
**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: body | - |
|
|
547
556
|
**0** | | - |
|
|
548
557
|
|
|
549
558
|
[[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)
|