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

Dictionaries

\n\n

\n Lingo3G uses dictionaries to improve the quality of clustering for a\n specific language. This article shows how to customize dictionaries in the\n REST API.\n

\n\n
\n

\n Customizing global dictionaries\n

\n\n

\n To customize the\n global\n dictionaries for REST API clustering, go\n to the\n DCS dictionaries folder\n and edit the files as required. Once you finish editing, restart the DCS\n for the changes to take effect.\n

\n
\n\n
\n

\n Using per-request dictionaries\n

\n\n

\n You can provide extra\n per-request\n dictionary entries for a specific clustering request. Lingo3G applies\n these extra entries as an addition to the default dictionaries. For\n example, if the end-user wants to remove specific labels from the\n clustering result they are currently viewing, your software can add such\n labels to the per-request label dictionary and rerun the clustering.\n

\n\n

\n The dictionaries\n section of the Lingo3G parameters object groups all per-request\n dictionaries. You can use any combination of per-request\n label,\n synonym and\n tag dictionaries.\n

\n\n
\n

\n Label dictionaries\n

\n\n

\n To add per-request entries to the\n label dictionary, use the\n dictionaries.labels\n parameter.\n

\n\n

\n In the following example, without the per-request label dictionary,\n Lingo3G creates a cluster called\n Configuration Issue on Windows. Adding two entries to the\n per-request dictionary replaces the label with Windows:\n

\n\n
\n
\n 
{\n  \"language\": \"English\",\n  \"algorithm\": \"Lingo3G\",\n  \"parameters\": {\n    \"clusters\": {\n      \"maxClusterSize\": 0.8\n    },\n    \"dictionaries\": {\n      \"labels\": [\n        {\n          \"glob\": [\n            \"* issue *\",\n            \"configuration\"\n          ]\n        }\n      ]\n    }\n  },\n  \"documents\": [\n    { \"title\": \"PDF Viewer configuration issue on Windows\" },\n    { \"title\": \"Firefox plugin configuration issue on Windows\" },\n    { \"title\": \"CPU usage for flash in Firefox\" }\n  ]\n}
\n
\n\n
\n

\n Example /cluster request with per-request label\n dictionary entries.\n

\n
\n
\n
\n\n
\n

\n Synonym dictionaries\n

\n\n

\n To add per-request entries to the\n synonym dictionary, use the\n dictionaries.synonyms\n parameter.\n

\n\n

\n In the following example, adding Chrome and Firefox\n as synonyms puts documents containing either of these words in the same\n cluster.\n

\n\n
\n
\n 
{\n  \"language\": \"English\",\n  \"algorithm\": \"Lingo3G\",\n  \"parameters\": {\n    \"clusters\": {\n      \"maxClusterSize\": 0.8,\n      \"allowOneDocumentClusters\": true\n    },\n    \"dictionaries\": {\n      \"tags\": [\n        {\n          \"tag\": \"name\",\n          \"words\": [\n            \"chrome\",\n            \"firefox\"\n          ]\n        }\n      ]\n    }\n  },\n  \"documents\": [\n    { \"title\": \"PDF Viewer configuration on Chrome Windows\" },\n    { \"title\": \"Chrome plugin configuration issue on Windows\" },\n    { \"title\": \"CPU usage for flash in Firefox\" }\n  ]\n}
\n
\n\n
\n

\n Example /cluster request with per-request synonym\n dictionary entries.\n

\n
\n
\n\n

\n Note that setting theclusters.allowOneDocumentClusters\n to true is required due to the small number of documents in\n the example. The parameter causes Lingo3G to preserve during processing\n words with one occurrence, such as Firefox and\n Chrome in the example. If the example left\n allowOneDocumentClusters\n at its default value of false, documents containing\n Chrome an Firefox\n would not end up in the same cluster because Lingo3G would filter out\n the one-occurrence words before applying synonyms.\n

\n
\n\n
\n

\n Tag dictionaries\n

\n\n

\n To add per-request entries to the\n word tag dictionary, use the\n dictionaries.tags\n parameter.\n

\n\n

\n In the following example, adding Chrome and Firefox to\n the tags dictionary with the name tag slightly promotes the\n two words in cluster labels. As a result, Lingo3G chooses\n Chrome and Firefox over some other words to label the\n clusters.\n

\n\n
\n
\n 
{\n  \"language\": \"English\",\n  \"algorithm\": \"Lingo3G\",\n  \"parameters\": {\n    \"clusters\": {\n      \"maxClusterSize\": 0.8,\n      \"allowOneDocumentClusters\": true\n    },\n    \"dictionaries\": {\n      \"tags\": [\n        {\n          \"glob\": [\n            \"Chrome\", \"Firefox\"\n          ]\n        }\n      ]\n    }\n  },\n  \"documents\": [\n    { \"title\": \"PDF Viewer configuration on Windows\" },\n    { \"title\": \"Chrome plugin configuration issue on Windows\" },\n    { \"title\": \"CPU usage for flash in Firefox\" }\n  ]\n}
\n
\n\n
\n

\n Example /cluster request with per-request tag\n dictionary entries.\n

\n
\n
\n
\n
\n
","tableOfContents":[{"heading":"Customizing global dictionaries","anchor":"customizing-global-dictionaries"},{"heading":"Using per-request dictionaries","anchor":"per-request-dictionaries","sections":[{"heading":"Label dictionaries","anchor":"per-request-dictionaries:label-dictionaries"},{"heading":"Synonym dictionaries","anchor":"per-request-dictionaries:synonym-dictionaries"},{"heading":"Tag dictionaries","anchor":"per-request-dictionaries:tag-dictionaries"}]}]}},"pageContext":{"slug":"/rest-api-dictionaries/"}},"staticQueryHashes":["1164750013"]}