SalienceCollection.GetEntities

<< SalienceCollection.GetThemes | Back to Salience 6 .Net Index | SalienceCollection.GetFacets >>

Summary

Returns the entities from collection based on model-based or datafile-based entity extraction. Parameters to control entity extraction should be specified by setting Entity Options. Other adjustments can be made through the available Collection Options, which must be set before this call is made.
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 lxaGetCollectionEntities.

Syntax

public List<SalienceCollectionEntity> GetEntities(String id="")

Parameters

id Optional: The identifier for a specific configuration for results.

Returns

If successful, a List<> of SalienceCollectionEntity objects is returned. Otherwise, an exception is thrown with information about the failure.

Example

TODO: Example needed for Salience 6

<< SalienceCollection.GetThemes | Back to Salience 6 .Net Index | SalienceCollection.GetFacets >>