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

Getting started with Salience

This page will help you get started with Salience.

There are several areas of functionality you will need to understand to get the most out of Salience:

  • Salience API, which allows you to extract information from text
  • Salience data directory overview , which allows you to configure what you want extracted
  • Salience options, which control various behaviors within Salience
  • Best practices for integration.

But first, let's get you up and running. Are you installing on a Linux platform or on a Windows platform ?


Steps for installing Salience on Linux platforms

For the purpose of this guide, we'll assume that the Salience distribution has been downloaded to /home/devuser/downloads and is being installed in /home/devuser/lexalytics. We'll also assume a 64-bit Linux environment.

Note: Salience 6.x supports any distribution of Linux with glibc 2.3.4+

1) Download the distribution

Login to the support site and download the current tar distribution and unpack it:

cd /home/devuser/downloads
tar -xjf salience-6.5.0.x-x64.tar.bz2
cp salience-6.5.0.x ../lexalytics

2) Provide the license

The Lexalytics license file can exist anywhere on your system, as it is provided to the Salience API via fully-qualified path. However, for the sake of simplicity, we'll copy it into the root of our installation:

cp license.v5 ../lexalytics/salience-6.0.0.x

3) Set up environment variables

The environment variable lxainstall must be set to the root of your installation. There are other environment variables that can aid with support within various development environments (mainly Java). The following is recommended for your ~/.bash_profile file.

emacs ~/.bash\_profile

Note: If you are running Ubuntu, then run emacs ~/.profile instead.

Add the following:

lxainstall=/home/devuser/lexalytics/salience-6.x.x.x
(Note: replace x.x.x with the version you just unpacked) 
export lxainstall

LD\_LIBRARY\_PATH=$lxainstall/salience/lib
export LD\_LIBRARY\_PATH

JAVA\_HOME=<path-to-your-jdk>
(Note: replace <path-to-your-jdk> with an actual jdk path, e.g. $HOME/jdk1.6.0\_24) 
export JAVA\_HOME

JAVA\_OPTS="-Djava.library.path=$LD\_LIBRARY\_PATH"
export JAVA\_OPTS

PATH=$JAVA\_HOME/bin:$PATH:$HOME/bin:$lxainstall
export PATH

Refresh your environment:

source ~/.bash\_profile

Note: If you are running Ubuntu, then run source ~/.profile instead.

4) Explore the Salience SDK

Now that you have Salience deployed to your system, you can focus on the examples provided for your development environment of choice and getting familiar with the Salience API for that development environment. Use the links below to learn more about getting started with development in the supported languages:

I'm developing in Java
I'm developing in python


Steps for installing Salience on Windows platforms

For the purpose of this guide, we'll assume that the Salience distribution has been downloaded to C:\Users\devuser\Downloads and is being installed on a 64-bit Windows machine.

Note: Salience 6.x supports Windows 7 and 10.

1) Download and run the installation

Download the current Windows install executable and run it:

In Windows Explorer, open C:\Users\devuser\Downloads and double-click Salience-6.5.x-x64.exe

Click Next on the installation Welcome screen

Set the desired installation location and click Next on the installation Choose Install Location screen

NOTE: The installer is a 32bit executable, even in the case of the 64bit Windows distribution. It is recommended that you change the default install location to C:\Program Files\Lexalytics on this screen.

Click Install on the installation Choose Components screen

'Wait! I ran into a problem with the Windows runtime support needed!'

There are environments which do not contain the runtime support needed for Salience, in which case the installer will attempt to download the runtime support from Microsoft.

2) Provide the license

The Lexalytics license file can exist anywhere on your system for the purposes of working with the API, however the demonstration applications provided by the Windows installation expect the license file to exist in the root of the installation as license.v5:

Copy license file to C:\Program Files\Lexalytics and rename to license.v5

3) Explore the Salience SDK

Now that you have Salience deployed to your system, you can focus on the examples provided for your development environment of choice and getting familiar with the Salience API for that development environment. Use the links below to learn more about getting started with development in the supported languages:

You can also see Salience output using the Salience Demo Functionality overview

Updated 4 months ago

Getting started with Salience


This page will help you get started with Salience.

Suggested Edits are limited on API Reference Pages

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