ProjectExplorationResponse Data Type

Properties
name data type description
status ExplorationStatus The status of the exploration.
ignoreTerms array of string The terms that was ignored in the exploration.
groups array of TopicGroupResponse The groups of topics available in the project.
language string The two character ISO 639-1 langauge code representing the language, e.g., "en" for English.
columnHeaderId number The identifier for the column used for exploring the data, that is, the name of the column in the data set.
filters array of Filter The filters applied to the data set when exploring it.
tones array of string The tones (sentiment) detected in the exploration.
totalDocumentCount number The total number of documents in the project.
conceptFilter object The concept filter used
coverageStatistics CoverageStatistics
projectTonalities ProjectDocumentTonalities
ignoreTermsDictionary map of string

Example

{
  "status" : {
    "startTime" : 1546610555204,
    "progress" : 50,
    "message" : "...",
    "state" : "TIMEOUT",
    "productPriceInCents" : 12345,
    "acceptOverageToken" : "...",
    "overageAmount" : 12345,
    "currency" : "...",
    "explorationTimeMillis" : { }
  },
  "ignoreTerms" : [ "...", "..." ],
  "groups" : [ {
    "title" : "...",
    "topics" : [ {
      "suggestions" : [ "...", "..." ],
      "associations" : [ { }, { } ],
      "documentCount" : 12345,
      "tonalities" : [ { }, { } ],
      "title" : "...",
      "terms" : [ "...", "..." ],
      "tonalityDocumentCount" : 12345,
      "id" : 12345,
      "detailedSuggestions" : [ { }, { } ],
      "sentimentCalculated" : true,
      "tonalityContext" : { },
      "dictionary" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "suggestions" : [ "...", "..." ],
      "associations" : [ { }, { } ],
      "documentCount" : 12345,
      "tonalities" : [ { }, { } ],
      "title" : "...",
      "terms" : [ "...", "..." ],
      "tonalityDocumentCount" : 12345,
      "id" : 12345,
      "detailedSuggestions" : [ { }, { } ],
      "sentimentCalculated" : true,
      "tonalityContext" : { },
      "dictionary" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "tonalities" : [ {
      "tone" : "...",
      "normalizedScore" : 0.6,
      "score" : 3.6
    }, {
      "tone" : "...",
      "normalizedScore" : 0.4,
      "score" : 2.4
    } ],
    "documentCount" : 12345,
    "tonalityDocumentCount" : 12345,
    "pinned" : true,
    "sentimentCalculated" : true,
    "id" : 12345
  }, {
    "title" : "...",
    "topics" : [ {
      "suggestions" : [ "...", "..." ],
      "associations" : [ { }, { } ],
      "documentCount" : 12345,
      "tonalities" : [ { }, { } ],
      "title" : "...",
      "terms" : [ "...", "..." ],
      "tonalityDocumentCount" : 12345,
      "id" : 12345,
      "detailedSuggestions" : [ { }, { } ],
      "sentimentCalculated" : true,
      "tonalityContext" : { },
      "dictionary" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "suggestions" : [ "...", "..." ],
      "associations" : [ { }, { } ],
      "documentCount" : 12345,
      "tonalities" : [ { }, { } ],
      "title" : "...",
      "terms" : [ "...", "..." ],
      "tonalityDocumentCount" : 12345,
      "id" : 12345,
      "detailedSuggestions" : [ { }, { } ],
      "sentimentCalculated" : true,
      "tonalityContext" : { },
      "dictionary" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "tonalities" : [ {
      "tone" : "...",
      "normalizedScore" : 0.4,
      "score" : 2.4
    }, {
      "tone" : "...",
      "normalizedScore" : 0.4,
      "score" : 2.4
    } ],
    "documentCount" : 12345,
    "tonalityDocumentCount" : 12345,
    "pinned" : true,
    "sentimentCalculated" : true,
    "id" : 12345
  } ],
  "language" : "...",
  "columnHeaderId" : 12345,
  "filters" : [ {
    "value" : "...",
    "operator" : "SMALLER_THAN_EQUAL",
    "columnHeaderId" : 12345,
    "valueFormat" : "..."
  }, {
    "value" : "...",
    "operator" : "EQUALS",
    "columnHeaderId" : 12345,
    "valueFormat" : "..."
  } ],
  "tones" : [ "...", "..." ],
  "totalDocumentCount" : 12345,
  "conceptFilter" : { },
  "coverageStatistics" : {
    "tonalities" : [ {
      "tone" : "...",
      "normalizedScore" : 0.6,
      "score" : 3.6
    }, {
      "tone" : "...",
      "normalizedScore" : 0.4,
      "score" : 2.4
    } ],
    "documentCount" : 12345,
    "tonalityDocumentCount" : 12345,
    "sentimentCalculated" : true
  },
  "projectTonalities" : {
    "tonalities" : [ {
      "tone" : "...",
      "normalizedScore" : 0.6,
      "score" : 3.6
    }, {
      "tone" : "...",
      "normalizedScore" : 0.4,
      "score" : 2.4
    } ],
    "tonalityDocumentCount" : 12345,
    "sortByTonality" : "..."
  },
  "ignoreTermsDictionary" : {
    "property1" : "...",
    "property2" : "..."
  }
}