How to Extract/Add Custom Entities

• About

• How to Configure Custom Entity Extraction

• How to Use Predefined Entities to Enrich Content

• How to Add Custom Entities

• Custom Entities Format Example CSV

  • Simple

  • Simple with Translation

  • Searching on Multiple Entities

  • Searching with Multiple Output Values

• Custom Entities Format Example SQL

  • Simple

  • Searching on Multiple Entities

  • Searching with Multiple Output Values

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:
   1. 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: Provider a database connection string
   2. Select Query:  Provide a select statement to define entity Values
      1. Example: SELECT EntityName from Entities
5. Input properties:
   1.  Specify the input properties, such as body, Heading, etc., that are used to send the web service request.
   2. Property names must be separated by commas (,).
   3. If an external web service expects a property with a different name, the following syntax can be used: originalName->modifiedName
6. Output property:
   1. Specify the output properties that are expected in the web service response.
   2. The property names must be separated by a comma (,).
7. Append Data to Output Property:
   1. Click to enable.
8. Include Counts:
   1. Check this option to have returned entities include a count.
      Examples:
      
      1. UnChecked:  Gold, Silver, Diamond
      2. Checked: 10;Gold, 4;Silver, 1;Diamond
         
9. De-Duplicate Entities: Click to remove any duplicate entities.
   1. 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.

How to Use Predefined Entities to Enrich Content

You can use predefined entities for content enrichment and to import entities on the Custom Entities page:

1. Go to the Custom Entities page:
   
   
2. Browse for a CSV file containing the entities definition.
   The name of the CSV file is used as the entity name.
   
   
   
3. Click Import Entities
   
4. Add the Component.
5. <Your Component>>Existing Components:
   
   
6. Name: Click on the name of the feature that you are configuring with custom entities, such as CE:


7. Entity Name: Select an imported entity.
   
8. Input Properties: Specify as a comma (,) separated list.
   
9. Output Property: Specify.
   
10. Append Data to Output Property: Append the extracted entities to the output property or overwrite the output property with the extracted entities.
    
11. De-Duplicate Entities: Remove all duplicate entities from the output. If an entity is part of another entity such as York and New York, only New York is returned.

How to Add Custom Entities

Use this page to import a .csv file of custom entities that you create and want to use with Custom Entity Extraction.

1. Custom Entities: Click to see the Custom Entities page.
   
   
   
2. Choose File: Click to select a custom entities file to import.
3. Import Entities: Click to populate the Custom Entities table above.

Custom Entities Format Example CSV

Simple

Extract Common Entity by name.

This example extracts "United States" and/or "Canada" when matched within the source.



Results

Simple with Translation

Results

Searching on Multiple Entities

OR

Results

Searching with Multiple Output Values

Results

Custom Entities Format Example SQL

Simple

Extract Common Entity by name.

This example extracts "United States" and/or "Canada" when matched within the source.



Results

Simple with Translation

Results

Searching on Multiple Entities

Results

Searching with Multiple Output Values

Results