The
Text Enrichment component only requires a basic edge
for input. The output edge, however, must include all the fields from the
input, plus all fields added by the
Text Enrichment component.
The
specific fields on the output edge depend on the configuration of the Salience
Engine defined in the Text Enrichment properties file for the component
instance. Thus, the edge metadata includes some combination of the following
properties:
- Document summary
- Quotations
- Entities, which may include:
- Persons
- Companies
- Places
- Products
- Sports
- Titles
- User-defined entities
- Document Sentiment
- Themes
- Meta Themes (list of themes
in the document)
- Theme cuts
One field per cut. For example, if you have three cuts, you need
three Theme cut fields; if you have five Theme cuts, you need five cut fields.
- Entity cuts
One field per cut, as in the Theme cuts example.
- Query Topics
- Query topic cuts
One field per cut. For example, if you have three cuts, you need
three Query Topic cut fields; if you have five cuts, you need five cut fields.
If using the example Text Enrichment properties file, you must create
the following properties for the edge metadata:
- DocumentSentiment
- SalesOrderNumber
- EntitiesPerson
- EntitiesProduct
- EntitiesCompany
- ThemesMeta
- ThemesNegative
- ThemesNeutral
- ThemesPositive
- EntitiesNegative
- EntitiesNeutral
- EntitiesPositive
- SurveyResponses
- Summary
- Quotes
- QueryTopics
- QueryTopicsNegative
- QueryTopicsNeutral
- QueryTopicsPositive
For details on the Text Enrichment properties file, see
Text Enrichment properties file.
Note that field type validation is performed for the Text Enrichment
component. It will validate the field type and report an error if a wrong field
type is detected.