Collection Options

Collection Result Size

Maximum number of collection results to return for an API call.

Min/Max range

0-MAX INT

Default value

20

C API

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

.NET

SalienceCollection.CollectionResultSize = integer value (Note: this option can be set only on a SalienceCollection object.)

Java

Salience.Options.Collections.setResultSize(integer value)

Python

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

Collection Semantics

Flag to indicate whether or not to use semantic capabilities to enhance collection results.

Min/Max range

0 or 1

Default value

0

C API

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

.NET

SalienceCollection.UseSemantics = boolean value (Note: this option can be set only on a SalienceCollection object.)

Java

Salience.Options.Collections.setUseSemantics(boolean value)

Python

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

Max Collection Size

Maximum number of documents that can be included in a single collection.

Min/Max range

0 to MAX-INT

Default value

50000

C API

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

.NET

SalienceCollection.MaxCollectionSize = integer value (Note: this option can be set only on a SalienceCollection object.)

Java

Salience.Options.Collections.setMaxCollectionSize(integer value)

Python

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

All Theme Mentions

When enabled, Collections include every occurrence of every theme in result structure. Otherwise, it returns one occurrence for every unique theme text.

Min/Max range

0 or 1

Default value

1

C API

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

.NET

SalienceCollection.ReturnAllThemeMentions = boolean value (Note: this option can be set only on a SalienceCollection object.)

Java

Salience.Options.Collections.setAllThemeMentions(boolean value)

Python

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

Stem Facets

Controls stemming of facets and attributes. Defaults to true (enable stemming).

Min/Max range

0 or 1

Default value

1 (true)

C API

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

.NET

SalienceCollection.StemFacets = boolean value (Note: this option can be set only on a SalienceCollection object.)

Java

Salience.Options.Collections.setStemFacets(boolean value)

Python

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