Teneo Developers

Creating your own Language Objects

Create a Language Object

To create a new Language Object, simply follow the below steps:

  • Go to the Solution Explorer in the main Teneo Studio window (Home tab)
  • Select the folder, or alternatively create a new folder, where the Language Object should be added
  • In the top ribbon, click on the Language Object button in the New area
  • The Language Object window opens on the Properties tab, add the Name of the Language Object
  • Optionally, add an Alias and a Description
  • Click the green Play icon or the back arrow in the top left corner
  • Now, add the condition of the Language Object
  • Optionally, add NLU Variables, LO Variables and/or Examples (available in the right-hand side panels)
  • Remember to Save to preserve all the modifications.

The name of a Language Object

When naming a Language Object, it is recommended to follow the naming conventions used by the Teneo Lexical Resources.

Furthermore, the Language Object's name:

  • needs to be unique within the solution
  • is written in upper-case
  • cannot contain contain any reserved characters.

Furthermore, please note that if a Language Object in the solution has the same name as a Language Object in an assigned lexical resource, the Language Object located in the solution is always chosen over the object in the lexical resource by Engine.

The condition of a Language Object

Conditions of Language Objects are written in the Teneo Linguistic Modelling Language and can contain words or reference to other Language Objects or entities that together represent the user input word(s) which the Language Object should recognize. The different terms in the condition must be separated by operators to indicate how they are related to each other.

For more information and tips please see the Condition editor for info related to the available functionalities and the Teneo Linguistic Modelling Language summary for an introduction of the available operators.

Bulk import of Language Objects

To facilitate the creation of many Language Objects (or entities), the Bulk Import functionality can be used to create the wanted objects externally in a csv file. For more details, please see Bulk Import.

Open a Language Object

Open in read-only mode

A Language Object can be opened by browsing to the folder where the Language Object is stored and double-clicking it to open in read-only mode. To activate edit mode, simply click Edit in the top ribbon of the object.

By selecting one or more Language Objects in the Solution Explorer these can also be opened from the right-click mouse menu or by clicking the Open button in the top ribbon of Teneo Studio.

Open in edit-mode

To open a Language Object directly in edit mode, select the Language Object and click the Edit button in the top ribbon or press Alt while double-clicking the object(s).

Open a Language Object from the condition editor

In the condition editor, to open a Language Object used in the condition, either double-click on the name of the Language Object to open in read-only mode or press Alt while clicking with the mouse to open in edit mode.

Language Objects (and Entities) being referenced from a lexical resource will always open in read-only mode.

Save a Language Object

Saving can be done by simply clicking Save in the top ribbon on the Home tab of a Language Object. A dialogue box prompts the user to add a comment, next click Ok.

To save direct and bypass the comment, press Alt on the keyboard while clicking Save.

Teneo Studio, furthermore, provides the keyboard shortcut Ctrl+S to save with a comment and Ctrl+Alt+S to save without a comment.

Close a Language Object

To close a Language Object, simply click the X in the top, right corner of the Language Object window. If there are unsaved changes, Teneo Studio will prompt the user to save or close without saving any possible changes performed by the user.

Alternatively, click the Language Object tab in the top left corner to go to the backstage of the Language Object and choose Close in the options to the left.

Disable or Enable a Language Object

In the top ribbon of a Language Object it is possible to Disable or Enable the object. By default new Language Objects are enabled.

In the Solution Explorer view, it is possible to multi-select Language Objects to disable or enable several objects at the same time. Use the Disable/Enable buttons in the top ribbon of Teneo Studio and select Yes in the dialogue box.

When clicking Disable/Enable while having a folder selected, a dialogue will be displayed for the user to confirm the action of all the selected objects in the selected folder and subfolders.

When disabling/enabling multiple objects at a time, clicking Run in background in the dialogue box permits the user to keep working while the actual disabling/enabling is carried out.

A dialogue box will be displayed when the disabling or enabling has finished successfully.

Version Flag

The Stable Version area in the top ribbon of a Language Object allows to set the current version of the Language Object as stable by clicking Set; and to unset a stable version by clicking Unset.

In the backstage of the Language Object (Language Object tab > History) it is possible to set a previous version of the Language Object as the stable version, to do so simply select the wanted version and click the Set Stable button which appears in the top of the list when selecting an item.

Note that it is not possible to set a new Language Object to stable until a first version of the object has been saved.

Read more about Version Flags.

Include or Exclude from Branching

The Include and Exclude buttons available in the top ribbon of a Language Object allows the user to include or exclude the object from branching when working in the Master solution of a Localization setup.

Read more about the Localization setup.

Navigate panels and tabs

Used by panel

In the main window of a Language Object, it is possible to see where that particular Language Object is used within the solution. To see this information, open the Used by panel by clicking with the mouse.

By hoovering over objects in this panel, tooltips providing more information are displayed. Clicking on an object will open the location of the usage in read-only mode. Use Alt+click to open in edit mode.

Errors panel

The Errors panel is visible, next to the Used by panel, only when one or more errors are detected in the Language Object. The following errors will automatically display an information message:

MessageType
The condition is emptyError
The document name is not uniqueError

History tab

The History tab in the backstage of a Language Object contains the History of each time the Language Object has been saved. If users have added comments when saving, these will be displayed here.

In the history list it is possible to click the version number to see a previous version of the Language Object. If needed, a previous version available in the history can be restored by opening the object and clicking the Restore button available in the top ribbon. A new version of the Language Object will be created, containing the data of the selected version.

When restoring an object, it is recommended to check that referenced objects are still available in the solution for correct functionality.

Properties tab

The Properties tab contain the following information related to the Language Object:

Move and copy Language Objects

Teneo Studio allows to copy and move around objects within a solution and from another solution to the currently open one. For more details, please see Moving and copying objects.

Delete a Language Object

It is possible to delete one or more Language Objects from a solution, to learn how please check out the Delete objects section.

Entities
Localization setup
NLU Variables