编辑 | blame | 历史 | 原始文档

Parameters

Param Type Default Description
name string Name of the element
value string Data field containing text or a UR
[valueType] url | text text Whether the text is stored directly in uploaded data or needs to be loaded from a URL
[saveTextResult] yes | no Whether to store labeled text along with the results. By default, doesn't store text for valueType=url
[encoding] none | base64 | base64unicode How to decode values from encoded strings
[selectionEnabled] boolean true Enable or disable selection
[highlightColor] string Hex string with highlight color, if not provided uses the labels color
[showLabels] boolean Whether or not to show labels next to the region; unset (by default) — use editor settings; true/false — override settings
[granularity] symbol | word | sentence | paragraph Control region selection granularity

Result parameters

Name Type Description
value Object
value.start string position of the start of the region in characters
value.end string position of the end of the region in characters
[value.text] string text content of the region, can be skipped

Example JSON

{
  "value": {
    "start": 2,
    "end": 81,
    "labels": ["Car"]
  }
}