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

Base Options

Tagging Threshold

Sets threshold of percentage of alphanumeric characters for text processing.

Min/Max range

1-100

Default value

80

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_TAGGINGTHRESHOLD;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.TextThreshold = integer value

Java

Salience.Options.Base.setTaggingThreshold(integer value)

Python

salience.setOption_TaggingThreshold(session,integer value, configuration ID)

Max Execution Time

Maximum time in milliseconds certain functions are allowed to run for.

Min/Max range

0-MAX INT

Default value

120

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_MAXEXECUTIONTIME;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.MaxExecutionTime = integer value

Java

Salience.Options.Base.setMaxExecutionTime(integer value)

Python

salience.setOption_MaxExecutionTime(session,integer value, configuration ID)

Fail on Very Long Sentences

When a document contains a very long sentence, should you process the rest of the document? With the default value of 1 for this option, a document containing a sentence with more than 1000 words will throw an exception in the prepare text stage. If this option is set to 0, the invalid sentence is ignored and the remainder of the document content is processed.

Min/Max range

0 or 1

Default value

1

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_FAILONLONGSENTENCE;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.FailOnLongSentences = boolean value

Java

Salience.Options.Base.setFailLongSentence(boolean value)

Python

salience.setOption_FailOnLongSentences(session,integer value, configuration ID)

User Directory

Sets path to user directory of customizations.

Min/Max range

N/A

Default value

path to data directory/user

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_USERDIRECTORY;
oOption.acValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.UserDirectory = string value

Java

Salience.Options.Base.setUserDirectory(string value)

Python

salience.setOption_UserDirectory(session,string value, configuration ID)

Concept Slop

Threshold indicating overlap for concepts, used when merging themes together. Lower values generate far more merges.

Min/Max range

0-1

Default value

0.8

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_CONCEPTSLOP;
oOption.fValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.ConceptSlop = float value

Java

Salience.Options.Base.setConceptSlop(float value)

Python

salience.setOption_ConceptSlop(session,float value, configuration ID)

Document Semantics

Use concept matrix for themes on a per document basis. If set to 1, will roll themes together.

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_USEDOCUMENTSEMANTICS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.UseSemantics = boolean value

Java

Salience.Options.Base.useSemantics(integer value)

Python

salience.setOption_DocumentSemantics(session,integer value, configuration ID)

Lists and Tables

Calculate if the document contains lists and tables.

Min/Max range

0 or 1

Default value

1

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_LISTSANDTABLES;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.CalculateListsAndTables = boolean value

Java

Salience.Options.Base.setCalculateListsAndTables(boolean value)

Python

salience.setOption_CalculateListsAndTables(session,integer value, configuration ID)

One Sentence

Process the entire document as a single sentence. This is good for Twitter and other microblog content which can consist of multiple sentence fragments. Defaults to false (0).

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_ONESENTENCE;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.ProcessAsOneSentence = boolean value

Java

Salience.Options.Base.setProcessAsOneSentence(boolean value)

Python

salience.setOption_ProcessAsOneSentence(session,integer value, configuration ID)

Shared Memory

Puts large data files into interprocess memory space for a smaller overall footprint. This option defaults to false on Windows and false on Linux.
NOTE: Use on Linux may require running the following command (as root or with sudo): /sbin/sysctl -w kernel.shmmax=4294967296

Min/Max range

0 or 1

Default value

0 (Linux), 0 (Windows)

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_SHAREDMEMORY;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.UseSharedMemory = boolean value

Java

Salience.Options.Base.setUseSharedMemory(boolean value)

Python

salience.setOption_UseSharedMemory(session,integer value, configuration ID)

Complex Stems

Enables the processing of words containing repeated characters (ex. "I loooovvvve Salience" into "I love Salience") at a cost of processing time. Also, specify a sentiment multiplier for the word in the complexstems.dat data file.

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_COMPLEXSTEMS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.ProcessComplexStems = boolean value

Java

Salience.Options.Base.setComplexStems(boolean value)

Python

salience.setOption_ProcessComplexStems(session,integer value, configuration ID)

Flatten All Upper Case

When set to true, if a sentence is encountered with all upper case tokens, it will be converted to lower case for better POS tagging. Recommended use is when user's documents contain many sentences with all upper case tokens (can be common in Twitter content) and shifting to lower case will provide more consistent POS tagging across upper case and lower case letters.

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_FLATTENALLUPPERCASE;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.FlattenAllUpperCase = boolean value

Java

Salience.Options.Base.setFlattenAllUpperCase(boolean value)

Python

salience.setOption_FlattenAllUpperCase(session,integer value, configuration ID)

Content HTML

By default, the content provided to Salience for processing must be plain text. Enabling this option allows HTML content to be provided to text preparation methods, either as a raw well-formed HTML string, or as path to an HTML file.

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_CONTENTHTML;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.ContentHTML = boolean value

Java

Salience.Options.Base.setContentHTML(boolean value)

Python

salience.setOption_ContentHTML(session,integer value, configuration ID)

Alternate Forms

Turns on internal alternate forms, allowing Salience to predict intended word choices, e.g. "to" instead of "too". On by default for short-form mode, off by default in default mode.

Min/Max range

0 or 1

Default value

0

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_ALTERNATEFORMS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.AlternateForms = boolean value

Java

Salience.Options.Base.setAlternateForms(boolean value)

Python

salience.setOption_AlternateForms(session,integer value, configuration ID)

Use Chainer

Salience uses a chaining algorithm to understand the connections between regions of a document, but especially in non-English content this can be a little slow. The chainer can be disabled to create a small performance boost at the cost of some degree of accuracy in things like summarization, sentiment assignment and theme detection.

Min/Max range

0 or 1

Default value

1

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_USECHAINER;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.UseChainer = boolean value

Java

Salience.Options.Base.setUseChainer(boolean value)

Python

salience.setOption_UseChainer(session,integer value, configuration ID)

Use Chunk Parser

Disables the chunk parser for a speedup at the cost of turning off intentions, weakening negation, and potentially more in the future.

Min/Max range

0 or 1

Default value

1

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_USECHUNKPARSER;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.UseChunkParser = boolean value

Java

Salience.Options.Base.setUseChunkParser(boolean value)

Python

salience.setOption_UseChunkParser(session,integer value, configuration ID)

Updated 7 months ago

Base Options


Suggested Edits are limited on API Reference Pages

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