Create an Entity

  • Select the group to associate the new entity with.

  • Select New Entity button

Details

  1. Enter a Friendly Name for the entity.

    • We recommend a brief description of the entity.

  2. Enter a Name for the entity.

    • This will be displayed under the friendly name.

  3. Select the data type from the Type dropdown

    • Choose between Keyword, Long, Double, DateTime GeoPoint, Text, Float, User or Uri.

  4. Check Enabled to make this entity usable.

  5. Check Lower Case Value if the case of the entity does not matter.

    • This is used by document links.

  6. Check Search Suggestions for entities of this type to appear in search suggestions.

Depending on the type selected you can determine if it's searchable as text or keyword. If the field value appears in text content or data, you won't need to make the field searchable.

  1. Searchable as Text - If checked, users can find this field using a text query.

  2. Searchable as Keyword - If checked, users can find this field as a non case-sensitive keyword.

  3. Select Next.

Permissions

  1. In most cases the permission can be left empty.

    • Reach out to your Aiimi contact for more information.

  2. Select Next.

Extraction

Trie Entity Extractor or PCI Extractor

If you are using a Trie Entity Extractor or PCI Extractor then you will need to configure extraction properties for the entity.

  • Dictionary Extraction - For a dictionary of terms select List of Terms and either upload your list or add them manually.

  • Regular Expression Extraction - If you have one or more regular expressions then select Regex and either upload or add them manually. You can also add proximity terms to confirm the regex extraction. Add those proximity terms to the List of Terms.

  • Model Extraction - If the lookup terms exist in a data model, select Model, and then select the model and the model property.

    • Please note - A property with a large number of unique values will take a long time to start.

If you are populating it with another enrichment step then you can skip this step and select next.

Summary

Review the entity making sure it is correct and then select Save. Please note you can't change the ID or data type of an entity once created.

Last updated