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

Entity Options

Suggest Edits

Required Entities

If set, only entities of the specified type (comma-delimited list) will be returned. Possible values are: Company, Person, Place, Sports, Product, Job Title, List, Regex, Pattern, Quote, Custom

Min/Max range

N/A

Default value

None

C API

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

.NET

SalienceEngine.RequiredEntities = string value

Java

Salience.Options.Entities.setRequiredEntities(string value)

Python

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

Anaphora Resolution

When set to true (1), Salience will connect entities to pronouns.

What we call anaphora, you might call pronouns, and Anaphora Resolution means counting those pronouns as instances of the mentions they refer to. This is usually what you want, but you can turn this feature off if you prefer. Sometimes you're more interested only in how often a company or person was called out explicitly by name.

Min/Max range

0 or 1

Default value

1

C API

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

.NET

SalienceEngine.AnaphoraResolution = boolean value

Java

Salience.Options.Entities.setAnaphoraResolution(boolean value)

Python

salience.setOption_AnaphoraResolution(session,boolean value, configuration ID)

CRF Sensitivity

Specifies a maximum for the number of potential relationships between candidate entities before the CRF model bails out. Exceeding the sensitivity threshold will result in a return code of LXA_WARNING_NO_CRF_ENTITIES from calls to retrieve named entities.

Min/Max range

10000-1000000

Default value

1000000

C API

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

.NET

SalienceEngine.ModelSensitivity = float value

Java

Salience.Options.Entities.setModelSensitivity(float value)

Python

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

Entity Threshold

Controls how confident Salience must be to return an entity.

Min/Max range

0 - 100

Default value

55

C API

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

.NET

SalienceEngine.EntityThreshold = integer value

Java

Salience.Options.Entities.setEntityThreshold(integer value)

Python

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

Entity Summary

Sets length in number of sentences for an entity summary (use 0 to turn this feature off).

Min/Max range

0 - MAX INT

Default value

3

C API

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

.NET

SalienceEngine.EntitySummaryLength = integer value

Java

Salience.Options.Entities.setEntitySummaryLength(integer value)

Python

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

Entity Overlap

Whether Named Entities can overlap each other regardless of their type, defaults to 0. e.g. "Ford Focus" => Car, "Ford" => Company would both hit if enabled.

Min/Max range

0 or 1

Default value

0

C API

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

.NET

SalienceEngine.EntityOverlap = boolean value

Java

Salience.Options.Entities.setEntityOverlap(boolean value)

Python

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

User Entity List

Path to user-defined entity list. See User Entity Lists for more information on the file format for user-defined entity lists. Please note that Basic Languages do not support the use of User Entity Lists.

Min/Max range

N/A

Default value

None

C API

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

.NET

SalienceEngine.EntityList = string value

Java

Salience.Options.Entities.setUserEntityList(string value)

Python

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

Sentiment Theme Overlap

By default, sentiment database entries can't include dictionary entries. Set this option to 1 to allow this behavior. "Good day" and "good" will both be seen as sentiment phrases.

Min/Max range

0 or 1

Default value

0

C API

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

.NET

SalienceEngine.SentimentThemeOverlap = boolean value

Java

Salience.Options.Entities.setOverlapSentimentThemes(boolean value)

Python

salience.setOption_OverlapSentimentThemes(session,boolean value, configuration ID)

Entity Topics

Whether or not to calculate topic matches for all entities.

Min/Max range

0 or 1

Default value

0 (off)

C API

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

.NET

SalienceEngine.EntityTopics = boolean value

Java

Salience.Options.Entities.setEntityTopics(boolean value)

Python

salience.setOption_EntityTopics(session,boolean value, configuration ID)

Stem User Entity Content

This option controls the stemming of the content when processing user entities. This option is turned on by default. When turned off, in content like "This is easier.", easier won't stem to easy.

Min/Max range

0 or 1

Default value

1 (content is stemmed)

C API

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

.NET

SalienceEngine.StemUserEntityContent = boolean value

Java

Salience.Options.Entities.setStemUserEntityContent(boolean value)

Python

salience.setOption_StemUserEntityContent(session,boolean value, configuration ID)

Entity Use User Directory Only

When turned on, allows named entities to operate using only the files from user/salience/entities rather than both the user and the data folders.

Min/Max range

0 or 1

Default value

0 (off)

C API

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

.NET

SalienceEngine.EntityUserDirectoryOnly = boolean value

Java

Salience.Options.Entities.setUserDirectoryOnly(boolean value)

Python

salience.setOption_EntityUserDirectoryOnly(session,boolean value, configuration ID)

Entity Themes

When enabled, themes connected to each entity will be connected. If you are not using entity themes, this option can be disabled for faster processing.

Min/Max range

0 or 1

Default value

1 (on)

C API

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

.NET

SalienceEngine.EntityThemes = boolean value

Java

Salience.Options.Entities.setEntityThemes(boolean value)

Python

salience.setOption_EntityThemes(session,boolean value, configuration ID)

User Entity Ignore Accents

When set to true (1), Salience will match user entities without regard for accents/diacritics.

Min/Max range

0 or 1

Default value

0

User Entity Attributes

C API

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

.NET

SalienceEngine.UserEntityIgnoreAccents = boolean value

Java

Salience.Options.Entities.setIgnoreAccents(boolean value)

Python

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

Updated 3 months ago

Entity Options

Suggested Edits are limited on API Reference Pages

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