Salience

The Salience Developer Hub

Welcome to the Salience developer hub. You'll find comprehensive guides and documentation to help you start working with Salience as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Working with profiles and options

Developers that access the Salience API know that in order to begin a Salience session, you need to provide the path to a license file and a path to the data directory to use. These are the minimum items for starting a Salience session. In the Salience Demo, the license file must be located in the root of the Salience installation. Other items can be configured in profiles.

The Profile list

On first run, you'll notice that the Profile dropdown contains at least two items; Default Mode (data) and Short Mode (twitter_data). These are automatically created by the existence of the default data directory in the installation, and the two possible modes of operating on content. Additional profiles can be created by selecting from the dropdown. This displays the Custom Profile dialog.

A Profile Name must be specified, as well as the path to the Data Path to the Data Directory. Clicking the Lock button sets the path to the User Directory relevant to the Data Directory. Untoggling the Lock button enables you to browse and selection a path to a User Directory containing your customizations elsewhere on the filesystem.

A checkbox is provide to specify use of Short Mode for processing. Other options can be accessed and configured following profile creation through the Options dialog.

Custom profiles can be deleted within the Options dialog.

The Options dialog

The Options dialog provides access to all Salience options controlling text analytics processing. For the current profile, the Restore Defaults button returns options to their default values. For custom profiles, the Delete Profile button is also enabled, allowing deletion of the profile.

General
This tab allows for the configuration of the major options that control Salience Demo operation. These include the paths to the License file, Data directory and User directory, as well as the ability to log session startup for diagnosing startup issues. Major options relevant to the Text processing of provided content are also available on this tab.

Document methods
This tab displays the major options relevant to document functionality within the Salience Demo.

Entity methods
This tab displays the major options relevant to entity functionality within the Salience Demo.

Salience Options
This tab contains access to all available Salience options.

Display
This tab contains an option to adjust the font size within the content and result sections of the Salience Demo.

Updated 7 months ago

Working with profiles and options


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.