Collection Options

Collection Result Size

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

Min/Max range0-MAX INT
Default value20
C APISalienceOption oOption;
oOption.nOption = SALIENCEOPTION_COLLECTIONRESULTSIZE;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);
.NETSalienceCollection.CollectionResultSize = integer value (Note: this option can be set only on a SalienceCollection object.)
JavaSalience.Options.Collections.setResultSize(integer value)
Pythonsalience.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 range0 or 1
Default value0
C APISalienceOption oOption;
oOption.nOption = SALIENCEOPTION_USECOLLECTIONSEMANTICS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);
.NETSalienceCollection.UseSemantics = boolean value (Note: this option can be set only on a SalienceCollection object.)
JavaSalience.Options.Collections.setUseSemantics(boolean value)
Pythonsalience.setOption_CollectionSemantics(session,integer value, configuration ID)

Max Collection Size

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

Min/Max range0 to MAX-INT
Default value50000
C APISalienceOption oOption;
oOption.nOption = SALIENCEOPTION_MAXCOLLECTIONSIZE;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);
.NETSalienceCollection.MaxCollectionSize = integer value (Note: this option can be set only on a SalienceCollection object.)
JavaSalience.Options.Collections.setMaxCollectionSize(integer value)
Pythonsalience.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 range0 or 1
Default value1
C APISalienceOption oOption;
oOption.nOption = SALIENCEOPTION_ALLTHEMEMENTIONS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);
.NETSalienceCollection.ReturnAllThemeMentions = boolean value (Note: this option can be set only on a SalienceCollection object.)
JavaSalience.Options.Collections.setAllThemeMentions(boolean value)
Pythonsalience.setOption_ReturnAllThemeMentions(session,integer value, configuration ID)

Stem Facets

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

Min/Max range0 or 1
Default value1 (true)
C APISalienceOption oOption;
oOption.nOption = SALIENCEOPTION_STEMFACETS;
oOption.nValue = ;
lxaSetSalienceOption(pSession,&oOption);
.NETSalienceCollection.StemFacets = boolean value (Note: this option can be set only on a SalienceCollection object.)
JavaSalience.Options.Collections.setStemFacets(boolean value)
Pythonsalience.setOption_StemFacets(session,integer value, configuration ID)