Salience 6 python Wrapper options

Back to Salience 6 python Index

Base options

setOption_TaggingThreshold(session, nThreshold, acConfigurationID)

Salience rejects documents with high density of symbols. Defaults to 80, lower values are less picky about symbols.

Back to top

setOption_CalculateListsAndTables(session, nCalculate, acConfigurationID)

Calculate if the document contains lists and tables.

Back to top

setOption_MaxExecutionTime(session, nTimeout, acConfigurationID)

Maximum time in milliseconds certain functions are allowed to run for.

Back to top

setOption_FailOnLongSentences(session, nProcess, acConfigurationID)

When a document contains a very long sentence, should you process the rest of the document? (0=process)

Back to top

setOption_UserDirectory(session, sUserDir, acConfigurationID)

Sets path to user directory of customizations.

Back to top

setOption_ConceptSlop(session, fValue, acConfigurationID)

Threshold indicating overlap for concepts, used when merging themes together. Lower values generate far more merges. fValue should be between 0 and 1.

Back to top

setOption_DocumentSemantics(session, nUseSemantics, acConfigurationID)

Use concept matrix for themes on a per document basis. If set to 1, will roll themes together.

Back to top

setOption_ProcessAsOneSentence(session, nProcess, acConfigurationID)

Process the entire document as a single sentence. This is good for Twitter and other microblog content which can consist of multiple sentence fragments.

Back to top

setOption_UseSharedMemory(session, nUseSharedMemory, acConfigurationID)

Puts large data files into interprocess memory space for a smaller overall footprint. This option defaults to true on Windows, false on Linux.
NOTE: Use on Linux may require running the following command (as root or with sudo): /sbin/sysctl -w kernel.shmmax=4294967296.

Back to top

setOption_ProcessComplexStems(session, nProcessComplexStems, acConfigurationID)

Enables the processing of words containing repeated characters (ex. "I loooovvvve Salience" into "I love Salience") at a cost of processing time. New datafile allows sentiment multiplier to be specified for occurrences.

Back to top

setOption_FlattenAllUpperCase(session, nFlattenAllUpperCase, acConfigurationID)

Flattens upper case content to lower case for improved POS tagging.

Back to top

setOption_ContentHTML(session, nHTMLContent, acConfigurationID)

Enable processing of HTML content.

Back to top

setOption_AlternateForms(session, nAlternateForms, acConfigurationID)

Allow the internal use of possible intended versus observed word choices (e.g. "there" vs. "their").

Back to top

Concept options

setOption_MaxConceptTopicHits(session, nMaxHits, acConfigurationID)

Limit of concept topic results to return..

Back to top

setOption_MinConceptTopicScore(session, fScore, acConfigurationID)

Minimum score to accept a concept topic to document link.

Back to top

setOption_ConceptTopicWindowSize(session, nSize, acConfigurationID)

Smaller values allow small, on topic text to match concepts for the whole document.

Back to top

setOption_ConceptTopicWindowJump(session, nJump, acConfigurationID)

Smooths out the window feature, at a slight performance hit. Should never be larger than window size.

Back to top

setOption_NongrammaticalTopics(session, nValue, acConfigurationID)

Set to 0 if your concept topics are defined by sentences, 1 if they are collections of words.

Back to top

setOption_ConceptTopicList(session, sPath, acConfigurationID)

List of concept topic definitions (or path to a file containing them).

Back to top

Entity options

setOption_RequiredEntities(session, sEntityTypes, acConfigurationID)

List of entities you want reported (leave empty if you want all of them).

Back to top

setOption_AnaphoraResolution(session, nLink, acConfigurationID)

Whether to link pronouns and entities.

Back to top

setOption_EntityModelSensitivity(session, nValue, acConfigurationID)

A value between 0 and 100, controls tradeoff between getting good results on problematic documents or maintaining fast throughput (100 accepts the highest degradation).

Back to top

setOption_EntityThreshold(session, nValue, acConfigurationID)

A value between 0 and 100, controls how confident Salience must be to return an entity.

Back to top

setOption_EntitySummaryLength(session, nLength, acConfigurationID)

How many sentences to include in entity summaries (0 to turn the feature off)

Back to top

setOption_EntityOverlap(session, nValue, acConfigurationID)

Whether User Entities can overlap each other.

Back to top

setOption_UserEntityList(session, sPath, acConfigurationID)

List or path to file of User Entity Definitions.

Back to top

setOption_OverlapSentimentThemes(session, nValue, acConfigurationID)

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.

Back to top

setOption_EntityTopics(session, bEntityTopics, acConfigurationID)

Whether or not to calculate topic matches for all entities.

Back to top

setOption_StemUserEntityContent(session, nStemUserEntityContent, acConfigurationID)

Whether to stem the content provided when processing user entities.

Back to top

setOption_EntityUserDirectoryOnly(session, nEntityUserDirectoryOnly, acConfigurationID)

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

