CHANGELOG

1.11.1

  • [improvement] Updated documentation for chat component for LLM Document Q&A in Custom Supervision

1.11.0

1.10.5

  • [feature] Refer to the business metric measurement occurrence time via time, a datetime object. This datetime must be timezone-aware

1.10.4

1.10.3

  • [feature] Added publish measurements method to HsBlockInstance that allows code in PythonBlock or CodeBlock to tracks business metrics (available since V41)

1.10.2

  • [improvement] Added support for the Python 3.12 PythonBlock

1.10.1

  • [feature] Added utility methods to HsBlockInstance for making authenticated requests to the Hyperscience instance from inside the code in PythonBlock or CodeBlock (available since R40.2)

1.10.0

  • [feature] Hyperscience Platform V40 has been released!

  • [bugfix] Removed default Submission Aware On Error flow from V38 examples because it might not exist in a V38 system.

1.9.1

  • [bugfix] Updated default inputs for ReprocessingBlock in versions 39 and 39.1, so that additional inputs in custom IDP_CORE flows would get relayed for reprocessing runs

1.9.0

  • [feature] Hyperscience Platform V39.1 has been released!

  • [improvement] Roles are exposed as an argument to the IDP Core Block

  • [improvement] Easier to see where to modify Notification, On Error flows in the Document Processing example flow

  • [improvement] Default Notification flow, On Error flow, and IDP Core block in the example flow point to the out-of-the-box flows in the platform

1.8.3

  • [bugfix] Reverted the change introduced in Flows SDK version 1.8.2 where the default value for PythonBlock#python_version is set to Python 3.11, which caused breaking behaviour.

  • [improvement] Added support for an environment variable HS_PYTHON_CODE_BLOCK_PYTHON_VERSION that allows overriding the default behaviour without having to make code changes to existing flows.

1.8.2

  • [bugfix] Default version of PythonBlock is now Python 3.11, instead of 3.9

1.8.1

  • [improvement] Ported quality of life features introduced in the V39 samples to V38 samples

    • Roles are exposed as an argument to the IDP Core Block

    • Easier to see where to modify Notification, On Error flows in the Document Processing example flow for V38

    • Default Notification flow, On Error flow, and IDP Core block in the example V38 flow point to the out-of-the-box flows in the platform for that version

  • [improvement] Moved IDPWrapperManifest out of the example Document Processing flow samples for both V38 and V39

  • [improvement] Added parameter that controls which Python version a PythonBlock works with

1.8.0

  • [feature] Hyperscience Platform V39 has been released!

  • [improvement] Roles are exposed as an argument to the IDP Core Block

  • [improvement] Easier to see where to modify Notification, On Error flows in the Document Processing example flow

  • [improvement] Default Notification flow, On Error flow, and IDP Core block in the example flow point to the out-of-the-box flows in the platform

1.7.2

  • Bump asttokens to 2.4.1

1.7.1

  • [bugfix] Default CustomSupervision’s notification_workflow to None

  • [improvement] Add release.zip to the idp v38 starter flow

  • [improvement] Properly identify settings as Classification settings

1.7.0

1.6.4

  • [feature] Add support for on_error_flow construct in error handling.

    • Can be used only in the flow level error handling section

    • Available in Hyperscience Platform V38 and above.

1.6.3

  • [feature] Add support for compatibility_spec construct in blocks.

    • Available in Hyperscience Platform V38 and above.

1.6.2

  • [bugfix] Remove extra parameter http_config from SubmissionBootstrap block for R32.

1.6.1

  • [improvement] Setting a range for pydantic between 1.10.11 inclusive and 2.0 non-inclusive .

1.6.0

1.5.2

  • [improvement] Updated pydantic version to 1.10.8.

1.5.1

  • [bugfix] Added missing http_config parameter to SubmissionBootstrapBlock.

  • [improvement] Updated documentation for I/O blocks.

1.5.0

1.4.1

  • [feature] Decision dependencies for Custom Supervision is available!

  • [feature] Mandatory decisions for Custom Supervision is also available!

