EntityExtractionSettings Class

Entity extraction settings.

Definition

Namespace: OpenDiscoverSDK.Interfaces.Settings.TextAnalytics
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2026.2.6.0 (2026.02.06)

C#

[DataContractAttribute]
public class EntityExtractionSettings

Inheritance: Object EntityExtractionSettings

Remarks

The entity extractions provided by the Open Discover SDK are not purposed or intended to satisfy any state or federal personally identifiable information (PII), PHI, nor FERPA regulatory requirements.

Constructors

EntityExtractionSettings	Constructor.
EntityExtractionSettings(EntityExtractionSettings)	Constructor. Initializes this object with the values of another instance.

Properties

CustomEntityDefinitions	Custom entity definitions. To use these custom item definitions they MUST be loaded using method OpenDiscoverSDK.ContentExtractorFactory.LoadCustomEntityDefinitions once in a process BEFORE starting any content extraction on process threads.
CustomEntityExtractionEnabled	If true, enables custom entity detection and extraction
DeduplicateEntityItems	If enabled (true) then duplicate entity items are not included in results. See remarks.
Enabled	If true, entity extraction is enabled. If false, no entity extraction is performed in extracted text nor metadata.
EnableEmojiEntityDetection	If enabled (true) then emoji entity items will be detected (default value is true). If false, emoji entities will not be detected and returned in results.
EnableExtractedEntityTypeFilter	If enabled, true, the SDK will filter-out entity types (EntityType) in the Items property that are NOT in the ExtractedEntityTypeFilter hash set. If false, then Items property is not filtered by EntityType.
EnablePersonNameFinder	If enabled the SDK will attempt to find person names without context. If enabled, this will lead to some degradation in document processing speed performance.
EnablePersonNameFinderInBinaryToText	If enabled the SDK will attempt to find person names in binary-to-text filtered documents. Binary-to-text filtered files have lots of "noise", enabling this feature may lead to lots of false postives.
EnableRelaxedCreditCardDetectionMode	If enabled, less stringent rules are used to find credit card number entities, i.e., the Luhn check is not used to verify the card number checksum (default value is true). This will lead to more false positives but improve entity detection as some card numbers no longer use the Luhn check.
EnableRelaxedStructuredDataMode	If enabled, less stringent rules are used to find column based entities in structured tabular formats such as spreadsheets and database files (default value is true). This will lead to more false positives but improve entity detection.
ExtractedEntityTypeFilter	If EnableExtractedEntityTypeFilter is true, only entity types (EntityType) in this property HashSet are extracted and returned by Items property. If EnableExtractedEntityTypeFilter is false, then this property is ignored.

Methods

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
ToString	Returns a string that represents the current object. (Inherited from Object)