Back to top

Sentiment options

setOption_SetSentimentDictionary(session, sPath, acConfigurationID)

All subsequent sentiment analysis will use the specified sentiment dictionary.

Back to top

setOption_AddSentimentDictionary(session, sPath, acConfigurationID)

Adds additional sentiment dictionaries to be used in sentiment analysis.

Back to top

setOption_AddSentimentModel(session, sPath, acConfigurationID)

Uses a different compiled sentiment model file for sentiment analysis.

Back to top

setOption_ClearSentimentModel(session, acConfigurationID)

Turns off model based sentiment analysis.

Back to top

setOption_UpperNeutralScore(session, fScore, acConfigurationID)

Sets the upper bound for a document to be considered neutral. Defaults to 0.5

Back to top

setOption_LowerNeutralScore(session, fScore, acConfigurationID)

Sets the lower bound for a document to be considered neutral. Defaults to -0.45

Back to top

setOption_UsePolarityModel(session, nPolarityModel, acConfigurationID)

Includes a measure of whether a sentence 'looks' like the sort of sentence that usually communicates sentiment in analysis. Defaults to false (0).

Back to top

setOption_AllSentimentPhrases(session, nAllSentimentPhrases, acConfigurationID)

Enables the user to get all possible sentiment phrases back from GetSentiment, even ones that aren't in the dictionary. Defaults to false (0).

Back to top

setOption_EmphaticModifier(session, fModifier, acConfigurationID)

Enables the user to adjust the multiplier for emphatic modifiers (such as exclamation marks). Defaults to 2.

Back to top

setOption_SuperlativeModifier(session, fModifier, acConfigurationID)

Enables the user to adjust the multiplier for superlative phrases. Defaults to 1.25.

Back to top

Query options

setOption_QueryTopicStemming(session, nValue, acConfigurationID)

Whether queries should be stemmed or not (can also be disabled at a per query level)

Back to top

setOption_QueryTopicList(session, sPath, acConfigurationID)

List or path to file of Query Topic Definitions

Back to top

setOption_MaxQueryLength(session, sPath, acConfigurationID)

Sets a limit (in bytes) on query topic definition. By default, the limit is 10240 bytes.

Back to top

Collection options

setOption_CollectionResultSize(session, nSize, acConfigurationID)

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

Back to top

setOption_CollectionSemantics(session, nValue, acConfigurationID)

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

Back to top

setOption_MaxCollectionSize(session, nSize, acConfigurationID)

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

Back to top

setOption_ReturnAllThemeMentions(session, nReturnAllMentions, acConfigurationID)

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

Back to top

setOption_StemFacets(session, nStemFacets, acConfigurationID)

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

Back to top

Theme options

setOption_ThemeTopics(session, nThemeTopics, acConfigurationID)

Whether or not to calculate topic matches for all themes.

Back to top

Category options

setOption_CategoryExplanation(session, nExplainCategory, acConfigurationID)

Turns on additional explanation in document category results. Defaults to 1 (false).

Back to top

Summary options

setOption_SummaryDelimiter(session, sSummaryDelimiter, acConfigurationID)

Changes the summary delimiter to user-provided string.

Back to top

setOption_SummaryQuotesIntact(session, nSummaryQuotesIntact, acConfigurationID)

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

Back to top

setOption_SummaryMinSentenceLength(session, nMinSentenceLength, acConfigurationID)

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

Back to top

setOption_SummaryAllowInitialConjunction(session, nAllowInitialConjunction, acConfigurationID)

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.

Back to top

setOption_SummaryEarlySentenceCount(session, nEarlySentenceCount, acConfigurationID)

Number of sentences considered "early" when generating summaries.

Back to top

setOption_SummaryEarlySentenceBonus(session, fEarlySentenceBonus, acConfigurationID)

Bonus to early sentences when generating summaries.

Back to top

setOption_SummaryPronounPenalty(session, fPronounPenalty, acConfigurationID)

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

Back to top

setOption_SummaryIdealLength(session, nIdealLength, acConfigurationID)

Target summary sentence length (in words).

Back to top

setOption_SummaryLengthPenalty(session, fLengthPenalty, acConfigurationID)

Penalty for deviating from target summary sentence length.

Back to top

setOption_SummaryDiversity(session, fDiversity, acConfigurationID)

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

Back to top

Document details options

setOption_StemDocDetails(session, nStem, acConfigurationID)

Returns n-grams in document details in their stemmed or unstemmed forms. By default, this option is turned on (1) to maintain previous behavior.

Back to top

Classification options

setOption_ClassificationThreshold(session, nThreshold, acConfigurationID)

A value from 1-100 that sets a threshold for classification results.

Back to top

setOption_ClassificationModel(session, sModel, acConfigurationID)

Sets the path to a Salience 6 compatible model to use for document classification.

Back to top


Back to Salience 6 python Index