Get the categories of text analytics results

post/analytics/{jobId}/categories
Internal-Use Only

Returns the categories of text analytics results that are available at the specified exploration level.

Request Samples

1

Response Samples

1{
2 "identifier": "4fa45829-9b75-49c8-99f7-ef15aa838e65",
3 "categories": [
4 "unigram",
5 "bigram",
6 "trigram",
7 "person",
8 "organization",
9 "location",
10 "significantTerm",
11 "topic"
12 ],
13 "fromAndTo": true,
14 "errors": [],
15 "links": [
16 {
17 "method": "POST",
18 "rel": "self",
19 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",
20 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",
21 "type": "application/vnd.sas.sand.analytics.explore",
22 "responseType": "application/vnd.sas.sand.analytics.categories"
23 },
24 {
25 "method": "GET",
26 "rel": "getJob",
27 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
28 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
29 "type": "application/vnd.sas.sand.analytics.job"
30 },
31 {
32 "method": "GET",
33 "rel": "getState",
34 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",
35 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",
36 "type": "text/plain"
37 },
38 {
39 "method": "PUT",
40 "rel": "cancelJob",
41 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",
42 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",
43 "responseType": "text/plain"
44 },
45 {
46 "method": "DELETE",
47 "rel": "deleteJob",
48 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
49 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65"
50 },
51 {
52 "method": "GET",
53 "rel": "getIdentities",
54 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",
55 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",
56 "type": "application/vnd.sas.sand.analytics.explore",
57 "responseType": "application/vnd.sas.sand.analytics.identities"
58 },
59 {
60 "method": "POST",
61 "rel": "getResults",
62 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",
63 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",
64 "type": "application/vnd.sas.sand.analytics.explore",
65 "responseType": "application/vnd.sas.sand.analytics.results"
66 },
67 {
68 "method": "POST",
69 "rel": "getSankeyDiagram",
70 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",
71 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",
72 "type": "application/vnd.sas.sand.analytics.sankey.diagram.request",
73 "responseType": "application/vnd.sas.sand.analytics.sankey.diagram"
74 },
75 {
76 "method": "GET",
77 "rel": "getLocales",
78 "href": "/svi-sand/analytics/locales",
79 "uri": "/svi-sand/analytics/locales",
80 "type": "application/vnd.sas.collection",
81 "itemType": "application/vnd.sas.sand.analytics.locale"
82 },
83 {
84 "method": "POST",
85 "rel": "startTextAnalytics",
86 "href": "/svi-sand/analytics",
87 "uri": "/svi-sand/analytics",
88 "type": "application/vnd.sas.sand.analytics.request",
89 "responseType": "application/vnd.sas.sand.analytics.job"
90 }
91 ]
92}

Path Parameters

NameTypeRequiredDescription
jobId
string
true

The unique identifier of the text analytics job.

Request Body

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

NameTypeRequiredDescription
version
integer
false

The representation version (1).

level
AnalyticsExplorationLevel
false

The exploration level within the text analytics results.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
202AcceptedThe text analytics results are not available yet. For example, the job is still running.Schema
206Partial ContentThe job did not complete successfully but there are some text analytics results.Schema
400Bad RequestThe request is malformed or contains invalid parameter values.Schema
404Not FoundThere is no job for the given identifier or there are no results at the specified exploration level.Schema