Salience.GetNamedEntities

<< Salience.GetDocumentClasses | Back to Salience 6 .Net Index | Salience.GetNamedEntityRelationships >>

Summary

Performs entity extraction on the document. The entities returned are those determined on the basis of the entity extraction model provided with Salience 6. It also returns entities defined by any customer-defined list (CDL) files or pattern (PTN) files used to augment out-of-the-box entity extraction.
The id parameter is an optional parameter to specify which configuration to return results for. Content can be processed by multiple configurations in one pass by prior calls to Salience.AddSalienceConfiguration. Omitting this parameter or passing an empty string returns results based on the default configuration.
This method is a a wrapper around the underlying C API method lxaGetNamedEntities.

Syntax

public List<SalienceEntity> GetNamedEntities(String id="")
public List<SalienceEntity> GetNamedEntities(SalienceEntityParams Params, String id="")

Parameters

Params A SalienceEntityParams object containing parameters for entity extraction
id Optional: The identifier for a specific configuration for results.

Returns

If successful, returns a List<> of SalienceEntity objects containing information about the entities extracted from the content. Otherwise, an exception is thrown with information about the failure.

Example

TODO: Example needed for Salience 6

<< Salience.GetDocumentClasses | Back to Salience 6 .Net Index | Salience.GetNamedEntityRelationships >>