Get the text analytics results
post/analytics/{jobId}/results
Returns the text analytics results that are available at the specified exploration level.
1{2 "identifier": "4fa45829-9b75-49c8-99f7-ef15aa838e65",3 "level": {4 "category": "person"5 },6 "results": [7 {8 "phrase": "james robert smith",9 "frequencyCount": 5,10 "objectIds": [11 {12 "type": "article",13 "id": "2569"14 },15 {16 "type": "article",17 "id": "65"18 }19 ],20 "aliases": [21 {22 "phrase": "james robert smith",23 "frequencyCount": 3,24 "objectIds": [25 {26 "type": "article",27 "id": "2569"28 },29 {30 "type": "article",31 "id": "65"32 }33 ]34 },35 {36 "phrase": "james smith",37 "frequencyCount": 2,38 "objectIds": [39 {40 "type": "article",41 "id": "65"42 }43 ]44 }45 ]46 },47 {48 "phrase": "sarah edwards",49 "frequencyCount": 2,50 "objectIds": [51 {52 "type": "article",53 "id": "3985"54 },55 {56 "type": "article",57 "id": "1877"58 }59 ],60 "aliases": [61 {62 "phrase": "sarah edwards",63 "frequencyCount": 2,64 "objectIds": [65 {66 "type": "article",67 "id": "3985"68 },69 {70 "type": "article",71 "id": "1877"72 }73 ]74 }75 ]76 }77 ],78 "links": [79 {80 "method": "POST",81 "rel": "self",82 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",83 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",84 "type": "application/vnd.sas.sand.analytics.explore",85 "responseType": "application/vnd.sas.sand.analytics.results"86 },87 {88 "method": "GET",89 "rel": "getJob",90 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",91 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",92 "type": "application/vnd.sas.sand.analytics.job"93 },94 {95 "method": "GET",96 "rel": "getState",97 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",98 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",99 "type": "text/plain"100 },101 {102 "method": "PUT",103 "rel": "cancelJob",104 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",105 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",106 "responseType": "text/plain"107 },108 {109 "method": "DELETE",110 "rel": "deleteJob",111 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",112 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65"113 },114 {115 "method": "GET",116 "rel": "getIdentities",117 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",118 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",119 "type": "application/vnd.sas.sand.analytics.explore",120 "responseType": "application/vnd.sas.sand.analytics.identities"121 },122 {123 "method": "POST",124 "rel": "getCategories",125 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",126 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",127 "type": "application/vnd.sas.sand.analytics.explore",128 "responseType": "application/vnd.sas.sand.analytics.categories"129 },130 {131 "method": "POST",132 "rel": "getSankeyDiagram",133 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",134 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",135 "type": "application/vnd.sas.sand.analytics.sankey.diagram.request",136 "responseType": "application/vnd.sas.sand.analytics.sankey.diagram"137 },138 {139 "method": "GET",140 "rel": "getLocales",141 "href": "/svi-sand/analytics/locales",142 "uri": "/svi-sand/analytics/locales",143 "type": "application/vnd.sas.collection",144 "itemType": "application/vnd.sas.sand.analytics.locale"145 },146 {147 "method": "POST",148 "rel": "startTextAnalytics",149 "href": "/svi-sand/analytics",150 "uri": "/svi-sand/analytics",151 "type": "application/vnd.sas.sand.analytics.request",152 "responseType": "application/vnd.sas.sand.analytics.job"153 }154 ]155}
Name | Type | Required | Description |
---|---|---|---|
jobId | string | true | The unique identifier of the text analytics job. |
The request to /analytics/{jobId}/results and /analytics/{jobId}/categories to retrieve the text analytics results and categories of result, respectively at a given exploration level
Name | Type | Required | Description |
---|---|---|---|
version | integer | false | The representation version (1). |
level | AnalyticsExplorationLevel | false | The exploration level within the text analytics results. |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. | Schema | |
202 | Accepted | The text analytics results are not available yet. For example, the job is still running. | Schema | |
400 | Bad Request | The request is malformed or contains invalid parameter values. | Schema | |
404 | Not Found | There is no job for the given identifier or there are no results at the specified exploration level. | Schema |