Recognizer configuration

MyScript iink SDK is a flexible toolkit, and its default configuration can be adjusted to meet different needs. This page lists available configuration options for the REST recognizer endpoint, their default values and usage.

The configuration is sent in the request body with each call the REST recognizer endpoint. Refer to the user guide for more instructions.

For the sake of clarity, path of parameter are given and without the configuration prefix. For example export.jiix.bounding-box key match following entry in the body :

"configuration": {
  "export": {
    "jiix": {
      "bounding-box": "..."
    }
  }
}

General iink parameters

Key	Type	Default value	Description
`export.jiix.bounding-box`	boolean	`false`	If `true`, JIIX export will contain the bounding boxes of exported items.
`export.jiix.strokes`	boolean	`true`	If `true`, JIIX export will include the detailed ink information.
`export.jiix.text.chars`	boolean	`false`	If `true`, JIIX export will include the detailed characters information.
`export.jiix.text.words`	boolean	`true`	If `true`, JIIX export will include the detailed words information.
`export.jiix.text.lines`	boolean	`false`	If `true`, JIIX export will include the detailed geometric information per line in the text interpretation.
`export.jiix.shape.candidates`	boolean	`true`	If `true`, JIIX export will include shape candidates when using a Shape Recognizer or a Raw Content Recognizer with shape recognition.
`export.jiix.ranges`	boolean	`false`	If `true`, JIIX export will include ink ranges of every object: is useful for having strokes ranges without their full coordinates to avoid an heavy .jiix file.
`export.jiix.text.spans`	boolean	`false`	If `true`, JIIX export will include detailed recognition information per line in the text interpretation
`lang`	string	`en_US`	Defines the language used for the text recognition.

Text configuration

Key	Type	Default value	Description
`text.guides.enable`	boolean	`false`	If `true`, guides are used for recognition operation.
`text.guides.line-gap-mm`	number	0	Defines guides spacing in mm in the Text recognizer (ignored if `text.guides.enable` is false, must be > 0 if `text.guides.enable` is true).
`text.guides.origin-y-mm`	number	0	Defines the y position of the first guide in the Text recognizer (ignored if `text.guides.enable` is false).

Gesture configuration

Key	Type	Default value	Description
`gesture.tap.spacing-mm`	number	3	Defines the distance in mm between two taps to determine double tap.
`gesture.disabled-gestures`	string array	<empty>	Defines the gestures to be disabled (all enabled by default). String value among: "tap", "double-tap", "long-press", "top-bottom", "bottom-top", "left-right", "right-left", "scratch", "surround"

Shape configuration

Key	Type	Default value	Description
`shape.beautification.enable`	boolean	`true`	If `true`, enable the beautification of the shape recognition result (selected candidate only) with Shape and Raw Content recognizers

Raw Content configuration

Key	Type	Default value	Description
`raw-content.classification.types`	string array	`[ "text", "math", "shape", "decoration", "drawing"]`	Controls the list of content types that can be output by the ink strokes classifier. If content types are removed from this list, the corresponding strokes are output as part of the most likely alternative choice among the remaining content types.
`raw-content.recognition.types`	string array	`[ "text", "math", "shape", "decoration"]`	Controls the list of content types that are recognized after classification.