{"componentChunkName":"component---node-modules-carrotsearch-gatsby-theme-apidocs-templates-documentation-page-js","path":"/synonym-dictionary/","result":{"data":{"html":{"frontmatter":{"id":"synonym-dictionary","title":"Synonym dictionary"},"html":"
\n

Synonym dictionary

\n\n

\n The synonym dictionary lets you define words and phrases that represent the\n same concept, such as photo and picture, so that Lingo3G\n puts documents discussing those concepts in the same cluster.\n

\n\n

\n Lingo3G\n reads the\n synonym dictionary from a JSON file named\n language.synonyms.json, where language is the\n language name. The synonym dictionary must be an array of objects with the\n following structure:\n

\n\n
\n
\n 
[\n  // zero or more includes.\n  {\n    \"include\": \"relative-path-to-include.json\",\n    \"required\": true\n  },\n\n  // zero or more synonym sets consisting of label matching rules\n  {\n    \"comment\": \"Example synonym set for various words describing a 'picture'.\",\n    \"glob\": [\n      \"picture\",\n      \"pictures\",\n      \"pic\",\n      \"pics\"\n    ]\n  }\n]
\n
\n\n
\n

The structure of a Lingo3G synonym dictionary.

\n
\n
\n\n

\n The dictionary definition is an array of the following types of objects.\n

\n\n
\n
include
\n
\n

\n Includes all entries from another synonym dictionary into this\n dictionary. You can use includes to split a large synonym dictionary\n into smaller ones or extract a common part of a set of synonym\n dictionaries.\n

\n\n
\n 
{ \"include\": \"name.json\", \"required\": true }
\n
\n\n
\n
include
\n
\n

\n (required) Path to the synonym dictionary to include, relative to\n the location of this dictionary.\n

\n
\n\n
required
\n
\n

\n If true and the file to include does not exist, Lingo3G\n will trigger an error.\n

\n\n

\n If false, Lingo3G will ignore a non-existing include\n file.\n

\n
\n
\n
\n\n
synonym set
\n
\n

\n Represents a single synonym set. An array of\n glob rules defines\n the set of synonymous words and phrases.\n

\n\n
\n 
{\n  \"comment\": \"The 'movie' concept\",\n  \"label\": \"Movie\",\n  \"glob\": [\n    \"film\", \"motion picture\", \"movie\"\n  ]\n}
\n
\n\n
\n
glob
\n
\n

\n (required) An array of\n glob rules\n defining the synonymous labels.\n

\n
\n\n
label
\n
\n

\n (optional) The label Lingo3G should use to describe a cluster formed\n from any word or phrase in this synonym set.\n

\n\n

\n If you don't provide the preferred label, Lingo3G will describe the\n cluster with an arbitrary label from the synonym set.\n

\n
\n\n
comment
\n
\n

An optional comment for this synonym set.

\n
\n
\n
\n
\n\n
\n Heads up, synonym dictionary limitations.\n\n \n
\n\n

A real-world synonym dictionary can look like this:

\n\n
\n
\n 
[\n  {\n    \"label\": \"New York\",\n    \"glob\": [\n      \"nyc\",\n      \"new york city\",\n      \"big apple\"\n    ]\n  },\n  {\n    \"glob\": [\n      \"movie\",\n      \"film\",\n      \"motion picture\"\n    ]\n  }\n]
\n
\n\n
\n

Example synonym dictionary.

\n
\n
\n\n

\n With the above dictionary, Lingo3G puts documents containing\n NYC, New York City or Big apple in a single\n cluster labelled New York.\n

\n
","tableOfContents":[]}},"pageContext":{"slug":"/synonym-dictionary/"}},"staticQueryHashes":["1164750013"]}