Get the identities found by a text analytics job

get/analytics/{jobId}/identities
Internal-Use Only

Returns the identity information for the person, organization, and location entities that were resolved by the text analytics job. Identities consist of an entity name, frequency count, and any known aliases.

Request Samples

1

Response Samples

1{
2 "identifier": "4fa45829-9b75-49c8-99f7-ef15aa838e65",
3 "identities": {
4 "person": [
5 {
6 "name": "james robert smith",
7 "frequencyCount": 23,
8 "aliases": [
9 {
10 "name": "james robert smith",
11 "frequencyCount": 14
12 },
13 {
14 "name": "james smith",
15 "frequencyCount": 9
16 }
17 ]
18 },
19 {
20 "name": "sarah jones",
21 "frequencyCount": 5,
22 "aliases": [
23 {
24 "name": "sarah jones",
25 "frequencyCount": 5
26 }
27 ]
28 }
29 ],
30 "organization": [
31 {
32 "name": "white house",
33 "frequencyCount": 39,
34 "aliases": [
35 {
36 "name": "white house",
37 "frequencyCount": 39
38 }
39 ]
40 },
41 {
42 "name": "department of state",
43 "frequencyCount": 25,
44 "aliases": [
45 {
46 "name": "department of state",
47 "frequencyCount": 25
48 }
49 ]
50 }
51 ],
52 "location": [
53 {
54 "name": "united states",
55 "frequencyCount": 36,
56 "aliases": [
57 {
58 "name": "united states",
59 "frequencyCount": 36
60 }
61 ]
62 },
63 {
64 "name": "united kingdom",
65 "frequencyCount": 22,
66 "aliases": [
67 {
68 "name": "united kingdom",
69 "frequencyCount": 22
70 }
71 ]
72 }
73 ]
74 },
75 "errors": [],
76 "links": [
77 {
78 "method": "GET",
79 "rel": "self",
80 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",
81 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/identities",
82 "type": "application/vnd.sas.sand.analytics.explore",
83 "responseType": "application/vnd.sas.sand.analytics.identities"
84 },
85 {
86 "method": "GET",
87 "rel": "getJob",
88 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
89 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
90 "type": "application/vnd.sas.sand.analytics.job"
91 },
92 {
93 "method": "GET",
94 "rel": "getState",
95 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",
96 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state",
97 "type": "text/plain"
98 },
99 {
100 "method": "PUT",
101 "rel": "cancelJob",
102 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",
103 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/state?value=cancelled",
104 "responseType": "text/plain"
105 },
106 {
107 "method": "DELETE",
108 "rel": "deleteJob",
109 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65",
110 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65"
111 },
112 {
113 "method": "POST",
114 "rel": "getCategories",
115 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",
116 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/categories",
117 "type": "application/vnd.sas.sand.analytics.explore",
118 "responseType": "application/vnd.sas.sand.analytics.categories"
119 },
120 {
121 "method": "POST",
122 "rel": "getResults",
123 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",
124 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/results",
125 "type": "application/vnd.sas.sand.analytics.explore",
126 "responseType": "application/vnd.sas.sand.analytics.results"
127 },
128 {
129 "method": "POST",
130 "rel": "getSankeyDiagram",
131 "href": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",
132 "uri": "/svi-sand/analytics/4fa45829-9b75-49c8-99f7-ef15aa838e65/sankeyDiagrams",
133 "type": "application/vnd.sas.sand.analytics.sankey.diagram.request",
134 "responseType": "application/vnd.sas.sand.analytics.sankey.diagram"
135 },
136 {
137 "method": "GET",
138 "rel": "getLocales",
139 "href": "/svi-sand/analytics/locales",
140 "uri": "/svi-sand/analytics/locales",
141 "type": "application/vnd.sas.collection",
142 "itemType": "application/vnd.sas.sand.analytics.locale"
143 },
144 {
145 "method": "POST",
146 "rel": "startTextAnalytics",
147 "href": "/svi-sand/analytics",
148 "uri": "/svi-sand/analytics",
149 "type": "application/vnd.sas.sand.analytics.request",
150 "responseType": "application/vnd.sas.sand.analytics.job"
151 }
152 ]
153}

Path Parameters

NameTypeRequiredDescription
jobId
string
true

The unique identifier of the text analytics job.

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
404Not FoundThere is no job for the given identifier.Schema