entities
field that is added to the metadata
field.

PERSON
ORGANIZATION
LOCATION
DATE
TIME
EVENT
MONEY
PERCENT
FACILITY
PRODUCT
ROLE
DOCUMENT
DATASET
PERSON
-ORGANIZATION
:works_for
,affiliated_with
,founded
PERSON
-LOCATION
:born_in
,lives_in
,traveled_to
ORGANIZATION
-LOCATION
:based_in
,has_office_in
- Entity -
DATE
:occurred_on
,founded_on
,died_on
,published_in
PERSON
-PERSON
:married_to
,parent_of
,colleague_of
PRODUCT
-ORGANIZATION
:developed_by
,owned_by
EVENT
-LOCATION
:held_in
,occurred_in
- Entity -
ROLE
:has_title
,acts_as
,has_role
DATASET
-PERSON
:mentions
DATASET
-DOCUMENT
:located_in
PERSON
-DATASET
:published
DOCUMENT
-DOCUMENT
:referenced_in
,contains
DOCUMENT
-DATE
:dated
PERSON
-DOCUMENT
:published
Generate a list of entities and their relationships
To generate a list of recognized entities and their relationships, in an Enrichment node in a workflow, specify the following:You can change a workflow’s NER settings only through Custom workflow settings.
- Select Text.
- For Model, select one of the available models that are shown.
-
The selected model will follow a default set of instructions (called a prompt) to perform NER using a set of predefined entity types and relationships. To experiment
with running the default prompt against some sample data, click Edit, and then click Run Prompt. The selected Model uses the
Prompt to run NER on the Input sample and shows the results in the Output. Look specifically at the
response_json
field for the entities that were recognized and their relationships. -
To customize the prompt, change the contents of Prompt.
For best results, Unstructured strongly recommends that you limit your changes only to certain portions of the default prompt, specifically:
-
Adding, renaming, or deleting items in the list of predefined types (such as
PERSON
,ORGANIZATION
,LOCATION
, and so on). -
Adding, renaming, or deleting items in the list of predefined relationships (such as
works_for
,based_in
,has_role
, and so on). -
As needed, adding any clarifying instructions only between these two lines:
- Changing any other portions of the default prompt could produce unexpected results.
-
Adding, renaming, or deleting items in the list of predefined types (such as
- To experiment with different data, change the contents of Input sample. For best results, Unstructured strongly recommends that the JSON structure in Input sample be preserved.
- When you are satisfied with the Model and Prompt that you want to use, click Save.