You can find explanations of both features and examples of the JSON configuration in the Decision components section of Custom Supervision.

1.4.0

  • [feature] Hyperscience Platform V35 has been released!

    • updated blocks

    • starter examples

    • Check out some of the new features v35 features, released in recent flows-sdk versions:

      • PythonBlock, how to store and load binary data, use 3rd party libraries and more in 1.1.0

      • How to use structured logging, also visible in the UI in 1.3.0

  • [feature] A new system block has been introduced - Foreach!

1.3.0

  • [improvement] Added a log method to HsBlockInstance

This is done in preparation for an upcoming V35 feature that will expose better logging functionality for flow developers, making it available for both CodeBlock and PythonBlock.

flows_sdk.types.HsBlockInstance

1.2.1

  • [improvement] A reference to the code function passed to CodeBlock and PythonBlock is now available on the block object under block.code_fn

1.2.0

  • [feature] Hyperscience Platform V34 has been released!

You can find the updated blocks in the usual implementations.idp_v34.idp_blocks package as well as the new starter examples.

  • [feature] New block - HyperscienceRestApiBlock available for V32, V33, and V34

This block allows you to make API requests against the Hyperscience Platform APIs. Check out the docs to learn more!

flows_sdk.implementations.idp_v34.idp_blocks.HyperscienceRestApiBlock

  • [deprecated] Removed the Kofax Folder Listener IOBlock

If you are using this block, we recommend migrating to the Universal Folder Listener IOBlock.

1.1.0

  • [feature] Added a new block - PythonBlock

This requires a Hyperscience platform version 34.0.0+

flows_sdk.blocks.PythonBlock

PythonBlock is a special type of block that can execute custom python code on the Hyperscience platform. Similarly to CodeBlock, the code can utilize packages that are part of the Python Standard Library, but it also allows developers to utilize third-party python packages.

Check out the docs to learn how.

  • [feature] Introduces HsTask and HsBlockInstance system arguments for code blocks

This requires a Hyperscience platform version 35.0.0+

The HsTask class can be used to access flow run metadata - most prominently the correlation_id which corresponds to the submission UUID. HsBlockInstance allows users to store binary data to the platform and retrieve it later as a mechanism to transfer such data between blocks.

Please refer to the examples under code snippets for more information on how to access these classes in code block functions.

1.0.1

  • [improvement] new properties for v32 CaseCollationBlock and v33 MachineCollationBlock

Both now have the dedupe_files property, with the v33 MachineCollationBlock also adding remove_from_cases.

Check out the docs to learn more: flows_sdk.implementations.idp_v32.idp_blocks.CaseCollationBlock, flows_sdk.implementations.idp_v33.idp_blocks.MachineCollationBlock

  • [examples] Added a new example for custom supervision using v33 blocks

You can find it in the examples page - IDP Custom Supervision V33

  • [examples] IDP starter examples for Hyperscience v32 have been updated

The examples IDP Starter V32.0.9+ and IDP Starter V32.0.0 to V32.0.8 were packing an outdated flow definition, which is now updated.

IDP w/ Code Block could result in a halted submission. It should now properly execute end-to-end on the Hyperscience Platform.

1.0.0

  • [improvement] reference_name is now an optional property for all blocks.

This requires a Hyperscience platform version 32.0.11+ or 33.1.1+

It’s still a good idea to provide meaningful reference names when instantiating blocks, but if the property reference_name is not set, a unique one will be generated.

before:

submission_bootstrap = SubmissionBootstrapBlock(reference_name='submission_bootstrap')
// { "reference_name": "submission_bootstrap" }

after:

submission_bootstrap = SubmissionBootstrapBlock()
// { "reference_name": "auto_submission_bootstrap__1" }

  • [bugfix] Fixed a bug where IDP Starter V32 would not work on Hyperscience platforms after 32.0.9. There are now two separate examples - one for 32.0.0 to 32.0.8 and another one for 32.0.9+

0.8.0

  • [feature] Introduces the implementation.idp_v33 package that contains block definitions used by v33 of the Hyperscience platform

  • [improvement] Added an IDP Starter Example that uses v33 blocks