{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/en/Patterns/named_entity/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"bc86bb53-5b7d-5141-ac16-00bac37d0e24","excerpt":"Named Entities Named entities are contained within named entity dictionaries. Named entity dictionaries Named entity dictionaries are required for processing…","html":"

Named Entities

\n
\n

Named entities are contained within named entity dictionaries.

\n
\n

Named entity dictionaries

\n

Named entity dictionaries are required for processing large number of names, e.g. names of cities, countries, proper names, currencies, etc.

\n

Dictionaries are contained within .csv files, with each line complying to the following format:

\n
id; name; value
\n
\n

Here,

\n\n

You may enumerate all the synonyms inside name and specify the main one as one of the json attributes.

\n

Here is a fragment of a dictionary of proper names:

\n
149;Bernard;{\"name\": \"Bernard\", \"sex\": \"male\"}\n150;Bernie;{\"name\": \"Bernie\", \"sex\": \"male\"}\n151;Berry;{\"name\": \"Berry\", \"sex\": \"male\"}\n152;Bert, Bertram;{\"name\": \"Bertram\", \"sex\": \"male\"}\n153;Bill,Billie,Billy;{\"name\": \"Bill\", \"sex\": \"male\"}\n154;Blaine;{\"name\": \"Blaine\", \"sex\": \"male\"}
\n
\n

Elements of named entity dictionaries

\n

In order to access named entity dictionaries from named patterns, the following steps are necessary:

\n
    \n
  1. Specify the dictionary name and its path in the .sc script under the require tag:
    2. \n
\n
require: common/common-cities.csv\n         name = RoamingRegions\n         var = RoamingRegions
\n
\n
    \n
  1. Define a converter in any .js file. The converter allows to save pattern information into the value attribute of the parseTree. For example:
    2. \n
\n
function RoamingRegionTagConverter($parseTree) {\n            var id = $parseTree.RoamingRegions[0].value;\n            return RoamingRegions[id].value\n    }
\n

Here,

\n\n

The returned value is saved into the value attribute.

\n
\n
    \n
  1. Declare a named pattern. Use $entity<>:
    2. \n
\n
$roamingRegion = $entity<RoamingRegions> || converter = RoamingRegionTagConverter
\n

Named entities can be used even without declaring a named pattern.

\n

When a named pattern is assigned a converter, a $parseTree’s value attribute will then include the value of the corresponding dictionary element.

","frontmatter":{"title":"","description":null},"headings":[{"value":"Named Entities"}]}},"pageContext":{"slug":"/docs/en/Patterns/named_entity/","previous":{"fields":{"slug":"/docs/en/Patterns/named_patterns/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/en/Patterns/converters/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}