TonalitiesResponse Data Type

Properties
name data type description
documents array of DocumentSentences
terms array of string
orderBy TonalityOrder
tonalities array of Tonality
progress number
sortByTonality string
tonalityDocumentCount number
associations array of string
status TonalityStatus

Example

{
  "documents" : [ {
    "relevantSentences" : [ {
      "htmlText" : "...",
      "text" : "..."
    }, {
      "htmlText" : "...",
      "text" : "..."
    } ],
    "tonalities" : [ {
      "score" : 3.6,
      "tone" : "...",
      "normalizedScore" : 0.6
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ],
    "selectedMetaDataList" : [ {
      "rowIndex" : 12345,
      "rowValue" : "...",
      "columnTitle" : "..."
    }, {
      "rowIndex" : 12345,
      "rowValue" : "...",
      "columnTitle" : "..."
    } ],
    "documentText" : "...",
    "generalDocumentTonalities" : [ {
      "score" : 3.6,
      "tone" : "...",
      "normalizedScore" : 0.6
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ]
  }, {
    "relevantSentences" : [ {
      "htmlText" : "...",
      "text" : "..."
    }, {
      "htmlText" : "...",
      "text" : "..."
    } ],
    "tonalities" : [ {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ],
    "selectedMetaDataList" : [ {
      "rowIndex" : 12345,
      "rowValue" : "...",
      "columnTitle" : "..."
    }, {
      "rowIndex" : 12345,
      "rowValue" : "...",
      "columnTitle" : "..."
    } ],
    "documentText" : "...",
    "generalDocumentTonalities" : [ {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    }, {
      "score" : 2.4,
      "tone" : "...",
      "normalizedScore" : 0.4
    } ]
  } ],
  "terms" : [ "...", "..." ],
  "orderBy" : "SENTIMENT_DESC",
  "tonalities" : [ {
    "score" : 3.6,
    "tone" : "...",
    "normalizedScore" : 0.6
  }, {
    "score" : 2.4,
    "tone" : "...",
    "normalizedScore" : 0.4
  } ],
  "progress" : 12345,
  "sortByTonality" : "...",
  "tonalityDocumentCount" : 12345,
  "associations" : [ "...", "..." ],
  "status" : "FINISHED"
}