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

Request templates

\n\n

\n You can simplify your REST API requests by moving the common configuration\n parts to a request template.\n

\n\n

\n Request templates define default values for parts of the\n clustering request JSON, such as\n algorithm name or language. If you use a template to make the clustering\n request, you can omit the parts defined in the template. If you do provide\n the parts in the request as well, they will override the defaults defined in\n the template.\n

\n\n
\n

\n Use cases\n

\n\n

REST API request templates can be useful in the following situations:

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

\n Creating request templates\n

\n\n

To create a request template, perform these steps:

\n\n
    \n
  1. \n

    \n Create a file called, for example, 01 focused.json in the\n dcs/web/service/templates/ directory of your Lingo3G\n installation.\n

    \n\n

    \n The focused part of the file name is the identifier of\n the template. The 01 number at the front is not part of\n the identifier, it is used to sort templates for display purposes.\n

    \n
    2. \n\n
  2. \n

    \n Edit the template file to contain a JSON object with the same\n structure as the\n clustering request JSON.\n

    \n\n

    \n For example, a template for creating\n more specific clusters\n can contain the following:\n

    \n\n
    \n
    \n 
    {\n  \"language\": \"English\",\n  \"algorithm\": \"Lingo3G\",\n  \"parameters\": {\n    \"clusters\": {\n      \"maxClusterSize\": 0.2\n    },\n    \"hierarchy\": {\n      \"maxClusteringPassesTop\": 0\n    },\n    \"labels\": {\n      \"singleWordLabelWeight\": 0.2\n    }\n  }\n}
    \n
    \n\n
    \n

    \n Example clustering request template that generates more focused\n clusters.\n

    \n
    \n
    \n
    3. \n\n
  3. \n

    \n Restart Lingo3G DCS to make the new template available for clustering.\n

    \n
    4. \n\n
  4. \n

    \n (Optional) Verify that the new template is present by making a\n GET request to the\n /list\n endpoint. The response should contain the following section:\n

    \n\n
    \n 
    ...\n  \"templates\" : [\n    \"frontend-default\",\n    \"foo\"\n  ]\n}
    \n
    \n
    5. \n
\n
\n\n
\n

\n Using request templates\n

\n\n

\n To use a template for a clustering request, pass the template identifier\n in the template query parameter of the\n /cluster\n endpoint:\n

\n\n
\n 
curl -X POST --header \"Content-Type: text/json\" --data-binary @template-request.json \"http://localhost:8080/service/cluster?indent&template=focused\"
\n
\n\n

\n The request JSON you submit can now contain only the document list, the\n template provides the remaining parts:\n

\n\n
\n 
{\n  \"documents\": [\n    {\n      \"title\": \"Data Mining in Python\",\n      \"content\": \"Collection of libraries for machine learning.\"\n    },\n    {\n      \"title\" : \"KDD Lab: knowledge discovery from large spatial data.\"\n    },\n    {\n      \"title\": \"Data Mining\",\n      \"snippet\": [\n        \"Data mining uses machine learning ...\",\n        \"... automated knowledge discovery tools.\"\n      ]\n    }\n  ]\n}
\n
\n\n

\n If you provide other parts in your request JSON too, they will override\n the configuration from the template. For example, you can change the\n clustering language by providing a new language name:\n

\n\n
\n 
{\n  \"language\": \"German\",\n  \"documents\": [\n    {\n      \"title\": \"Was ist Data Mining? \",\n      \"content\": \"Data Mining ist die systematische Anwendung ...\"\n    },\n    {\n      \"title\" : \"Das Dilemma mit den sozialen Medien.\"\n    },\n    {\n      \"title\": \"Kollaboratives Filtern\",\n      \"snippet\": [\n        \"Interessen Einzelner zu schließen.\"\n      ]\n    }\n  ]\n}
\n
\n
\n
","tableOfContents":[{"heading":"Use cases","anchor":"use-cases"},{"heading":"Creating request templates","anchor":"creating-request-templates"},{"heading":"Using request templates","anchor":"using-request-templates"}]}},"pageContext":{"slug":"/rest-api-request-templates/"}},"staticQueryHashes":["1164750013"]}