lxaGetUserDefinedEntities

<< lxaGetNamedEntityOpinions | Back to Salience 6 C API Index | lxaGetUserEntityRelationships >>

Summary

Retrieves the user-defined entities from text. This is based on the entity list specified through the User Entity List option. Other parameters to control entity extraction should be specified by setting additional Entity Options. These options must be set before calling this method.
The method sets the pEntities member of the passed in SalienceEntityList to point to an array of SalienceEntity 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 lxaFreeEntityList.

Syntax

int lxaGetUserDefinedEntities(SalienceSession *pSession, 
                              SalienceEntityList *pResults,
                              const char *acConfigurationID);

Parameters

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

Returns

This method returns an integer return code.

Example

TODO: Update example needed for Salience 6

<< lxaGetNamedEntityOpinions | Back to Salience 6 C API Index | lxaGetUserEntityRelationships >>