Salience Five - Base options

Back to Options index | Concept 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.TextThreshold = integer value
Java Salience.Options.Base.setTaggingThreshold(integer value)
PHP salience_set_option($session, SALIENCEOPTION_TAGGINGTHRESHOLD, integer value)
Python saliencefive.setOption_TaggingThreshold(session,integer value)

Back to top

Glue Hyphens

NOTE: This option has been replaced with a modification to the datafiles. See the release notes for r5999 for more information.

Back to top

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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.MaxExecutionTime = integer value
Java Salience.Options.Base.setMaxExecutionTime(integer value)
PHP salience_set_option($session, SALIENCEOPTION_MAXEXECUTIONTIME, integer value)
Python saliencefive.setOption_MaxExecutionTime(session,integer value)

Back to top

Fail on Long Sentence

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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.FailOnLongSentences = boolean value
Java Salience.Options.Base.setFailLongSentence(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_FAILONLONGSENTENCE, integer value)
Python saliencefive.setOption_FailOnLongSentences(session,integer value)

Back to top

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 = <string value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.UserDirectory = string value
Java Salience.Options.Base.setUserDirectory(string value)
PHP salience_set_option($session, SALIENCEOPTION_USERDIRECTORY, string value)
Python saliencefive.setOption_UserDirectory(session,string value)

Back to top

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 = <float value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.ConceptSlop = float value
Java Salience.Options.Base.setConceptSlop(float value)
PHP salience_set_option($session, SALIENCEOPTION_CONCEPTSLOP, float value)
Python saliencefive.setOption_ConceptSlop(session,float value)

Back to top

Use 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.UseSemantics = boolean value
Java Salience.Options.Base.useSemantics(integer value)
PHP salience_set_option($session, SALIENCEOPTION_USEDOCUMENTSEMANTICS, integer value)
Python saliencefive.setOption_DocumentSemantics(session,integer value)

Back to top

Added in Salience 5.1

Calculate 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.CalculateListsAndTables = boolean value
Java Salience.Options.Base.setCalculateListsAndTables(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_LISTSANDTABLES, integer value)
Python saliencefive.setOption_CalculateListsAndTables(session,integer value)

Back to top

Process Document As 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.ProcessAsOneSentence = boolean value
Java Salience.Options.Base.setProcessAsOneSentence(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_ONESENTENCE, integer value)
Python saliencefive.setOption_ProcessAsOneSentence(session,integer value)

Back to top

Use 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.UseSharedMemory = boolean value
Java Salience.Options.Base.setUseSharedMemory(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_SHAREDMEMORY, integer value)
Python saliencefive.setOption_UseSharedMemory(session,integer value)

Back to top

Process 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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.ProcessComplexStems = boolean value
Java Salience.Options.Base.setComplexStems(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_COMPLEXSTEMS, integer value)
Python saliencefive.setOption_ProcessComplexStems(session,integer value)

Back to top

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.

NOTE: This option was added to most wrappers in 5.1 (r6700), with the exception of the PHP wrapper where the option appears in 5.1 (r6713).

Min/Max range 0 or 1
Default value 0
C API
SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_FLATTENALLUPPERCASE;
oOption.nValue = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.FlattenAllUpperCase = boolean value
Java Salience.Options.Base.setFlattenAllUpperCase(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_FLATTENALLUPPERCASE, integer value)
Python saliencefive.setOption_FlattenAllUpperCase(session,integer value)

Back to top

Added in Salience 5.1.1

Process HTML Content

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 = <integer value>;
lxaSetSalienceOption(pSession,&oOption);
.NET SalienceEngine.ContentHTML = boolean value
Java Salience.Options.Base.setContentHTML(boolean value)
PHP salience_set_option($session, SALIENCEOPTION_CONTENTHTML, integer value)
Python saliencefive.setOption_ContentHTML(session,integer value)

Back to top