OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-language": { | 5 "https://www.googleapis.com/auth/cloud-language": { |
6 "description": "Apply machine learning models to reveal the
structure and meaning of text" | 6 "description": "Apply machine learning models to reveal the
structure and meaning of text" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
9 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
10 } | 10 } |
(...skipping 10 matching lines...) Expand all Loading... |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "language:v1beta2", | 25 "id": "language:v1beta2", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "language", | 27 "name": "language", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "uploadType": { | 31 "upload_protocol": { |
32 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 33 "location": "query", |
34 "type": "string" | 34 "type": "string" |
35 }, | 35 }, |
| 36 "prettyPrint": { |
| 37 "default": "true", |
| 38 "description": "Returns response with indentations and line breaks."
, |
| 39 "location": "query", |
| 40 "type": "boolean" |
| 41 }, |
36 "fields": { | 42 "fields": { |
37 "description": "Selector specifying which fields to include in a par
tial response.", | 43 "description": "Selector specifying which fields to include in a par
tial response.", |
38 "location": "query", | 44 "location": "query", |
39 "type": "string" | 45 "type": "string" |
40 }, | 46 }, |
| 47 "uploadType": { |
| 48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
41 "callback": { | 52 "callback": { |
42 "description": "JSONP", | 53 "description": "JSONP", |
43 "location": "query", | 54 "location": "query", |
44 "type": "string" | 55 "type": "string" |
45 }, | 56 }, |
46 "$.xgafv": { | 57 "$.xgafv": { |
47 "description": "V1 error format.", | 58 "description": "V1 error format.", |
48 "enum": [ | 59 "enum": [ |
49 "1", | 60 "1", |
50 "2" | 61 "2" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
86 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
87 "location": "query", | 98 "location": "query", |
88 "type": "string" | 99 "type": "string" |
89 }, | 100 }, |
90 "pp": { | 101 "pp": { |
91 "default": "true", | 102 "default": "true", |
92 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
93 "location": "query", | 104 "location": "query", |
94 "type": "boolean" | 105 "type": "boolean" |
95 }, | 106 }, |
96 "bearer_token": { | |
97 "description": "OAuth bearer token.", | |
98 "location": "query", | |
99 "type": "string" | |
100 }, | |
101 "oauth_token": { | 107 "oauth_token": { |
102 "description": "OAuth 2.0 token for the current user.", | 108 "description": "OAuth 2.0 token for the current user.", |
103 "location": "query", | 109 "location": "query", |
104 "type": "string" | 110 "type": "string" |
105 }, | 111 }, |
106 "upload_protocol": { | 112 "bearer_token": { |
107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 113 "description": "OAuth bearer token.", |
108 "location": "query", | 114 "location": "query", |
109 "type": "string" | 115 "type": "string" |
110 }, | |
111 "prettyPrint": { | |
112 "default": "true", | |
113 "description": "Returns response with indentations and line breaks."
, | |
114 "location": "query", | |
115 "type": "boolean" | |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "documents": { | 120 "documents": { |
121 "methods": { | 121 "methods": { |
| 122 "analyzeSyntax": { |
| 123 "description": "Analyzes the syntax of the text and provides
sentence boundaries and\ntokenization along with part of speech tags, dependenc
y trees, and other\nproperties.", |
| 124 "httpMethod": "POST", |
| 125 "id": "language.documents.analyzeSyntax", |
| 126 "parameterOrder": [], |
| 127 "parameters": {}, |
| 128 "path": "v1beta2/documents:analyzeSyntax", |
| 129 "request": { |
| 130 "$ref": "AnalyzeSyntaxRequest" |
| 131 }, |
| 132 "response": { |
| 133 "$ref": "AnalyzeSyntaxResponse" |
| 134 }, |
| 135 "scopes": [ |
| 136 "https://www.googleapis.com/auth/cloud-language", |
| 137 "https://www.googleapis.com/auth/cloud-platform" |
| 138 ] |
| 139 }, |
122 "annotateText": { | 140 "annotateText": { |
123 "description": "A convenience method that provides all synta
x, sentiment, entity, and\nclassification features in one call.", | 141 "description": "A convenience method that provides all synta
x, sentiment, entity, and\nclassification features in one call.", |
124 "httpMethod": "POST", | 142 "httpMethod": "POST", |
125 "id": "language.documents.annotateText", | 143 "id": "language.documents.annotateText", |
126 "parameterOrder": [], | 144 "parameterOrder": [], |
127 "parameters": {}, | 145 "parameters": {}, |
128 "path": "v1beta2/documents:annotateText", | 146 "path": "v1beta2/documents:annotateText", |
129 "request": { | 147 "request": { |
130 "$ref": "AnnotateTextRequest" | 148 "$ref": "AnnotateTextRequest" |
131 }, | 149 }, |
132 "response": { | 150 "response": { |
133 "$ref": "AnnotateTextResponse" | 151 "$ref": "AnnotateTextResponse" |
134 }, | 152 }, |
135 "scopes": [ | 153 "scopes": [ |
136 "https://www.googleapis.com/auth/cloud-language", | 154 "https://www.googleapis.com/auth/cloud-language", |
137 "https://www.googleapis.com/auth/cloud-platform" | 155 "https://www.googleapis.com/auth/cloud-platform" |
138 ] | 156 ] |
139 }, | 157 }, |
| 158 "classifyText": { |
| 159 "description": "Classifies a document into categories.", |
| 160 "httpMethod": "POST", |
| 161 "id": "language.documents.classifyText", |
| 162 "parameterOrder": [], |
| 163 "parameters": {}, |
| 164 "path": "v1beta2/documents:classifyText", |
| 165 "request": { |
| 166 "$ref": "ClassifyTextRequest" |
| 167 }, |
| 168 "response": { |
| 169 "$ref": "ClassifyTextResponse" |
| 170 }, |
| 171 "scopes": [ |
| 172 "https://www.googleapis.com/auth/cloud-language", |
| 173 "https://www.googleapis.com/auth/cloud-platform" |
| 174 ] |
| 175 }, |
| 176 "analyzeSentiment": { |
| 177 "description": "Analyzes the sentiment of the provided text.
", |
| 178 "httpMethod": "POST", |
| 179 "id": "language.documents.analyzeSentiment", |
| 180 "parameterOrder": [], |
| 181 "parameters": {}, |
| 182 "path": "v1beta2/documents:analyzeSentiment", |
| 183 "request": { |
| 184 "$ref": "AnalyzeSentimentRequest" |
| 185 }, |
| 186 "response": { |
| 187 "$ref": "AnalyzeSentimentResponse" |
| 188 }, |
| 189 "scopes": [ |
| 190 "https://www.googleapis.com/auth/cloud-language", |
| 191 "https://www.googleapis.com/auth/cloud-platform" |
| 192 ] |
| 193 }, |
140 "analyzeEntitySentiment": { | 194 "analyzeEntitySentiment": { |
141 "description": "Finds entities, similar to AnalyzeEntities i
n the text and analyzes\nsentiment associated with each entity and its mentions.
", | 195 "description": "Finds entities, similar to AnalyzeEntities i
n the text and analyzes\nsentiment associated with each entity and its mentions.
", |
142 "httpMethod": "POST", | 196 "httpMethod": "POST", |
143 "id": "language.documents.analyzeEntitySentiment", | 197 "id": "language.documents.analyzeEntitySentiment", |
144 "parameterOrder": [], | 198 "parameterOrder": [], |
145 "parameters": {}, | 199 "parameters": {}, |
146 "path": "v1beta2/documents:analyzeEntitySentiment", | 200 "path": "v1beta2/documents:analyzeEntitySentiment", |
147 "request": { | 201 "request": { |
148 "$ref": "AnalyzeEntitySentimentRequest" | 202 "$ref": "AnalyzeEntitySentimentRequest" |
149 }, | 203 }, |
(...skipping 13 matching lines...) Expand all Loading... |
163 "parameters": {}, | 217 "parameters": {}, |
164 "path": "v1beta2/documents:analyzeEntities", | 218 "path": "v1beta2/documents:analyzeEntities", |
165 "request": { | 219 "request": { |
166 "$ref": "AnalyzeEntitiesRequest" | 220 "$ref": "AnalyzeEntitiesRequest" |
167 }, | 221 }, |
168 "response": { | 222 "response": { |
169 "$ref": "AnalyzeEntitiesResponse" | 223 "$ref": "AnalyzeEntitiesResponse" |
170 }, | 224 }, |
171 "scopes": [ | 225 "scopes": [ |
172 "https://www.googleapis.com/auth/cloud-language", | 226 "https://www.googleapis.com/auth/cloud-language", |
173 "https://www.googleapis.com/auth/cloud-platform" | |
174 ] | |
175 }, | |
176 "analyzeSyntax": { | |
177 "description": "Analyzes the syntax of the text and provides
sentence boundaries and\ntokenization along with part of speech tags, dependenc
y trees, and other\nproperties.", | |
178 "httpMethod": "POST", | |
179 "id": "language.documents.analyzeSyntax", | |
180 "parameterOrder": [], | |
181 "parameters": {}, | |
182 "path": "v1beta2/documents:analyzeSyntax", | |
183 "request": { | |
184 "$ref": "AnalyzeSyntaxRequest" | |
185 }, | |
186 "response": { | |
187 "$ref": "AnalyzeSyntaxResponse" | |
188 }, | |
189 "scopes": [ | |
190 "https://www.googleapis.com/auth/cloud-language", | |
191 "https://www.googleapis.com/auth/cloud-platform" | |
192 ] | |
193 }, | |
194 "analyzeSentiment": { | |
195 "description": "Analyzes the sentiment of the provided text.
", | |
196 "httpMethod": "POST", | |
197 "id": "language.documents.analyzeSentiment", | |
198 "parameterOrder": [], | |
199 "parameters": {}, | |
200 "path": "v1beta2/documents:analyzeSentiment", | |
201 "request": { | |
202 "$ref": "AnalyzeSentimentRequest" | |
203 }, | |
204 "response": { | |
205 "$ref": "AnalyzeSentimentResponse" | |
206 }, | |
207 "scopes": [ | |
208 "https://www.googleapis.com/auth/cloud-language", | |
209 "https://www.googleapis.com/auth/cloud-platform" | 227 "https://www.googleapis.com/auth/cloud-platform" |
210 ] | 228 ] |
211 } | 229 } |
212 } | 230 } |
213 } | 231 } |
214 }, | 232 }, |
215 "revision": "20170809", | 233 "revision": "20170905", |
216 "rootUrl": "https://language.googleapis.com/", | 234 "rootUrl": "https://language.googleapis.com/", |
217 "schemas": { | 235 "schemas": { |
218 "AnalyzeSentimentResponse": { | 236 "AnalyzeSentimentResponse": { |
219 "description": "The sentiment analysis response message.", | 237 "description": "The sentiment analysis response message.", |
220 "id": "AnalyzeSentimentResponse", | 238 "id": "AnalyzeSentimentResponse", |
221 "properties": { | 239 "properties": { |
222 "documentSentiment": { | 240 "documentSentiment": { |
223 "$ref": "Sentiment", | 241 "$ref": "Sentiment", |
224 "description": "The overall sentiment of the input document.
" | 242 "description": "The overall sentiment of the input document.
" |
225 }, | 243 }, |
226 "language": { | 244 "language": { |
227 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", | 245 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", |
228 "type": "string" | 246 "type": "string" |
229 }, | 247 }, |
230 "sentences": { | 248 "sentences": { |
231 "description": "The sentiment for all the sentences in the d
ocument.", | 249 "description": "The sentiment for all the sentences in the d
ocument.", |
232 "items": { | 250 "items": { |
233 "$ref": "Sentence" | 251 "$ref": "Sentence" |
234 }, | 252 }, |
235 "type": "array" | 253 "type": "array" |
236 } | 254 } |
237 }, | 255 }, |
238 "type": "object" | 256 "type": "object" |
239 }, | 257 }, |
240 "AnalyzeEntitiesResponse": { | |
241 "description": "The entity analysis response message.", | |
242 "id": "AnalyzeEntitiesResponse", | |
243 "properties": { | |
244 "entities": { | |
245 "description": "The recognized entities in the input documen
t.", | |
246 "items": { | |
247 "$ref": "Entity" | |
248 }, | |
249 "type": "array" | |
250 }, | |
251 "language": { | |
252 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", | |
253 "type": "string" | |
254 } | |
255 }, | |
256 "type": "object" | |
257 }, | |
258 "Entity": { | |
259 "description": "Represents a phrase in the text that is a known enti
ty, such as\na person, an organization, or location. The API associates informat
ion, such\nas salience and mentions, with entities.", | |
260 "id": "Entity", | |
261 "properties": { | |
262 "mentions": { | |
263 "description": "The mentions of this entity in the input doc
ument. The API currently\nsupports proper noun mentions.", | |
264 "items": { | |
265 "$ref": "EntityMention" | |
266 }, | |
267 "type": "array" | |
268 }, | |
269 "name": { | |
270 "description": "The representative name for the entity.", | |
271 "type": "string" | |
272 }, | |
273 "type": { | |
274 "description": "The entity type.", | |
275 "enum": [ | |
276 "UNKNOWN", | |
277 "PERSON", | |
278 "LOCATION", | |
279 "ORGANIZATION", | |
280 "EVENT", | |
281 "WORK_OF_ART", | |
282 "CONSUMER_GOOD", | |
283 "OTHER" | |
284 ], | |
285 "enumDescriptions": [ | |
286 "Unknown", | |
287 "Person", | |
288 "Location", | |
289 "Organization", | |
290 "Event", | |
291 "Work of art", | |
292 "Consumer goods", | |
293 "Other types" | |
294 ], | |
295 "type": "string" | |
296 }, | |
297 "metadata": { | |
298 "additionalProperties": { | |
299 "type": "string" | |
300 }, | |
301 "description": "Metadata associated with the entity.\n\nCurr
ently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The
associated keys are \"wikipedia_url\" and \"mid\", respectively.", | |
302 "type": "object" | |
303 }, | |
304 "salience": { | |
305 "description": "The salience score associated with the entit
y in the [0, 1.0] range.\n\nThe salience score for an entity provides informatio
n about the\nimportance or centrality of that entity to the entire document text
.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\ns
alient.", | |
306 "format": "float", | |
307 "type": "number" | |
308 }, | |
309 "sentiment": { | |
310 "$ref": "Sentiment", | |
311 "description": "For calls to AnalyzeEntitySentiment or if\nA
nnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field
will contain the aggregate sentiment expressed for this\nentity in the provided
document." | |
312 } | |
313 }, | |
314 "type": "object" | |
315 }, | |
316 "AnalyzeSyntaxResponse": { | 258 "AnalyzeSyntaxResponse": { |
317 "description": "The syntax analysis response message.", | 259 "description": "The syntax analysis response message.", |
318 "id": "AnalyzeSyntaxResponse", | 260 "id": "AnalyzeSyntaxResponse", |
319 "properties": { | 261 "properties": { |
| 262 "language": { |
| 263 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", |
| 264 "type": "string" |
| 265 }, |
320 "sentences": { | 266 "sentences": { |
321 "description": "Sentences in the input document.", | 267 "description": "Sentences in the input document.", |
322 "items": { | 268 "items": { |
323 "$ref": "Sentence" | 269 "$ref": "Sentence" |
324 }, | 270 }, |
325 "type": "array" | 271 "type": "array" |
326 }, | 272 }, |
327 "tokens": { | 273 "tokens": { |
328 "description": "Tokens, along with their syntactic informati
on, in the input document.", | 274 "description": "Tokens, along with their syntactic informati
on, in the input document.", |
329 "items": { | 275 "items": { |
330 "$ref": "Token" | 276 "$ref": "Token" |
331 }, | 277 }, |
332 "type": "array" | 278 "type": "array" |
333 }, | |
334 "language": { | |
335 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", | |
336 "type": "string" | |
337 } | 279 } |
338 }, | 280 }, |
339 "type": "object" | 281 "type": "object" |
340 }, | |
341 "AnnotateTextRequest": { | |
342 "description": "The request message for the text annotation API, whi
ch can perform multiple\nanalysis types (sentiment, entities, and syntax) in one
call.", | |
343 "id": "AnnotateTextRequest", | |
344 "properties": { | |
345 "encodingType": { | |
346 "description": "The encoding type used by the API to calcula
te offsets.", | |
347 "enum": [ | |
348 "NONE", | |
349 "UTF8", | |
350 "UTF16", | |
351 "UTF32" | |
352 ], | |
353 "enumDescriptions": [ | |
354 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | |
355 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", | |
356 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", | |
357 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." | |
358 ], | |
359 "type": "string" | |
360 }, | |
361 "document": { | |
362 "$ref": "Document", | |
363 "description": "Input document." | |
364 }, | |
365 "features": { | |
366 "$ref": "Features", | |
367 "description": "The enabled features." | |
368 } | |
369 }, | |
370 "type": "object" | |
371 }, | 282 }, |
372 "AnnotateTextResponse": { | 283 "AnnotateTextResponse": { |
373 "description": "The text annotations response message.", | 284 "description": "The text annotations response message.", |
374 "id": "AnnotateTextResponse", | 285 "id": "AnnotateTextResponse", |
375 "properties": { | 286 "properties": { |
376 "documentSentiment": { | |
377 "$ref": "Sentiment", | |
378 "description": "The overall sentiment for the document. Popu
lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime
nt." | |
379 }, | |
380 "language": { | |
381 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", | |
382 "type": "string" | |
383 }, | |
384 "sentences": { | 287 "sentences": { |
385 "description": "Sentences in the input document. Populated i
f the user enables\nAnnotateTextRequest.Features.extract_syntax.", | 288 "description": "Sentences in the input document. Populated i
f the user enables\nAnnotateTextRequest.Features.extract_syntax.", |
386 "items": { | 289 "items": { |
387 "$ref": "Sentence" | 290 "$ref": "Sentence" |
388 }, | 291 }, |
389 "type": "array" | 292 "type": "array" |
390 }, | 293 }, |
391 "tokens": { | 294 "tokens": { |
392 "description": "Tokens, along with their syntactic informati
on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F
eatures.extract_syntax.", | 295 "description": "Tokens, along with their syntactic informati
on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F
eatures.extract_syntax.", |
393 "items": { | 296 "items": { |
394 "$ref": "Token" | 297 "$ref": "Token" |
395 }, | 298 }, |
396 "type": "array" | 299 "type": "array" |
397 }, | 300 }, |
| 301 "documentSentiment": { |
| 302 "$ref": "Sentiment", |
| 303 "description": "The overall sentiment for the document. Popu
lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime
nt." |
| 304 }, |
| 305 "categories": { |
| 306 "description": "Categories identified in the input document.
", |
| 307 "items": { |
| 308 "$ref": "ClassificationCategory" |
| 309 }, |
| 310 "type": "array" |
| 311 }, |
| 312 "language": { |
| 313 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", |
| 314 "type": "string" |
| 315 }, |
398 "entities": { | 316 "entities": { |
399 "description": "Entities, along with their semantic informat
ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.
Features.extract_entities.", | 317 "description": "Entities, along with their semantic informat
ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.
Features.extract_entities.", |
400 "items": { | 318 "items": { |
401 "$ref": "Entity" | 319 "$ref": "Entity" |
402 }, | 320 }, |
403 "type": "array" | 321 "type": "array" |
404 } | 322 } |
405 }, | 323 }, |
406 "type": "object" | 324 "type": "object" |
407 }, | 325 }, |
408 "AnalyzeSentimentRequest": { | |
409 "description": "The sentiment analysis request message.", | |
410 "id": "AnalyzeSentimentRequest", | |
411 "properties": { | |
412 "encodingType": { | |
413 "description": "The encoding type used by the API to calcula
te sentence offsets for the\nsentence sentiment.", | |
414 "enum": [ | |
415 "NONE", | |
416 "UTF8", | |
417 "UTF16", | |
418 "UTF32" | |
419 ], | |
420 "enumDescriptions": [ | |
421 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | |
422 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", | |
423 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", | |
424 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." | |
425 ], | |
426 "type": "string" | |
427 }, | |
428 "document": { | |
429 "$ref": "Document", | |
430 "description": "Input document." | |
431 } | |
432 }, | |
433 "type": "object" | |
434 }, | |
435 "DependencyEdge": { | 326 "DependencyEdge": { |
436 "description": "Represents dependency parse tree information for a t
oken.", | 327 "description": "Represents dependency parse tree information for a t
oken.", |
437 "id": "DependencyEdge", | 328 "id": "DependencyEdge", |
438 "properties": { | 329 "properties": { |
| 330 "headTokenIndex": { |
| 331 "description": "Represents the head of this token in the dep
endency tree.\nThis is the index of the token which has an arc going to this tok
en.\nThe index is the position of the token in the array of tokens returned\nby
the API method. If this token is a root token, then the\n`head_token_index` is i
ts own index.", |
| 332 "format": "int32", |
| 333 "type": "integer" |
| 334 }, |
439 "label": { | 335 "label": { |
440 "description": "The parse label for the token.", | 336 "description": "The parse label for the token.", |
441 "enum": [ | 337 "enum": [ |
442 "UNKNOWN", | 338 "UNKNOWN", |
443 "ABBREV", | 339 "ABBREV", |
444 "ACOMP", | 340 "ACOMP", |
445 "ADVCL", | 341 "ADVCL", |
446 "ADVMOD", | 342 "ADVMOD", |
447 "AMOD", | 343 "AMOD", |
448 "APPOS", | 344 "APPOS", |
(...skipping 141 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
590 "Keyword", | 486 "Keyword", |
591 "List for chains of comparable items", | 487 "List for chains of comparable items", |
592 "Nominalized clause", | 488 "Nominalized clause", |
593 "Nominalized clausal subject", | 489 "Nominalized clausal subject", |
594 "Nominalized clausal passive", | 490 "Nominalized clausal passive", |
595 "Compound of numeric modifier", | 491 "Compound of numeric modifier", |
596 "Copula", | 492 "Copula", |
597 "Dislocated relation (for fronted/topicalized elements)" | 493 "Dislocated relation (for fronted/topicalized elements)" |
598 ], | 494 ], |
599 "type": "string" | 495 "type": "string" |
600 }, | |
601 "headTokenIndex": { | |
602 "description": "Represents the head of this token in the dep
endency tree.\nThis is the index of the token which has an arc going to this tok
en.\nThe index is the position of the token in the array of tokens returned\nby
the API method. If this token is a root token, then the\n`head_token_index` is i
ts own index.", | |
603 "format": "int32", | |
604 "type": "integer" | |
605 } | |
606 }, | |
607 "type": "object" | |
608 }, | |
609 "TextSpan": { | |
610 "description": "Represents an output piece of text.", | |
611 "id": "TextSpan", | |
612 "properties": { | |
613 "beginOffset": { | |
614 "description": "The API calculates the beginning offset of t
he content in the original\ndocument according to the EncodingType specified in
the API request.", | |
615 "format": "int32", | |
616 "type": "integer" | |
617 }, | |
618 "content": { | |
619 "description": "The content of the output text.", | |
620 "type": "string" | |
621 } | 496 } |
622 }, | 497 }, |
623 "type": "object" | 498 "type": "object" |
624 }, | 499 }, |
625 "Token": { | 500 "Token": { |
626 "description": "Represents the smallest syntactic building block of
the text.", | 501 "description": "Represents the smallest syntactic building block of
the text.", |
627 "id": "Token", | 502 "id": "Token", |
628 "properties": { | 503 "properties": { |
629 "partOfSpeech": { | 504 "partOfSpeech": { |
630 "$ref": "PartOfSpeech", | 505 "$ref": "PartOfSpeech", |
631 "description": "Parts of speech tag for this token." | 506 "description": "Parts of speech tag for this token." |
632 }, | 507 }, |
633 "dependencyEdge": { | 508 "dependencyEdge": { |
634 "$ref": "DependencyEdge", | 509 "$ref": "DependencyEdge", |
635 "description": "Dependency tree parse for this token." | 510 "description": "Dependency tree parse for this token." |
636 }, | 511 }, |
637 "text": { | 512 "text": { |
638 "$ref": "TextSpan", | 513 "$ref": "TextSpan", |
639 "description": "The token text." | 514 "description": "The token text." |
640 }, | 515 }, |
641 "lemma": { | 516 "lemma": { |
642 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_
%28morphology%29) of the token.", | 517 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_
%28morphology%29) of the token.", |
643 "type": "string" | 518 "type": "string" |
644 } | 519 } |
645 }, | 520 }, |
646 "type": "object" | 521 "type": "object" |
647 }, | 522 }, |
648 "Status": { | 523 "TextSpan": { |
649 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | 524 "description": "Represents an output piece of text.", |
650 "id": "Status", | 525 "id": "TextSpan", |
651 "properties": { | 526 "properties": { |
652 "message": { | 527 "beginOffset": { |
653 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | 528 "description": "The API calculates the beginning offset of t
he content in the original\ndocument according to the EncodingType specified in
the API request.", |
654 "type": "string" | |
655 }, | |
656 "details": { | |
657 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", | |
658 "items": { | |
659 "additionalProperties": { | |
660 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
661 "type": "any" | |
662 }, | |
663 "type": "object" | |
664 }, | |
665 "type": "array" | |
666 }, | |
667 "code": { | |
668 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
669 "format": "int32", | 529 "format": "int32", |
670 "type": "integer" | 530 "type": "integer" |
| 531 }, |
| 532 "content": { |
| 533 "description": "The content of the output text.", |
| 534 "type": "string" |
671 } | 535 } |
672 }, | 536 }, |
673 "type": "object" | 537 "type": "object" |
674 }, | |
675 "Features": { | |
676 "description": "All available features for sentiment, syntax, and se
mantic analysis.\nSetting each one to true will enable that specific analysis fo
r the input.", | |
677 "id": "Features", | |
678 "properties": { | |
679 "extractEntitySentiment": { | |
680 "description": "Extract entities and their associated sentim
ent.", | |
681 "type": "boolean" | |
682 }, | |
683 "extractDocumentSentiment": { | |
684 "description": "Extract document-level sentiment.", | |
685 "type": "boolean" | |
686 }, | |
687 "extractSyntax": { | |
688 "description": "Extract syntax information.", | |
689 "type": "boolean" | |
690 }, | |
691 "extractEntities": { | |
692 "description": "Extract entities.", | |
693 "type": "boolean" | |
694 } | |
695 }, | |
696 "type": "object" | |
697 }, | 538 }, |
698 "EntityMention": { | 539 "EntityMention": { |
699 "description": "Represents a mention for an entity in the text. Curr
ently, proper noun\nmentions are supported.", | 540 "description": "Represents a mention for an entity in the text. Curr
ently, proper noun\nmentions are supported.", |
700 "id": "EntityMention", | 541 "id": "EntityMention", |
701 "properties": { | 542 "properties": { |
| 543 "sentiment": { |
| 544 "$ref": "Sentiment", |
| 545 "description": "For calls to AnalyzeEntitySentiment or if\nA
nnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field
will contain the sentiment expressed for this mention of\nthe entity in the pro
vided document." |
| 546 }, |
702 "type": { | 547 "type": { |
703 "description": "The type of the entity mention.", | 548 "description": "The type of the entity mention.", |
704 "enum": [ | 549 "enum": [ |
705 "TYPE_UNKNOWN", | 550 "TYPE_UNKNOWN", |
706 "PROPER", | 551 "PROPER", |
707 "COMMON" | 552 "COMMON" |
708 ], | 553 ], |
709 "enumDescriptions": [ | 554 "enumDescriptions": [ |
710 "Unknown", | 555 "Unknown", |
711 "Proper name", | 556 "Proper name", |
712 "Common noun (or noun compound)" | 557 "Common noun (or noun compound)" |
713 ], | 558 ], |
714 "type": "string" | 559 "type": "string" |
715 }, | 560 }, |
716 "text": { | 561 "text": { |
717 "$ref": "TextSpan", | 562 "$ref": "TextSpan", |
718 "description": "The mention text." | 563 "description": "The mention text." |
719 }, | |
720 "sentiment": { | |
721 "$ref": "Sentiment", | |
722 "description": "For calls to AnalyzeEntitySentiment or if\nA
nnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field
will contain the sentiment expressed for this mention of\nthe entity in the pro
vided document." | |
723 } | 564 } |
724 }, | 565 }, |
725 "type": "object" | 566 "type": "object" |
| 567 }, |
| 568 "ClassifyTextResponse": { |
| 569 "description": "The document classification response message.", |
| 570 "id": "ClassifyTextResponse", |
| 571 "properties": { |
| 572 "categories": { |
| 573 "description": "Categories representing the input document."
, |
| 574 "items": { |
| 575 "$ref": "ClassificationCategory" |
| 576 }, |
| 577 "type": "array" |
| 578 } |
| 579 }, |
| 580 "type": "object" |
726 }, | 581 }, |
727 "Sentence": { | 582 "Sentence": { |
728 "description": "Represents a sentence in the input document.", | 583 "description": "Represents a sentence in the input document.", |
729 "id": "Sentence", | 584 "id": "Sentence", |
730 "properties": { | 585 "properties": { |
| 586 "sentiment": { |
| 587 "$ref": "Sentiment", |
| 588 "description": "For calls to AnalyzeSentiment or if\nAnnotat
eTextRequest.Features.extract_document_sentiment is set to\ntrue, this field wil
l contain the sentiment for the sentence." |
| 589 }, |
731 "text": { | 590 "text": { |
732 "$ref": "TextSpan", | 591 "$ref": "TextSpan", |
733 "description": "The sentence text." | 592 "description": "The sentence text." |
734 }, | |
735 "sentiment": { | |
736 "$ref": "Sentiment", | |
737 "description": "For calls to AnalyzeSentiment or if\nAnnotat
eTextRequest.Features.extract_document_sentiment is set to\ntrue, this field wil
l contain the sentiment for the sentence." | |
738 } | 593 } |
739 }, | 594 }, |
740 "type": "object" | 595 "type": "object" |
741 }, | |
742 "Document": { | |
743 "description": "####################################################
############ #\n\nRepresents the input to API methods.", | |
744 "id": "Document", | |
745 "properties": { | |
746 "gcsContentUri": { | |
747 "description": "The Google Cloud Storage URI where the file
content is located.\nThis URI must be of the form: gs://bucket_name/object_name.
For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nN
OTE: Cloud Storage object versioning is not supported.", | |
748 "type": "string" | |
749 }, | |
750 "language": { | |
751 "description": "The language of the document (if not specifi
ed, the language is\nautomatically detected). Both ISO and BCP-47 language codes
are\naccepted.<br>\n[Language Support](/natural-language/docs/languages)\nlists
currently supported languages for each API method.\nIf the language (either spe
cified by the caller or automatically detected)\nis not supported by the called
API method, an `INVALID_ARGUMENT` error\nis returned.", | |
752 "type": "string" | |
753 }, | |
754 "content": { | |
755 "description": "The content of the input in string format.", | |
756 "type": "string" | |
757 }, | |
758 "type": { | |
759 "description": "Required. If the type is not set or is `TYPE
_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", | |
760 "enum": [ | |
761 "TYPE_UNSPECIFIED", | |
762 "PLAIN_TEXT", | |
763 "HTML" | |
764 ], | |
765 "enumDescriptions": [ | |
766 "The content type is not specified.", | |
767 "Plain text", | |
768 "HTML" | |
769 ], | |
770 "type": "string" | |
771 } | |
772 }, | |
773 "type": "object" | |
774 }, | 596 }, |
775 "Sentiment": { | 597 "Sentiment": { |
776 "description": "Represents the feeling associated with the entire te
xt or entities in\nthe text.", | 598 "description": "Represents the feeling associated with the entire te
xt or entities in\nthe text.", |
777 "id": "Sentiment", | 599 "id": "Sentiment", |
778 "properties": { | 600 "properties": { |
779 "score": { | 601 "score": { |
780 "description": "Sentiment score between -1.0 (negative senti
ment) and 1.0\n(positive sentiment).", | 602 "description": "Sentiment score between -1.0 (negative senti
ment) and 1.0\n(positive sentiment).", |
781 "format": "float", | 603 "format": "float", |
782 "type": "number" | 604 "type": "number" |
783 }, | 605 }, |
784 "magnitude": { | 606 "magnitude": { |
785 "description": "A non-negative number in the [0, +inf) range
, which represents\nthe absolute magnitude of sentiment regardless of score (pos
itive or\nnegative).", | 607 "description": "A non-negative number in the [0, +inf) range
, which represents\nthe absolute magnitude of sentiment regardless of score (pos
itive or\nnegative).", |
786 "format": "float", | 608 "format": "float", |
787 "type": "number" | 609 "type": "number" |
788 } | 610 } |
789 }, | 611 }, |
790 "type": "object" | 612 "type": "object" |
791 }, | 613 }, |
792 "AnalyzeEntitiesRequest": { | |
793 "description": "The entity analysis request message.", | |
794 "id": "AnalyzeEntitiesRequest", | |
795 "properties": { | |
796 "encodingType": { | |
797 "description": "The encoding type used by the API to calcula
te offsets.", | |
798 "enum": [ | |
799 "NONE", | |
800 "UTF8", | |
801 "UTF16", | |
802 "UTF32" | |
803 ], | |
804 "enumDescriptions": [ | |
805 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | |
806 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", | |
807 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", | |
808 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." | |
809 ], | |
810 "type": "string" | |
811 }, | |
812 "document": { | |
813 "$ref": "Document", | |
814 "description": "Input document." | |
815 } | |
816 }, | |
817 "type": "object" | |
818 }, | |
819 "AnalyzeEntitySentimentResponse": { | |
820 "description": "The entity-level sentiment analysis response message
.", | |
821 "id": "AnalyzeEntitySentimentResponse", | |
822 "properties": { | |
823 "language": { | |
824 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", | |
825 "type": "string" | |
826 }, | |
827 "entities": { | |
828 "description": "The recognized entities in the input documen
t with associated sentiments.", | |
829 "items": { | |
830 "$ref": "Entity" | |
831 }, | |
832 "type": "array" | |
833 } | |
834 }, | |
835 "type": "object" | |
836 }, | |
837 "AnalyzeEntitySentimentRequest": { | 614 "AnalyzeEntitySentimentRequest": { |
838 "description": "The entity-level sentiment analysis request message.
", | 615 "description": "The entity-level sentiment analysis request message.
", |
839 "id": "AnalyzeEntitySentimentRequest", | 616 "id": "AnalyzeEntitySentimentRequest", |
840 "properties": { | 617 "properties": { |
841 "encodingType": { | 618 "encodingType": { |
842 "description": "The encoding type used by the API to calcula
te offsets.", | 619 "description": "The encoding type used by the API to calcula
te offsets.", |
843 "enum": [ | 620 "enum": [ |
844 "NONE", | 621 "NONE", |
845 "UTF8", | 622 "UTF8", |
846 "UTF16", | 623 "UTF16", |
(...skipping 11 matching lines...) Expand all Loading... |
858 "$ref": "Document", | 635 "$ref": "Document", |
859 "description": "Input document." | 636 "description": "Input document." |
860 } | 637 } |
861 }, | 638 }, |
862 "type": "object" | 639 "type": "object" |
863 }, | 640 }, |
864 "PartOfSpeech": { | 641 "PartOfSpeech": { |
865 "description": "Represents part of speech information for a token.", | 642 "description": "Represents part of speech information for a token.", |
866 "id": "PartOfSpeech", | 643 "id": "PartOfSpeech", |
867 "properties": { | 644 "properties": { |
| 645 "mood": { |
| 646 "description": "The grammatical mood.", |
| 647 "enum": [ |
| 648 "MOOD_UNKNOWN", |
| 649 "CONDITIONAL_MOOD", |
| 650 "IMPERATIVE", |
| 651 "INDICATIVE", |
| 652 "INTERROGATIVE", |
| 653 "JUSSIVE", |
| 654 "SUBJUNCTIVE" |
| 655 ], |
| 656 "enumDescriptions": [ |
| 657 "Mood is not applicable in the analyzed language or is n
ot predicted.", |
| 658 "Conditional", |
| 659 "Imperative", |
| 660 "Indicative", |
| 661 "Interrogative", |
| 662 "Jussive", |
| 663 "Subjunctive" |
| 664 ], |
| 665 "type": "string" |
| 666 }, |
| 667 "tag": { |
| 668 "description": "The part of speech tag.", |
| 669 "enum": [ |
| 670 "UNKNOWN", |
| 671 "ADJ", |
| 672 "ADP", |
| 673 "ADV", |
| 674 "CONJ", |
| 675 "DET", |
| 676 "NOUN", |
| 677 "NUM", |
| 678 "PRON", |
| 679 "PRT", |
| 680 "PUNCT", |
| 681 "VERB", |
| 682 "X", |
| 683 "AFFIX" |
| 684 ], |
| 685 "enumDescriptions": [ |
| 686 "Unknown", |
| 687 "Adjective", |
| 688 "Adposition (preposition and postposition)", |
| 689 "Adverb", |
| 690 "Conjunction", |
| 691 "Determiner", |
| 692 "Noun (common and proper)", |
| 693 "Cardinal number", |
| 694 "Pronoun", |
| 695 "Particle or other function word", |
| 696 "Punctuation", |
| 697 "Verb (all tenses and modes)", |
| 698 "Other: foreign words, typos, abbreviations", |
| 699 "Affix" |
| 700 ], |
| 701 "type": "string" |
| 702 }, |
| 703 "gender": { |
| 704 "description": "The grammatical gender.", |
| 705 "enum": [ |
| 706 "GENDER_UNKNOWN", |
| 707 "FEMININE", |
| 708 "MASCULINE", |
| 709 "NEUTER" |
| 710 ], |
| 711 "enumDescriptions": [ |
| 712 "Gender is not applicable in the analyzed language or is
not predicted.", |
| 713 "Feminine", |
| 714 "Masculine", |
| 715 "Neuter" |
| 716 ], |
| 717 "type": "string" |
| 718 }, |
| 719 "person": { |
| 720 "description": "The grammatical person.", |
| 721 "enum": [ |
| 722 "PERSON_UNKNOWN", |
| 723 "FIRST", |
| 724 "SECOND", |
| 725 "THIRD", |
| 726 "REFLEXIVE_PERSON" |
| 727 ], |
| 728 "enumDescriptions": [ |
| 729 "Person is not applicable in the analyzed language or is
not predicted.", |
| 730 "First", |
| 731 "Second", |
| 732 "Third", |
| 733 "Reflexive" |
| 734 ], |
| 735 "type": "string" |
| 736 }, |
| 737 "proper": { |
| 738 "description": "The grammatical properness.", |
| 739 "enum": [ |
| 740 "PROPER_UNKNOWN", |
| 741 "PROPER", |
| 742 "NOT_PROPER" |
| 743 ], |
| 744 "enumDescriptions": [ |
| 745 "Proper is not applicable in the analyzed language or is
not predicted.", |
| 746 "Proper", |
| 747 "Not proper" |
| 748 ], |
| 749 "type": "string" |
| 750 }, |
868 "case": { | 751 "case": { |
869 "description": "The grammatical case.", | 752 "description": "The grammatical case.", |
870 "enum": [ | 753 "enum": [ |
871 "CASE_UNKNOWN", | 754 "CASE_UNKNOWN", |
872 "ACCUSATIVE", | 755 "ACCUSATIVE", |
873 "ADVERBIAL", | 756 "ADVERBIAL", |
874 "COMPLEMENTIVE", | 757 "COMPLEMENTIVE", |
875 "DATIVE", | 758 "DATIVE", |
876 "GENITIVE", | 759 "GENITIVE", |
877 "INSTRUMENTAL", | 760 "INSTRUMENTAL", |
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1011 "IMPERFECTIVE", | 894 "IMPERFECTIVE", |
1012 "PROGRESSIVE" | 895 "PROGRESSIVE" |
1013 ], | 896 ], |
1014 "enumDescriptions": [ | 897 "enumDescriptions": [ |
1015 "Aspect is not applicable in the analyzed language or is
not predicted.", | 898 "Aspect is not applicable in the analyzed language or is
not predicted.", |
1016 "Perfective", | 899 "Perfective", |
1017 "Imperfective", | 900 "Imperfective", |
1018 "Progressive" | 901 "Progressive" |
1019 ], | 902 ], |
1020 "type": "string" | 903 "type": "string" |
1021 }, | 904 } |
1022 "mood": { | 905 }, |
1023 "description": "The grammatical mood.", | 906 "type": "object" |
1024 "enum": [ | 907 }, |
1025 "MOOD_UNKNOWN", | 908 "ClassificationCategory": { |
1026 "CONDITIONAL_MOOD", | 909 "description": "Represents a category returned from the text classif
ier.", |
1027 "IMPERATIVE", | 910 "id": "ClassificationCategory", |
1028 "INDICATIVE", | 911 "properties": { |
1029 "INTERROGATIVE", | 912 "confidence": { |
1030 "JUSSIVE", | 913 "description": "The classifier's confidence of the category.
Number represents how certain\nthe classifier is that this category represents
the given text.", |
1031 "SUBJUNCTIVE" | 914 "format": "float", |
1032 ], | 915 "type": "number" |
1033 "enumDescriptions": [ | 916 }, |
1034 "Mood is not applicable in the analyzed language or is n
ot predicted.", | 917 "name": { |
1035 "Conditional", | 918 "description": "The name of the category representing the do
cument.", |
1036 "Imperative", | |
1037 "Indicative", | |
1038 "Interrogative", | |
1039 "Jussive", | |
1040 "Subjunctive" | |
1041 ], | |
1042 "type": "string" | |
1043 }, | |
1044 "tag": { | |
1045 "description": "The part of speech tag.", | |
1046 "enum": [ | |
1047 "UNKNOWN", | |
1048 "ADJ", | |
1049 "ADP", | |
1050 "ADV", | |
1051 "CONJ", | |
1052 "DET", | |
1053 "NOUN", | |
1054 "NUM", | |
1055 "PRON", | |
1056 "PRT", | |
1057 "PUNCT", | |
1058 "VERB", | |
1059 "X", | |
1060 "AFFIX" | |
1061 ], | |
1062 "enumDescriptions": [ | |
1063 "Unknown", | |
1064 "Adjective", | |
1065 "Adposition (preposition and postposition)", | |
1066 "Adverb", | |
1067 "Conjunction", | |
1068 "Determiner", | |
1069 "Noun (common and proper)", | |
1070 "Cardinal number", | |
1071 "Pronoun", | |
1072 "Particle or other function word", | |
1073 "Punctuation", | |
1074 "Verb (all tenses and modes)", | |
1075 "Other: foreign words, typos, abbreviations", | |
1076 "Affix" | |
1077 ], | |
1078 "type": "string" | |
1079 }, | |
1080 "gender": { | |
1081 "description": "The grammatical gender.", | |
1082 "enum": [ | |
1083 "GENDER_UNKNOWN", | |
1084 "FEMININE", | |
1085 "MASCULINE", | |
1086 "NEUTER" | |
1087 ], | |
1088 "enumDescriptions": [ | |
1089 "Gender is not applicable in the analyzed language or is
not predicted.", | |
1090 "Feminine", | |
1091 "Masculine", | |
1092 "Neuter" | |
1093 ], | |
1094 "type": "string" | |
1095 }, | |
1096 "person": { | |
1097 "description": "The grammatical person.", | |
1098 "enum": [ | |
1099 "PERSON_UNKNOWN", | |
1100 "FIRST", | |
1101 "SECOND", | |
1102 "THIRD", | |
1103 "REFLEXIVE_PERSON" | |
1104 ], | |
1105 "enumDescriptions": [ | |
1106 "Person is not applicable in the analyzed language or is
not predicted.", | |
1107 "First", | |
1108 "Second", | |
1109 "Third", | |
1110 "Reflexive" | |
1111 ], | |
1112 "type": "string" | |
1113 }, | |
1114 "proper": { | |
1115 "description": "The grammatical properness.", | |
1116 "enum": [ | |
1117 "PROPER_UNKNOWN", | |
1118 "PROPER", | |
1119 "NOT_PROPER" | |
1120 ], | |
1121 "enumDescriptions": [ | |
1122 "Proper is not applicable in the analyzed language or is
not predicted.", | |
1123 "Proper", | |
1124 "Not proper" | |
1125 ], | |
1126 "type": "string" | 919 "type": "string" |
1127 } | 920 } |
1128 }, | 921 }, |
1129 "type": "object" | 922 "type": "object" |
1130 }, | 923 }, |
1131 "AnalyzeSyntaxRequest": { | 924 "AnalyzeSyntaxRequest": { |
1132 "description": "The syntax analysis request message.", | 925 "description": "The syntax analysis request message.", |
1133 "id": "AnalyzeSyntaxRequest", | 926 "id": "AnalyzeSyntaxRequest", |
1134 "properties": { | 927 "properties": { |
1135 "encodingType": { | 928 "encodingType": { |
1136 "description": "The encoding type used by the API to calcula
te offsets.", | 929 "description": "The encoding type used by the API to calcula
te offsets.", |
| 930 "enum": [ |
| 931 "NONE", |
| 932 "UTF8", |
| 933 "UTF16", |
| 934 "UTF32" |
| 935 ], |
| 936 "enumDescriptions": [ |
| 937 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
| 938 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", |
| 939 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", |
| 940 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." |
| 941 ], |
| 942 "type": "string" |
| 943 }, |
| 944 "document": { |
| 945 "$ref": "Document", |
| 946 "description": "Input document." |
| 947 } |
| 948 }, |
| 949 "type": "object" |
| 950 }, |
| 951 "AnalyzeEntitiesResponse": { |
| 952 "description": "The entity analysis response message.", |
| 953 "id": "AnalyzeEntitiesResponse", |
| 954 "properties": { |
| 955 "language": { |
| 956 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", |
| 957 "type": "string" |
| 958 }, |
| 959 "entities": { |
| 960 "description": "The recognized entities in the input documen
t.", |
| 961 "items": { |
| 962 "$ref": "Entity" |
| 963 }, |
| 964 "type": "array" |
| 965 } |
| 966 }, |
| 967 "type": "object" |
| 968 }, |
| 969 "Entity": { |
| 970 "description": "Represents a phrase in the text that is a known enti
ty, such as\na person, an organization, or location. The API associates informat
ion, such\nas salience and mentions, with entities.", |
| 971 "id": "Entity", |
| 972 "properties": { |
| 973 "mentions": { |
| 974 "description": "The mentions of this entity in the input doc
ument. The API currently\nsupports proper noun mentions.", |
| 975 "items": { |
| 976 "$ref": "EntityMention" |
| 977 }, |
| 978 "type": "array" |
| 979 }, |
| 980 "name": { |
| 981 "description": "The representative name for the entity.", |
| 982 "type": "string" |
| 983 }, |
| 984 "type": { |
| 985 "description": "The entity type.", |
| 986 "enum": [ |
| 987 "UNKNOWN", |
| 988 "PERSON", |
| 989 "LOCATION", |
| 990 "ORGANIZATION", |
| 991 "EVENT", |
| 992 "WORK_OF_ART", |
| 993 "CONSUMER_GOOD", |
| 994 "OTHER" |
| 995 ], |
| 996 "enumDescriptions": [ |
| 997 "Unknown", |
| 998 "Person", |
| 999 "Location", |
| 1000 "Organization", |
| 1001 "Event", |
| 1002 "Work of art", |
| 1003 "Consumer goods", |
| 1004 "Other types" |
| 1005 ], |
| 1006 "type": "string" |
| 1007 }, |
| 1008 "metadata": { |
| 1009 "additionalProperties": { |
| 1010 "type": "string" |
| 1011 }, |
| 1012 "description": "Metadata associated with the entity.\n\nCurr
ently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The
associated keys are \"wikipedia_url\" and \"mid\", respectively.", |
| 1013 "type": "object" |
| 1014 }, |
| 1015 "salience": { |
| 1016 "description": "The salience score associated with the entit
y in the [0, 1.0] range.\n\nThe salience score for an entity provides informatio
n about the\nimportance or centrality of that entity to the entire document text
.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\ns
alient.", |
| 1017 "format": "float", |
| 1018 "type": "number" |
| 1019 }, |
| 1020 "sentiment": { |
| 1021 "$ref": "Sentiment", |
| 1022 "description": "For calls to AnalyzeEntitySentiment or if\nA
nnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field
will contain the aggregate sentiment expressed for this\nentity in the provided
document." |
| 1023 } |
| 1024 }, |
| 1025 "type": "object" |
| 1026 }, |
| 1027 "AnnotateTextRequest": { |
| 1028 "description": "The request message for the text annotation API, whi
ch can perform multiple\nanalysis types (sentiment, entities, and syntax) in one
call.", |
| 1029 "id": "AnnotateTextRequest", |
| 1030 "properties": { |
| 1031 "encodingType": { |
| 1032 "description": "The encoding type used by the API to calcula
te offsets.", |
| 1033 "enum": [ |
| 1034 "NONE", |
| 1035 "UTF8", |
| 1036 "UTF16", |
| 1037 "UTF32" |
| 1038 ], |
| 1039 "enumDescriptions": [ |
| 1040 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
| 1041 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", |
| 1042 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", |
| 1043 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." |
| 1044 ], |
| 1045 "type": "string" |
| 1046 }, |
| 1047 "document": { |
| 1048 "$ref": "Document", |
| 1049 "description": "Input document." |
| 1050 }, |
| 1051 "features": { |
| 1052 "$ref": "Features", |
| 1053 "description": "The enabled features." |
| 1054 } |
| 1055 }, |
| 1056 "type": "object" |
| 1057 }, |
| 1058 "AnalyzeSentimentRequest": { |
| 1059 "description": "The sentiment analysis request message.", |
| 1060 "id": "AnalyzeSentimentRequest", |
| 1061 "properties": { |
| 1062 "encodingType": { |
| 1063 "description": "The encoding type used by the API to calcula
te sentence offsets for the\nsentence sentiment.", |
| 1064 "enum": [ |
| 1065 "NONE", |
| 1066 "UTF8", |
| 1067 "UTF16", |
| 1068 "UTF32" |
| 1069 ], |
| 1070 "enumDescriptions": [ |
| 1071 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
| 1072 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", |
| 1073 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", |
| 1074 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." |
| 1075 ], |
| 1076 "type": "string" |
| 1077 }, |
| 1078 "document": { |
| 1079 "$ref": "Document", |
| 1080 "description": "Input document." |
| 1081 } |
| 1082 }, |
| 1083 "type": "object" |
| 1084 }, |
| 1085 "Status": { |
| 1086 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
| 1087 "id": "Status", |
| 1088 "properties": { |
| 1089 "code": { |
| 1090 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1091 "format": "int32", |
| 1092 "type": "integer" |
| 1093 }, |
| 1094 "message": { |
| 1095 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 1096 "type": "string" |
| 1097 }, |
| 1098 "details": { |
| 1099 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 1100 "items": { |
| 1101 "additionalProperties": { |
| 1102 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1103 "type": "any" |
| 1104 }, |
| 1105 "type": "object" |
| 1106 }, |
| 1107 "type": "array" |
| 1108 } |
| 1109 }, |
| 1110 "type": "object" |
| 1111 }, |
| 1112 "Features": { |
| 1113 "description": "All available features for sentiment, syntax, and se
mantic analysis.\nSetting each one to true will enable that specific analysis fo
r the input.", |
| 1114 "id": "Features", |
| 1115 "properties": { |
| 1116 "extractEntities": { |
| 1117 "description": "Extract entities.", |
| 1118 "type": "boolean" |
| 1119 }, |
| 1120 "classifyText": { |
| 1121 "description": "Classify the full document into categories."
, |
| 1122 "type": "boolean" |
| 1123 }, |
| 1124 "extractEntitySentiment": { |
| 1125 "description": "Extract entities and their associated sentim
ent.", |
| 1126 "type": "boolean" |
| 1127 }, |
| 1128 "extractDocumentSentiment": { |
| 1129 "description": "Extract document-level sentiment.", |
| 1130 "type": "boolean" |
| 1131 }, |
| 1132 "extractSyntax": { |
| 1133 "description": "Extract syntax information.", |
| 1134 "type": "boolean" |
| 1135 } |
| 1136 }, |
| 1137 "type": "object" |
| 1138 }, |
| 1139 "Document": { |
| 1140 "description": "####################################################
############ #\n\nRepresents the input to API methods.", |
| 1141 "id": "Document", |
| 1142 "properties": { |
| 1143 "content": { |
| 1144 "description": "The content of the input in string format.", |
| 1145 "type": "string" |
| 1146 }, |
| 1147 "type": { |
| 1148 "description": "Required. If the type is not set or is `TYPE
_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", |
| 1149 "enum": [ |
| 1150 "TYPE_UNSPECIFIED", |
| 1151 "PLAIN_TEXT", |
| 1152 "HTML" |
| 1153 ], |
| 1154 "enumDescriptions": [ |
| 1155 "The content type is not specified.", |
| 1156 "Plain text", |
| 1157 "HTML" |
| 1158 ], |
| 1159 "type": "string" |
| 1160 }, |
| 1161 "gcsContentUri": { |
| 1162 "description": "The Google Cloud Storage URI where the file
content is located.\nThis URI must be of the form: gs://bucket_name/object_name.
For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nN
OTE: Cloud Storage object versioning is not supported.", |
| 1163 "type": "string" |
| 1164 }, |
| 1165 "language": { |
| 1166 "description": "The language of the document (if not specifi
ed, the language is\nautomatically detected). Both ISO and BCP-47 language codes
are\naccepted.<br>\n[Language Support](/natural-language/docs/languages)\nlists
currently supported languages for each API method.\nIf the language (either spe
cified by the caller or automatically detected)\nis not supported by the called
API method, an `INVALID_ARGUMENT` error\nis returned.", |
| 1167 "type": "string" |
| 1168 } |
| 1169 }, |
| 1170 "type": "object" |
| 1171 }, |
| 1172 "AnalyzeEntitiesRequest": { |
| 1173 "description": "The entity analysis request message.", |
| 1174 "id": "AnalyzeEntitiesRequest", |
| 1175 "properties": { |
| 1176 "encodingType": { |
| 1177 "description": "The encoding type used by the API to calcula
te offsets.", |
1137 "enum": [ | 1178 "enum": [ |
1138 "NONE", | 1179 "NONE", |
1139 "UTF8", | 1180 "UTF8", |
1140 "UTF16", | 1181 "UTF16", |
1141 "UTF32" | 1182 "UTF32" |
1142 ], | 1183 ], |
1143 "enumDescriptions": [ | 1184 "enumDescriptions": [ |
1144 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | 1185 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
1145 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", | 1186 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-8 encoding of the input. C++ and Go are example
s of languages\nthat use this encoding natively.", |
1146 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", | 1187 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-16 encoding of the input. Java and Javascript a
re examples of\nlanguages that use this encoding natively.", |
1147 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." | 1188 "Encoding-dependent information (such as `begin_offset`)
is calculated based\non the UTF-32 encoding of the input. Python is an example
of a language\nthat uses this encoding natively." |
1148 ], | 1189 ], |
1149 "type": "string" | 1190 "type": "string" |
1150 }, | 1191 }, |
1151 "document": { | 1192 "document": { |
1152 "$ref": "Document", | 1193 "$ref": "Document", |
1153 "description": "Input document." | 1194 "description": "Input document." |
1154 } | 1195 } |
1155 }, | 1196 }, |
1156 "type": "object" | 1197 "type": "object" |
| 1198 }, |
| 1199 "ClassifyTextRequest": { |
| 1200 "description": "The document classification request message.", |
| 1201 "id": "ClassifyTextRequest", |
| 1202 "properties": { |
| 1203 "document": { |
| 1204 "$ref": "Document", |
| 1205 "description": "Input document." |
| 1206 } |
| 1207 }, |
| 1208 "type": "object" |
| 1209 }, |
| 1210 "AnalyzeEntitySentimentResponse": { |
| 1211 "description": "The entity-level sentiment analysis response message
.", |
| 1212 "id": "AnalyzeEntitySentimentResponse", |
| 1213 "properties": { |
| 1214 "language": { |
| 1215 "description": "The language of the text, which will be the
same as the language specified\nin the request or, if not specified, the automat
ically-detected language.\nSee Document.language field for more details.", |
| 1216 "type": "string" |
| 1217 }, |
| 1218 "entities": { |
| 1219 "description": "The recognized entities in the input documen
t with associated sentiments.", |
| 1220 "items": { |
| 1221 "$ref": "Entity" |
| 1222 }, |
| 1223 "type": "array" |
| 1224 } |
| 1225 }, |
| 1226 "type": "object" |
1157 } | 1227 } |
1158 }, | 1228 }, |
1159 "servicePath": "", | 1229 "servicePath": "", |
1160 "title": "Google Cloud Natural Language API", | 1230 "title": "Google Cloud Natural Language API", |
1161 "version": "v1beta2" | 1231 "version": "v1beta2" |
1162 } | 1232 } |
OLD | NEW |