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

Summary Options

These options have been added in order to provide greater control over the generation of document-level summaries.

Summary Delimiter

Changes the summary delimiter to user-provided string.

Min/Max range

N/A

Default value

"..."

C API

SalienceOption oOption;
oOption.nOption = SALIENCEOPTION_SUMMARYDELIMITER;
oOption.acValue = <char* variable>;
lxaSetSalienceOption(pSession,&oOption);

.NET

SalienceEngine.SummaryDelimiter = string value

Java

Salience.Options.Summaries.setDelimiter(string value)

Python

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

Summary Quotes Intact

When enabled, summary sentences that are part of a quote will include the entire quote.

Min/Max range

0 or 1

Default value

0 (false)

C API

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

.NET

SalienceEngine.SummaryQuotesIntact= boolean value

Java

Salience.Options.Summaries.setQuotesIntact(boolean value)

Python

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

Summary Minimum Sentences

Minimum length (in words) of a sentence to be used in summary.

Min/Max range

0-MAX_INT

Default value

4

C API

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

.NET

SalienceEngine.SummaryMinSentenceLength= integer value

Java

Salience.Options.Summaries.setMinSentenceLength(integer value)

Python

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

Summary Allow Initial Conjunction

If turned off, sentences starting with conjunctions are not used in summaries. By default, sentences that begin with a conjunction can be selected to appear in a summary.

Min/Max range

0 or 1

Default value

0 (true)

C API

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

.NET

SalienceEngine.SummaryAllowInitialConjunction= boolean value

Java

Salience.Options.Summaries.setAllowInitialConjunction(boolean value)

Python

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

Summary Early Sentence Count

Number of sentences considered "early" when generating summaries.

Min/Max range

0-MAX_INT

Default value

5

C API

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

.NET

SalienceEngine.SummaryEarlySentenceCount= integer value

Java

Salience.Options.Summaries.setEarlySentenceCount(integer value)

Python

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

Summary Early Sentence Bonus

Bonus to early sentences when generating summaries.

Min/Max range

0-2.0

Default value

0.8

C API

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

.NET

SalienceEngine.SummaryEarlySentenceBonus= float value

Java

Salience.Options.Summaries.setEarlySentenceBonus(float value)

Python

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

Summary Pronoun Penalty

Penalty for using pronouns in a sentence when selecting them for summaries.

Min/Max range

0 - 2.0

Default value

0

C API

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

.NET

SalienceEngine.SummaryPronounPenalty= float value

Java

Salience.Options.Summaries.setPronounPenalty(float value)

Python

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

Summary Ideal Length

Target summary sentence length (in words).

Min/Max range

0 (off), 8-15

Default value

0 (off)

C API

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

.NET

SalienceEngine.SummaryIdealLength= integer value

Java

Salience.Options.Summaries.setIdealLength(integer value)

Python

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

Summary Length Penalty

Penalty for deviating from target summary sentence length.

Min/Max range

0 - 0.2

Default value

0

C API

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

.NET

SalienceEngine.SummaryLengthPenalty= float value

Java

Salience.Options.Summaries.setLengthPenalty(float value)

Python

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

Summary Diversity

How strongly to encourage uniqueness in the sentences in a summary.

Min/Max range

0 - 0.7

Default value

0.5

C API

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

.NET

SalienceEngine.SummaryDiversity= float value

Java

Salience.Options.Summaries.setDiversity(float value)

Python

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

Updated 8 months ago

Summary Options


Suggested Edits are limited on API Reference Pages

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