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

lxaFreeString

Summary

This function frees the memory associated with the string. It is provided so that programs compiled with a different version of C Runtime libraries can free strings allocated by Salience. It is a wrapper for free().

Syntax

int lxaFreeString(char* acBuffer);

Parameters

acBuffer

Pointer to a char* buffer to be freed

Returns

This method returns an integer return code.

Example

See example code in [lxaLoadLicense] for usage.

lxaFreeLicense

Summary

This function frees the memory associated with the LexalyticsLicense structure.

Syntax

int lxaFreeLicense(LexalyticsLicense* pLicense);

Parameters

pLicense

Pointer to a LexalyticsLicense to be freed

Returns

This method returns an integer return code.

Example

TODO: Example needed for Salience 6

lxaFreeEntityList

Summary

This function frees the memory associated with a SalienceEntityList structure. This structure is filled in by calls to lxaGetNamedEntities and lxaGetUserDefinedEntities, and must be called to free memory allocated by these results.

Syntax

int lxaFreeEntityList(SalienceEntityList* pResults);

Parameters

pResults

Pointer to a SalienceEntityList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetNamedEntities for usage.

lxaFreeCollectionEntityList

Summary

This function frees the memory associated with a SalienceCollectionEntityList structure. This structure is filled in by calls to lxaGetCollectionEntities, and must be called to free memory allocated by these results.

Syntax

int lxaFreeCollectionEntityList(SalienceCollectionEntityList* pResults);

Parameters

pResults

Pointer to a SalienceCollectionEntityList to be freed

Returns

This method returns an integer return code.

Example

TODO: Example needed for Salience 6

lxaFreeThemeList

Summary

This function frees the memory associated with a SalienceThemeList structure. This structure is filled in by calls to lxaGetThemes and lxaGetCollectionThemes, and must be called to free memory allocated by these results.

Syntax

int lxaFreeThemeList(SalienceThemeList* pThemesList);

Parameters

pThemesList

Pointer to a SalienceThemeList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetThemes for usage.

lxaFreeFacetList

Summary

This function frees the memory associated with a SalienceFacetList structure. This structure is filled in by calls to lxaGetCollectionFacets, and must be called to free memory allocated by these results.

Syntax

int lxaFreeFacetList(SalienceFacetList* pFacetList);

Parameters

pFacetList

Pointer to a SalienceFacetList to be freed

Returns

This method returns an integer return code.

Example

TODO: Example needed for Salience 6

lxaFreeRelationList

Summary

This function frees the memory associated with a SalienceRelationList structure. This structure is filled in by calls to lxaGetNamedEntityRelationships and lxaGetUserEntityRelationships, and must be called to free memory allocated by these results.

Syntax

int lxaFreeRelationList(SalienceRelationList* pRelationList);

Parameters

pResults

Pointer to a SalienceRelationList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetNamedEntityRelationships for usage.

lxaFreeOpinionList

Summary

This function frees the memory associated with a SalienceOpinionList structure. This structure is filled in by calls to lxaGetNamedEntityOpinions and lxaGetUserEntityOpinions, and must be called to free memory allocated by these results.

Syntax

int lxaFreeOpinionList(SalienceOpinionList* pOpinionList);

Parameters

pOpinionList

Pointer to a SalienceOpinionList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetNamedEntityOpinions for usage.

lxaFreeSentimentResult

Summary

This function frees the memory associated with a SalienceSentimentResult structure. This structure is filled in by calls to lxaGetSentiment, and must be called to free memory allocated by these results.

Syntax

int lxaFreeSentimentResult(SalienceSentimentResult* pResult);

Parameters

pResult

Pointer to a SalienceSentimentResult to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetSentiment for usage.

lxaFreeDocumentDetails

Summary

This function frees the memory associated with a SalienceDocumentDetails structure. This structure is filled in by calls to lxaGetDocumentDetails, and must be called to free memory allocated by these results.

Syntax

int lxaFreeDocumentDetails(SalienceDocumentDetails* pDetails);

Parameters

pDetails

Pointer to a SalienceDocumentDetails to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetDocumentDetails for usage.

lxaFreeTopicList

Summary

This function frees the memory associated with a SalienceTopicList structure. This structure is filled in by calls to lxaGetQueryDefinedTopics, lxaGetConceptDefinedTopics, lxaGetCollectionQueryDefinedTopics, and lxaGetCollectionConceptDefinedTopics and must be called to free memory allocated by these results.

Syntax

int lxaFreeTopicList(SalienceTopicList* pTopicList);

Parameters

pTopicList

Pointer to a SalienceTopicList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetQueryDefinedTopics for usage.

lxaFreeDocument

Summary

This function frees the memory associated with a SalienceDocument structure. This structure is filled in by calls to retrieve markup text such as lxaGetNamedEntityMarkup, lxaGetUserEntityMarkup, lxaGetPOSMarkup, and lxaGetSentimentMarkup and must be called to free memory allocated by these results.

Syntax

int lxaFreeDocument(SalienceDocument* pDocument);

Parameters

pDocument

Pointer to a SalienceDocument to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetNamedEntityMarkup for usage.

lxaFreeSummaryResult

Summary

This function frees the memory associated with a SalienceSummaryResult structure. This structure is filled in by calls to retrieve a document-level summary via lxaGetSummary and must be called to free memory allocated by these results.

Syntax

int lxaFreeSummaryResult(SalienceSummaryResult* pSummaryResult);

Parameters

pSummaryResult

Pointer to a SalienceSummaryResult to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetSummary for usage.

lxaFreeIntentionList

Summary

This function frees the memory associated with a SalienceIntentionList structure. This structure is filled in by calls to lxaGetIntentions and must be called to free memory allocated by these results.

Syntax

int lxaFreeIntentionList(SalienceIntentionList* pIntentionList);

Parameters

pIntentionList

Pointer to a SalienceIntentionList to be freed

Returns

This method returns an integer return code.

Example

See example code in lxaGetIntentions for usage.

Updated 7 months ago

Free


Suggested Edits are limited on API Reference Pages

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