TopicGroupResponse Data Type

Properties
name data type description
pinned boolean
id number
title string
tonalities array of Tonality
sentimentCalculated boolean
documentCount number
tonalityDocumentCount number
topics array of Topic

Example

{
  "pinned" : true,
  "id" : 12345,
  "title" : "...",
  "tonalities" : [ {
    "score" : 3.6,
    "tone" : "...",
    "normalizedScore" : 0.6
  }, {
    "score" : 2.4,
    "tone" : "...",
    "normalizedScore" : 0.4
  } ],
  "sentimentCalculated" : true,
  "documentCount" : 12345,
  "tonalityDocumentCount" : 12345,
  "topics" : [ {
    "tonalityContext" : {
      "associations" : [ "...", "..." ],
      "terms" : [ "...", "..." ],
      "sortByTonality" : "..."
    },
    "detailedSuggestions" : [ {
      "forWord" : "...",
      "neighbourCounter" : 3,
      "term" : "...",
      "stringSimilar" : true,
      "documentFrequency" : 12345
    }, {
      "forWord" : "...",
      "neighbourCounter" : 12345,
      "term" : "...",
      "stringSimilar" : true,
      "documentFrequency" : 12345
    } ],
    "terms" : [ "...", "..." ],
    "dictionary" : {
      "property1" : "...",
      "property2" : "..."
    },
    "associations" : [ {
      "documentCount" : 12345,
      "association" : "..."
    }, {
      "documentCount" : 12345,
      "association" : "..."
    } ],
    "id" : 12345,
    "tonalities" : [ {
      "score" : 3.6,
      "tone" : "...",
      "normalizedScore" : 0.6
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ],
    "title" : "...",
    "sentimentCalculated" : true,
    "suggestions" : [ "...", "..." ],
    "tonalityDocumentCount" : 12345,
    "documentCount" : 12345
  }, {
    "tonalityContext" : {
      "associations" : [ "...", "..." ],
      "terms" : [ "...", "..." ],
      "sortByTonality" : "..."
    },
    "detailedSuggestions" : [ {
      "forWord" : "...",
      "neighbourCounter" : 12345,
      "term" : "...",
      "stringSimilar" : true,
      "documentFrequency" : 12345
    }, {
      "forWord" : "...",
      "neighbourCounter" : 12345,
      "term" : "...",
      "stringSimilar" : true,
      "documentFrequency" : 12345
    } ],
    "terms" : [ "...", "..." ],
    "dictionary" : {
      "property1" : "...",
      "property2" : "..."
    },
    "associations" : [ {
      "documentCount" : 12345,
      "association" : "..."
    }, {
      "documentCount" : 12345,
      "association" : "..."
    } ],
    "id" : 12345,
    "tonalities" : [ {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ],
    "title" : "...",
    "sentimentCalculated" : true,
    "suggestions" : [ "...", "..." ],
    "tonalityDocumentCount" : 12345,
    "documentCount" : 12345
  } ]
}