lxaGetCollectionUserEntities

<< lxaGetCollectionEntities | Back to Salience 6 C API Index | lxaGetNamedEntityMarkup >>

Summary

Retrieves the user-defined entities from the collection. This is based on the entity list specified through the User Entity List option. Other adjustments can be made through the available Collection Options, which must be set before this call is made.
Sets the pEntities member of the passed in SalienceCollectionEntityList to point to an array of SalienceCollectionEntity structures. The nLength member is set to the length of this array.
The acConfigurationID parameter specifies the configuration for the results. Configurations are defined using the method lxaAddSalienceConfiguration.
After use you should free the allocated memory by calling lxaFreeCollectionEntityList.

Syntax

int lxaGetCollectionUserEntities(SalienceSession *pSession, 
                                 SalienceCollectionEntityList *pResults,
                                 const char *acConfigurationID);

Parameters

pSession Pointer to a SalienceSession structure previously returned by a call to lxaOpenSalienceSession
pResults Pointer to a SalienceCollectionEntityList structure that will get filled in by the call
acConfigurationID Character string specifying the configuration for the results, blank for the default configuration

Returns

LXA_OK Entity extraction completed successfully.
LXA_OK_WITH_WARNINGS There was a non-fatal issue with entity extraction. Use lxaGetLastWarnings to determine the cause of the warning.

Example

TODO: Example needed for Salience 6

<< lxaGetCollectionEntities | Back to Salience 6 C API Index | lxaGetNamedEntityMarkup >>