LexItem Properties
| Property | Description | Type |
|---|---|---|
| stage | Stage name | string |
| confidence | Confidence assigned to this item | number |
| match | Original text covered by this LexItem | string |
| flags | List of flags | array of strings |
| text | Text representation or value assigned to this LexItem | string |
| startPos | Start position in characters | integer |
| endPos | End position in characters | integer |
| metadata | Additional data assigned to this LexItem, either manually or by process | object |
| display | Display value assigned to the LexItem | string |
| entities | List of entities assigned to this tag | array of Entity objects |
| components | Container of the LexItem, indicating the items it could be composed of | Components object |
| tags | List of tags to identify in the text | array of strings |
Vertex
The Vertex object represents a split route in the graph, leading to alternative routes. It contains information about the vertex, such as its stage, confidence, match, flags, text, positions, and metadata.
Vertex Properties
| Property | Description | Type |
|---|---|---|
| stage | Stage name | string |
| confidence | Confidence assigned to this item | number |
| match | Original text covered by this Vertex | string |
| flags | List of flags | array of strings |
| text | Text representation or value assigned to this Vertex | string |
| startPos | Start position in characters | integer |
| endPos | End position in characters | integer |
| metadata | Additional data assigned to this Vertex, either manually or by process | object |
Entity
The Entity class represents the entities that could come inside a LexItem. It contains information about the entity, such as its display value, patterns, ID, fields, and tags.
Entity Properties
| Property | Description | Type |
|---|---|---|
| display | Display value assigned to the entity | string |
| patterns | Patterns associated with the entity | array of strings |
| id | ID of the entity for business use (not necessarily unique) | string |
| fields | Additional data for this entity | object |
| tags | List of hierarchical tags assigned to this entity | array of strings |
Components
The Components object represents a container of LexItems. It defines the composition of a LexItem by specifying the LexItems it can be composed of.
Components Properties
| Property | Description | Type |
|---|---|---|
| lexItems | List of LexItems that can compose the current LexItem | array of LexItem objects |
Overview
Content Tools