Migration guide

This page lists the key points to pay attention to when migrating existing code from to the 4.2 MyScript iink Cloud APIs.

Breaking change with Raw Content REST batch API recognition configuration

The configuration.raw-content.recognition.text and configuration.raw-content.recognition.shape configuration parameters are no more supported.

You must now use the raw-content.classification.types to control the list of content types that can be output by the ink strokes classifier and the raw-content.recognition.types to define the type of recognition that will be performed on this content.

Default value for raw-content.classification.types is ["text", "shape", "drawing"], and default value for configuration.raw-content.recognition.types is [], so you must adjust the values corresponding to your needs.

For example, if you were using Raw Content to perform only text recognition, you need to remove shape from the list of content types that can be output by the ink strokes classifier. So your configuration will look like:

{
  "raw-content": {
    "classification": {
      "types": [ "text", "drawing" ]
    },
    "recognition": {
      "types": [ "text" ]
    }
  }
}

➤ For more information, look at the REST Raw Content batch example and refer to the raw-content.classification.types and raw-content.recognition.types possible values.

Deprecation of the math.solver.fraction-mode property

The math.solver.fraction-mode configuration key has been renamed to math.solver.number-format. Its possible values remain the same. Although we still support the old name, if you are using this configuration, please update it with the new name, as the old name is deprecated.

Support of export.jiix.text.lines by the Raw Content REST recognize endpoint

The configuration export.jiix.text.lines is now supported by the Raw Content recognize endpoint. Since its default value is false, JIIX export of Raw Content REST recognize text blocks no longer includes the “lines” object by default.

➤ To keep the “lines” object, make sure to modify the export.jiix.text.lines configuration.

New LaTeX label for Math blocks in JIIX

To facilitate math integration, JIIX Math blocks now come with LaTeX labels containing the associated recognition result.

➤ If you don't want this label, you must set the export.jiix.math-label setting to false, as it is enabled by default.