C API Reference

The Salience 6 API is provided to you for local integration of your applications with advanced NLP text analytics. At its core the API is built using C. However, we do provide wrappers for C# (.NET), Java, and Python that allow for direct integration in those languages.

C API

The C API is provided as a set of header files and libraries, and is the lowest level of integration to the text analytics engine available to customers.

Wrappers

The wrappers allow for simple integration into applications developed in higher-level languages.

Note: The Salience 6 distributions contain pre-compiled .Net, Java, and python wrappers, as well as the source code for these wrappers.

lxaLoadLicense
lxaOpenSalienceSession
lxaCloseSalienceSession
lxaGetSalienceVersion
lxaGetDefaultSalienceLocation
lxaAddSalienceConfiguration
lxaRemoveSalienceConfiguration

lxaPrepareText
lxaPrepareTextFromFile
lxaAddSection
lxaAddSectionFromFile
lxaCorrectOCRErrors
lxaPrepareCollection
lxaPrepareCollectionFromFile

lxaGetDocumentDetails
lxaGetSummary
lxaGetSentiment
lxaGetThemes
lxaGetQueryDefinedTopics
lxaGetConceptDefinedTopics
lxaExplainConceptMatches
lxaGetDocumentCategories
lxaGetDocumentClasses
lxaGetIntentions

lxaGetNamedEntities
lxaGetNamedEntityRelationships
lxaGetNamedEntityOpinions
lxaGetUserDefinedEntities
lxaGetUserEntityRelationships
lxaGetUserEntityOpinions

lxaGetCollectionDetails
lxaGetCollectionThemes
lxaGetCollectionFacets
lxaGetCollectionQueryDefinedTopics
lxaGetCollectionConceptDefinedTopics
lxaGetCollectionEntities
lxaGetCollectionUserEntities

lxaGetNamedEntityMarkup
lxaGetUserEntityMarkup
lxaGetPOSMarkup
lxaGetSentimentMarkup
lxaGetNamedOpinionTaggedText
lxaGetUserOpinionTaggedText

lxaFreeString
lxaFreeLicense
lxaFreeEntityList
lxaFreeCollectionEntityList
lxaFreeThemeList
lxaFreeFacetList
lxaFreeRelationList
lxaFreeOpinionList
lxaFreeSentimentResult
lxaFreeDocumentDetails
lxaFreeTopicList
lxaFreeDocument
lxaFreeSummaryResult
lxaFreeIntentionList

lxaSetSalienceOption
lxaDumpEnvironment
lxaGetSalienceErrorString
lxaGetLastWarnings
lxaSetSalienceCallback
lxaSetSalienceOptionWithString
lxaSetSalienceOptionsWithFile

LexalyticsLicense
ModelSmokeTestEntry
OCRCharacterAttribute
SalienceAttribute
SalienceChunk
SalienceCollectionDetails
SalienceCollectionEntity
SalienceDocument
SalienceDocumentDetails
SalienceEntity
SalienceEntityAttribute
SalienceFacet
SalienceIntention
SalienceMention
SalienceOpinion
SalienceOption
SaliencePhrase
SalienceRelation
SalienceRow
SalienceSection
SalienceSentence
SalienceSentimentModel
SalienceSentimentResult
SalienceSentimentPhrase
SalienceSession
SalienceSessionStartup
SalienceSummaryResult
SalienceTheme
SalienceToken
SalienceTopic
SalienceWord

SalienceCollectionEntityList
SalienceEntityList
SalienceEntityAttributeList
SalienceFacetList
SalienceIntentionList
SalienceMentionList
SalienceOpinionList
SaliencePhraseList
SalienceRelationList
SalienceRowList
SalienceSentimentPhraseList
SalienceThemeList
SalienceTokenList
SalienceTopicList
ModelSmokeTestList
OCRCharacterAttributeList