How to Extract/Add Custom Entities

• About

• How to Configure Custom Entity Extraction

About

The Custom Entity Extraction (CEE) component extracts entities from any input text based on a list of entity names.

• Adding the Custom Entity Extraction (CEE) component and outside databases that contain predefined values speeds up the tagging process.
• This component automatically extracts entities that are defined by a list of entity names.

How to Configure Custom Entity Extraction

Use the following instructions to configure the Custom Entity Extraction component.

1. Add the Component.
2. Existing Components: Click the named link for this component to see the Configuration section:
   
3. Entity Name: Select the Predefined Entity Radio button and click the drop-down arrow to select the name of the entity.
4. SQL: Select the External Database Radio button:
   1. Connection String: Provide a database connection string.
   2. Select Query:  Provide a select statement to define entity Values.
      1. Example: SELECT EntityName from Entities
5. Input properties: Specify the input properties, such as body, Heading, etc., that are used to send the web service request. Each property name must be separated by commas (,). If an external web service expects a property with a different name, the following syntax can be used: originalName->modifiedName.
6. Output property: Specify the output properties that are expected in the web service response. Each property name must be separated by a comma (,).
7. Append Data to Output Property :Click to enable appending data to the output property.
8. Include Counts: Check this option to have returned entities include a count. For example:
   1. UnChecked: Gold, Silver, Diamond
   2. Checked: 10;Gold, 4;Silver, 1;Diamond
      
9. De-Duplicate Entities: Click to remove any duplicate entities. For example, when using Entity Values "New York", "York", "Boston"
   1. If the search text contains "York":
      1. Unchecked: York, New York
      2. Checked: New York
10. Apply: Click to apply your changes and see a confirmation message.
11. Validate: Click to validate your changes and see a confirmation message.
    1. Input Properties: Based on configuration.
    2. Output Properties: Based on configuration.
    3. Select these entities using the drop-down list.
    4. For more information, see Using predefined entities.