{"componentChunkName":"component---node-modules-carrotsearch-gatsby-theme-apidocs-templates-documentation-page-js","path":"/","result":{"data":{"html":{"frontmatter":{"id":"hello-lingo3g","title":"Hello, Lingo3G!"},"html":"<article>\n  <h1>Hello, Lingo3G!</h1>\n\n  <p id=\"65969556\">\n    This is the user's and developer's manual for Carrot Search Lingo3G\n    Clustering Engine version 2.0.0.\n  </p>\n\n  <section id=\"what-is-lingo3g\">\n    <h2>\n        <a class=\"anchor\" href=\"#what-is-lingo3g\" aria-hidden=\"true\"><svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"/></svg></a>What is Lingo3G?\n      </h2>\n\n    <p id=\"what-is-lingo3g:5025a7dd\">\n      Lingo3G is a text clustering engine — it organizes collections of up\n      to ~10,000 documents into clearly-labeled thematic groups called clusters.\n      You can use Lingo3G to organize, for example, search result into groups\n      like these:\n    </p>\n\n    <figure class=\"round\">\n      <div style=\"position: relative\">\n        <span style=\"padding-bottom: 52.77777777777778%; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAIAAADwazoUAAAACXBIWXMAAAsSAAALEgHS3X78AAABeElEQVQoz0VS23aDIBD0/7+tz22S1kuMRkXxhtwEtAOk6TzsWYTdmZ01KR8edV2XZfkMIIScb1iL4IwYxxHfp2nC8Thel0mW5UWRozILqKpKCGGtPeKTXfvXzmxsnedlZUxrqbWOt0nTdk3ToBj8RVGAGTmEOOd8sRSHwztLSX67fVdVrQV9lD91/cSDJE1T1KAenFE5YpTnweZTCXccdCADHXfNl4n0PeGce2aIiRk6Qa0xxmsGbZQ905NUOCippJS4t86ZMBSQ9OhDSNu2uAtm/LlxhmSh59eH1Ssde8yyrgy1nG/bxkGDmUkdgC5QiwhjEaUQgbk/2gdkUZJer7f7/d7UxeXymeeFUirJco8iIKR59DwKOdfplH4ouU0DpdOEvgM4op0JOGESrIb4ruuicyDf990XC4ZFYVVK6ff+4sD/xYhNAOrRmDH2Gl4FIyzv+2YYqFJCSjYvCx74VcFqGYB/A/mL8O2ZjcfDL2ldjdE+QeZz8wvw0G/lwOYowgAAAABJRU5ErkJggg==')\" class=\"preview light fluid\"> </span>\n        <img class=\"light fluid\" alt=\"Search results (snippets) and clusters discovered from them, light theme.\" title src=\"../static/bd83230234ea2095105e2f09f1ad4427/eefce/lingo3g-intro-example-light.png\" srcset=\"../static/bd83230234ea2095105e2f09f1ad4427/dfaee/lingo3g-intro-example-light.png 180w,\n../static/bd83230234ea2095105e2f09f1ad4427/4d463/lingo3g-intro-example-light.png 360w,\n../static/bd83230234ea2095105e2f09f1ad4427/eefce/lingo3g-intro-example-light.png 720w,\n../static/bd83230234ea2095105e2f09f1ad4427/dabea/lingo3g-intro-example-light.png 1080w,\n../static/bd83230234ea2095105e2f09f1ad4427/87339/lingo3g-intro-example-light.png 1440w,\n../static/bd83230234ea2095105e2f09f1ad4427/f55c5/lingo3g-intro-example-light.png 1694w\" sizes=\"(max-width: 720px) 100vw, 720px\">\n      </div>\n      <div style=\"position: relative\">\n        <span style=\"padding-bottom: 52.77777777777778%; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAIAAADwazoUAAAACXBIWXMAAAsSAAALEgHS3X78AAABx0lEQVQozz1SiY6bMBTkO6o2G8IVsLnBnAZsCFey6W61+/+/0nFQK42sJ+x5780MWtFI1ois6nGmRYciLXvd9s8WxfkqfM+P07IrWpkwrtvB8R3Q5v1zffyZ94/l/rk/v27b7zCrLS++OMcjerZ9yw2jvAYzyhsSMjfILo5qqtXd3PRzP+3DtI/Lg4u1HWY+LJYbYfgLvulQIeT2/tWNe87Keb23YjOuoQYOl2vFJ7RoxVLyiYsFS76ZVHeCs0kAvGPNkFcDCbOi4lDqJ5VaO6+HhLWYY5MU+xywSXyoOhne6XLF7dXPvJBZXmS4kenGhhNAlxazFnMAXPzUr78uLgDOQX4zvB8ngwYJq3tsBM0OiYK0AhyaaK1YxfwAaj7BbeV8qU4vyM82BRm9oHmUcn9+y+Vd3tbHx/e4PrGIppi3ezdu/bihAOQM2xaQ1WTTO1sE3sZZqQQWnDUyKTrTDZXmqpsQYDPMuIMlMKPub1jPJoluIQ9yRHWlGXSp/JwA/qFAEBoGYk4/bc2wwPZWzODHjB+99VdaxI9rLvNa0IiFaYHAw6xRUQVp7ccljQs/KVHD6n/x0v//meIHKQgOiVFEWXP8SH8BAqKEhdNykXUAAAAASUVORK5CYII=')\" class=\"preview dark fluid\"> </span>\n        <img class=\"dark fluid\" alt=\"Search results (snippets) and clusters discovered from them, dark theme\" title src=\"../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/eefce/lingo3g-intro-example-dark.png\" srcset=\"../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/dfaee/lingo3g-intro-example-dark.png 180w,\n../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/4d463/lingo3g-intro-example-dark.png 360w,\n../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/eefce/lingo3g-intro-example-dark.png 720w,\n../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/dabea/lingo3g-intro-example-dark.png 1080w,\n../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/87339/lingo3g-intro-example-dark.png 1440w,\n../static/80ed59afaf4bd0d4f78ba9a6b9ad43e3/f55c5/lingo3g-intro-example-dark.png 1694w\" sizes=\"(max-width: 720px) 100vw, 720px\">\n      </div>\n      <figcaption>\n        <p>\n          Search result titles and snippets (on the left) for query \"data\n          mining\" and corresponding\n          <a href=\"https://search.carrotsearch.com/#/search/web/data%20mining/folders\" target=\"_blank\">cluster labels</a>\n          (right).\n        </p>\n      </figcaption>\n    </figure>\n\n    <p id=\"what-is-lingo3g:8754f83c\">\n      Lingo3G performs clustering fully automatically, based only on the\n      document text you provide. Lingo3G's unique algorithm produces\n      high-quality semantic clusters within fractions of a second.\n    </p>\n  </section>\n\n  <section id=\"is-lingo-3g-right-for-me\">\n    <h2>\n        <a class=\"anchor\" href=\"#is-lingo-3g-right-for-me\" aria-hidden=\"true\"><svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"/></svg></a>Is Lingo3G right for me?\n      </h2>\n\n    <p id=\"is-lingo-3g-right-for-me:9399f5d5\">You will likely use Lingo3G in one of the following scenarios:</p>\n\n    <ul>\n      <li>\n        <p id=\"is-lingo-3g-right-for-me:614a303f\">\n          As a <strong>programming component</strong> integrated with the\n          software you develop. In this case, depending on your preference, you\n          will use some of the available Lingo3G APIs:\n        </p>\n\n        <ul>\n          <li id=\"is-lingo-3g-right-for-me:f243de3c\"><a href=\"/rest-api-basics/\">Lingo3G REST API</a></li>\n          <li id=\"is-lingo-3g-right-for-me:8da047f8\"><a href=\"/java-api-basics/\">Lingo3G Java API</a></li>\n          <li id=\"is-lingo-3g-right-for-me:ef43880f\">\n            <a href=\"https://lucene.apache.org/solr/guide/8_2/result-clustering.html\">Lingo3G plugin for Apache Solr</a>\n          </li>\n          <li id=\"is-lingo-3g-right-for-me:236e88ca\">\n            <a href=\"https://github.com/carrotsearch/elasticsearch-lingo3g\">Lingo3G plugin for Elasticsearch</a>\n          </li>\n        </ul>\n      </li>\n\n      <li>\n        <p id=\"is-lingo-3g-right-for-me:31879e46\">\n          As an <strong>end-user app</strong> for clustering documents from\n          various sources, such as Excel, CSV or JSON files, public or internal\n          search engines.\n        </p>\n\n        <p id=\"is-lingo-3g-right-for-me:06278f88\">\n          In this case, you will use\n          <a href=\"/clustering-workbench-app/\">Lingo3G Clustering Workbench</a>. You will need some IT experience or help to install the app, to prepare your\n          data in the required format or to configure and connect your internal\n          search engine to Lingo3G.\n        </p>\n      </li>\n    </ul>\n  </section>\n\n  <section id=\"how-do-i-start\">\n    <h2>\n        <a class=\"anchor\" href=\"#how-do-i-start\" aria-hidden=\"true\"><svg aria-hidden=\"true\" height=\"16\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"/></svg></a>How do I start?\n      </h2>\n\n    <ol>\n      <li>\n        <p id=\"how-do-i-start:5d19754f\">\n          <a href=\"/trying-lingo3g/\">Try Lingo3G demos</a>\n          to see what kind of results you can expect from your data.\n        </p>\n      </li>\n\n      <li>\n        <p id=\"how-do-i-start:f2488c8d\">\n          Optional: to learn about the basic concepts involved in Lingo3G\n          clustering, have a look at the\n          <a href=\"/basic-concepts/\">Basic concepts</a>\n          section.\n        </p>\n      </li>\n\n      <li>\n        <p id=\"how-do-i-start:e4cd1b5d\">\n          If you want to use Lingo3G as a programming component,\n          <a href=\"/basic-concepts/#tools-and-apis:apis:rest-or-java-api\">choose the API</a>\n          and then, depending on your decision, proceed to the\n          <a href=\"/rest-api-basics/\">REST API</a> or\n          <a href=\"/java-api-basics/\">Java API</a> section.\n        </p>\n      </li>\n\n      <li>\n        <p id=\"how-do-i-start:6e3194e5\">\n          If you'd like to use Lingo3G as an end-user app, see\n          <a href=\"/search-results-clustering-app/\">Search Results Clustering app</a>\n          and\n          <a href=\"/clustering-workbench-app/\">Clustering Workbench app</a>.\n        </p>\n      </li>\n\n      <li>\n        <p id=\"how-do-i-start:81d95a57\">\n          Optional: if you'd like to tune the quality or performance of Lingo3G\n          clustering, have a look at\n          <a href=\"/dictionaries/\">Dictionaries</a> and\n          <a href=\"/parameter-tuning/\">Parameter tuning</a>.\n        </p>\n      </li>\n    </ol>\n  </section>\n</article>","tableOfContents":[{"heading":"What is Lingo3G?","anchor":"what-is-lingo3g"},{"heading":"Is Lingo3G right for me?","anchor":"is-lingo-3g-right-for-me"},{"heading":"How do I start?","anchor":"how-do-i-start"}]}},"pageContext":{"slug":"/hello-lingo3g/"}},"staticQueryHashes":["1164750013"]}