Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(471)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis_beta/language__v1beta1.json

Issue 2824163002: Api-roll 48: 2017-04-18 (Closed)
Patch Set: Revert changes to pubspecs Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis_beta/dns__v2beta1.json ('k') | discovery/googleapis_beta/logging__v2beta1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://language.googleapis.com/", 12 "baseUrl": "https://language.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "Cloud Natural Language", 14 "canonicalName": "Cloud Natural Language",
15 "description": "Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, e ntity recognition, and text annotations.", 15 "description": "Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, e ntity recognition, and text annotations.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/natural-language/", 17 "documentationLink": "https://cloud.google.com/natural-language/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "language:v1beta1", 22 "id": "language:v1beta1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "language", 24 "name": "language",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "upload_protocol": {
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
30 "location": "query",
31 "type": "string"
32 },
33 "prettyPrint": {
34 "default": "true",
35 "description": "Returns response with indentations and line breaks." ,
36 "location": "query",
37 "type": "boolean"
38 },
28 "uploadType": { 39 "uploadType": {
29 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 40 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
30 "location": "query", 41 "location": "query",
31 "type": "string" 42 "type": "string"
32 }, 43 },
33 "fields": { 44 "fields": {
34 "description": "Selector specifying which fields to include in a par tial response.", 45 "description": "Selector specifying which fields to include in a par tial response.",
35 "location": "query", 46 "location": "query",
36 "type": "string" 47 "type": "string"
37 }, 48 },
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
92 }, 103 },
93 "bearer_token": { 104 "bearer_token": {
94 "description": "OAuth bearer token.", 105 "description": "OAuth bearer token.",
95 "location": "query", 106 "location": "query",
96 "type": "string" 107 "type": "string"
97 }, 108 },
98 "oauth_token": { 109 "oauth_token": {
99 "description": "OAuth 2.0 token for the current user.", 110 "description": "OAuth 2.0 token for the current user.",
100 "location": "query", 111 "location": "query",
101 "type": "string" 112 "type": "string"
102 },
103 "upload_protocol": {
104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
105 "location": "query",
106 "type": "string"
107 },
108 "prettyPrint": {
109 "default": "true",
110 "description": "Returns response with indentations and line breaks." ,
111 "location": "query",
112 "type": "boolean"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "documents": { 117 "documents": {
118 "methods": { 118 "methods": {
119 "annotateText": {
120 "description": "A convenience method that provides all the f eatures that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in on e call.",
121 "httpMethod": "POST",
122 "id": "language.documents.annotateText",
123 "parameterOrder": [],
124 "parameters": {},
125 "path": "v1beta1/documents:annotateText",
126 "request": {
127 "$ref": "AnnotateTextRequest"
128 },
129 "response": {
130 "$ref": "AnnotateTextResponse"
131 },
132 "scopes": [
133 "https://www.googleapis.com/auth/cloud-platform"
134 ]
135 },
119 "analyzeEntities": { 136 "analyzeEntities": {
120 "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", 137 "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
121 "httpMethod": "POST", 138 "httpMethod": "POST",
122 "id": "language.documents.analyzeEntities", 139 "id": "language.documents.analyzeEntities",
123 "parameterOrder": [], 140 "parameterOrder": [],
124 "parameters": {}, 141 "parameters": {},
125 "path": "v1beta1/documents:analyzeEntities", 142 "path": "v1beta1/documents:analyzeEntities",
126 "request": { 143 "request": {
127 "$ref": "AnalyzeEntitiesRequest" 144 "$ref": "AnalyzeEntitiesRequest"
128 }, 145 },
(...skipping 30 matching lines...) Expand all
159 "path": "v1beta1/documents:analyzeSentiment", 176 "path": "v1beta1/documents:analyzeSentiment",
160 "request": { 177 "request": {
161 "$ref": "AnalyzeSentimentRequest" 178 "$ref": "AnalyzeSentimentRequest"
162 }, 179 },
163 "response": { 180 "response": {
164 "$ref": "AnalyzeSentimentResponse" 181 "$ref": "AnalyzeSentimentResponse"
165 }, 182 },
166 "scopes": [ 183 "scopes": [
167 "https://www.googleapis.com/auth/cloud-platform" 184 "https://www.googleapis.com/auth/cloud-platform"
168 ] 185 ]
169 },
170 "annotateText": {
171 "description": "A convenience method that provides all the f eatures that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in on e call.",
172 "httpMethod": "POST",
173 "id": "language.documents.annotateText",
174 "parameterOrder": [],
175 "parameters": {},
176 "path": "v1beta1/documents:annotateText",
177 "request": {
178 "$ref": "AnnotateTextRequest"
179 },
180 "response": {
181 "$ref": "AnnotateTextResponse"
182 },
183 "scopes": [
184 "https://www.googleapis.com/auth/cloud-platform"
185 ]
186 } 186 }
187 } 187 }
188 } 188 }
189 }, 189 },
190 "revision": "20170320", 190 "revision": "20170412",
191 "rootUrl": "https://language.googleapis.com/", 191 "rootUrl": "https://language.googleapis.com/",
192 "schemas": { 192 "schemas": {
193 "AnnotateTextRequest": {
194 "description": "The request message for the text annotation API, whi ch can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
195 "id": "AnnotateTextRequest",
196 "properties": {
197 "encodingType": {
198 "description": "The encoding type used by the API to calcula te offsets.",
199 "enum": [
200 "NONE",
201 "UTF8",
202 "UTF16",
203 "UTF32"
204 ],
205 "enumDescriptions": [
206 "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
207 "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.",
208 "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.",
209 "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."
210 ],
211 "type": "string"
212 },
213 "document": {
214 "$ref": "Document",
215 "description": "Input document."
216 },
217 "features": {
218 "$ref": "Features",
219 "description": "The enabled features."
220 }
221 },
222 "type": "object"
223 },
224 "AnnotateTextResponse": {
225 "description": "The text annotations response message.",
226 "id": "AnnotateTextResponse",
227 "properties": {
228 "language": {
229 "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.",
230 "type": "string"
231 },
232 "sentences": {
233 "description": "Sentences in the input document. Populated i f the user enables\nAnnotateTextRequest.Features.extract_syntax.",
234 "items": {
235 "$ref": "Sentence"
236 },
237 "type": "array"
238 },
239 "tokens": {
240 "description": "Tokens, along with their syntactic informati on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F eatures.extract_syntax.",
241 "items": {
242 "$ref": "Token"
243 },
244 "type": "array"
245 },
246 "entities": {
247 "description": "Entities, along with their semantic informat ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest. Features.extract_entities.",
248 "items": {
249 "$ref": "Entity"
250 },
251 "type": "array"
252 },
253 "documentSentiment": {
254 "$ref": "Sentiment",
255 "description": "The overall sentiment for the document. Popu lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime nt."
256 }
257 },
258 "type": "object"
259 },
260 "AnalyzeSentimentRequest": {
261 "description": "The sentiment analysis request message.",
262 "id": "AnalyzeSentimentRequest",
263 "properties": {
264 "encodingType": {
265 "description": "The encoding type used by the API to calcula te sentence offsets for the\nsentence sentiment.",
266 "enum": [
267 "NONE",
268 "UTF8",
269 "UTF16",
270 "UTF32"
271 ],
272 "enumDescriptions": [
273 "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
274 "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.",
275 "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.",
276 "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."
277 ],
278 "type": "string"
279 },
280 "document": {
281 "$ref": "Document",
282 "description": "Input document. Currently, `analyzeSentiment ` only supports English text\n(Document.language=\"EN\")."
283 }
284 },
285 "type": "object"
286 },
287 "DependencyEdge": {
288 "description": "Represents dependency parse tree information for a t oken.",
289 "id": "DependencyEdge",
290 "properties": {
291 "label": {
292 "description": "The parse label for the token.",
293 "enum": [
294 "UNKNOWN",
295 "ABBREV",
296 "ACOMP",
297 "ADVCL",
298 "ADVMOD",
299 "AMOD",
300 "APPOS",
301 "ATTR",
302 "AUX",
303 "AUXPASS",
304 "CC",
305 "CCOMP",
306 "CONJ",
307 "CSUBJ",
308 "CSUBJPASS",
309 "DEP",
310 "DET",
311 "DISCOURSE",
312 "DOBJ",
313 "EXPL",
314 "GOESWITH",
315 "IOBJ",
316 "MARK",
317 "MWE",
318 "MWV",
319 "NEG",
320 "NN",
321 "NPADVMOD",
322 "NSUBJ",
323 "NSUBJPASS",
324 "NUM",
325 "NUMBER",
326 "P",
327 "PARATAXIS",
328 "PARTMOD",
329 "PCOMP",
330 "POBJ",
331 "POSS",
332 "POSTNEG",
333 "PRECOMP",
334 "PRECONJ",
335 "PREDET",
336 "PREF",
337 "PREP",
338 "PRONL",
339 "PRT",
340 "PS",
341 "QUANTMOD",
342 "RCMOD",
343 "RCMODREL",
344 "RDROP",
345 "REF",
346 "REMNANT",
347 "REPARANDUM",
348 "ROOT",
349 "SNUM",
350 "SUFF",
351 "TMOD",
352 "TOPIC",
353 "VMOD",
354 "VOCATIVE",
355 "XCOMP",
356 "SUFFIX",
357 "TITLE",
358 "ADVPHMOD",
359 "AUXCAUS",
360 "AUXVV",
361 "DTMOD",
362 "FOREIGN",
363 "KW",
364 "LIST",
365 "NOMC",
366 "NOMCSUBJ",
367 "NOMCSUBJPASS",
368 "NUMC",
369 "COP",
370 "DISLOCATED"
371 ],
372 "enumDescriptions": [
373 "Unknown",
374 "Abbreviation modifier",
375 "Adjectival complement",
376 "Adverbial clause modifier",
377 "Adverbial modifier",
378 "Adjectival modifier of an NP",
379 "Appositional modifier of an NP",
380 "Attribute dependent of a copular verb",
381 "Auxiliary (non-main) verb",
382 "Passive auxiliary",
383 "Coordinating conjunction",
384 "Clausal complement of a verb or adjective",
385 "Conjunct",
386 "Clausal subject",
387 "Clausal passive subject",
388 "Dependency (unable to determine)",
389 "Determiner",
390 "Discourse",
391 "Direct object",
392 "Expletive",
393 "Goes with (part of a word in a text not well edited)",
394 "Indirect object",
395 "Marker (word introducing a subordinate clause)",
396 "Multi-word expression",
397 "Multi-word verbal expression",
398 "Negation modifier",
399 "Noun compound modifier",
400 "Noun phrase used as an adverbial modifier",
401 "Nominal subject",
402 "Passive nominal subject",
403 "Numeric modifier of a noun",
404 "Element of compound number",
405 "Punctuation mark",
406 "Parataxis relation",
407 "Participial modifier",
408 "The complement of a preposition is a clause",
409 "Object of a preposition",
410 "Possession modifier",
411 "Postverbal negative particle",
412 "Predicate complement",
413 "Preconjunt",
414 "Predeterminer",
415 "Prefix",
416 "Prepositional modifier",
417 "The relationship between a verb and verbal morpheme",
418 "Particle",
419 "Associative or possessive marker",
420 "Quantifier phrase modifier",
421 "Relative clause modifier",
422 "Complementizer in relative clause",
423 "Ellipsis without a preceding predicate",
424 "Referent",
425 "Remnant",
426 "Reparandum",
427 "Root",
428 "Suffix specifying a unit of number",
429 "Suffix",
430 "Temporal modifier",
431 "Topic marker",
432 "Clause headed by an infinite form of the verb that modi fies a noun",
433 "Vocative",
434 "Open clausal complement",
435 "Name suffix",
436 "Name title",
437 "Adverbial phrase modifier",
438 "Causative auxiliary",
439 "Helper auxiliary",
440 "Rentaishi (Prenominal modifier)",
441 "Foreign words",
442 "Keyword",
443 "List for chains of comparable items",
444 "Nominalized clause",
445 "Nominalized clausal subject",
446 "Nominalized clausal passive",
447 "Compound of numeric modifier",
448 "Copula",
449 "Dislocated relation (for fronted/topicalized elements)"
450 ],
451 "type": "string"
452 },
453 "headTokenIndex": {
454 "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.",
455 "format": "int32",
456 "type": "integer"
457 }
458 },
459 "type": "object"
460 },
461 "TextSpan": {
462 "description": "Represents an output piece of text.",
463 "id": "TextSpan",
464 "properties": {
465 "content": {
466 "description": "The content of the output text.",
467 "type": "string"
468 },
469 "beginOffset": {
470 "description": "The API calculates the beginning offset of t he content in the original\ndocument according to the EncodingType specified in the API request.",
471 "format": "int32",
472 "type": "integer"
473 }
474 },
475 "type": "object"
476 },
477 "Token": {
478 "description": "Represents the smallest syntactic building block of the text.",
479 "id": "Token",
480 "properties": {
481 "text": {
482 "$ref": "TextSpan",
483 "description": "The token text."
484 },
485 "dependencyEdge": {
486 "$ref": "DependencyEdge",
487 "description": "Dependency tree parse for this token."
488 },
489 "lemma": {
490 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_ %28morphology%29) of the token.",
491 "type": "string"
492 },
493 "partOfSpeech": {
494 "$ref": "PartOfSpeech",
495 "description": "Parts of speech tag for this token."
496 }
497 },
498 "type": "object"
499 },
500 "Status": {
501 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
502 "id": "Status",
503 "properties": {
504 "details": {
505 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
506 "items": {
507 "additionalProperties": {
508 "description": "Properties of the object. Contains f ield @type with type URL.",
509 "type": "any"
510 },
511 "type": "object"
512 },
513 "type": "array"
514 },
515 "code": {
516 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
517 "format": "int32",
518 "type": "integer"
519 },
520 "message": {
521 "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.",
522 "type": "string"
523 }
524 },
525 "type": "object"
526 },
527 "Features": {
528 "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.",
529 "id": "Features",
530 "properties": {
531 "extractEntities": {
532 "description": "Extract entities.",
533 "type": "boolean"
534 },
535 "extractSyntax": {
536 "description": "Extract syntax information.",
537 "type": "boolean"
538 },
539 "extractDocumentSentiment": {
540 "description": "Extract document-level sentiment.",
541 "type": "boolean"
542 }
543 },
544 "type": "object"
545 },
546 "EntityMention": {
547 "description": "Represents a mention for an entity in the text. Curr ently, proper noun\nmentions are supported.",
548 "id": "EntityMention",
549 "properties": {
550 "text": {
551 "$ref": "TextSpan",
552 "description": "The mention text."
553 },
554 "type": {
555 "description": "The type of the entity mention.",
556 "enum": [
557 "TYPE_UNKNOWN",
558 "PROPER",
559 "COMMON"
560 ],
561 "enumDescriptions": [
562 "Unknown",
563 "Proper name",
564 "Common noun (or noun compound)"
565 ],
566 "type": "string"
567 }
568 },
569 "type": "object"
570 },
571 "Document": {
572 "description": "#################################################### ############ #\n\nRepresents the input to API methods.",
573 "id": "Document",
574 "properties": {
575 "language": {
576 "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**Current Language Restrictions:**\n\n * Only English, Span ish, and Japanese textual content are supported.\nIf the language (either specif ied by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
577 "type": "string"
578 },
579 "type": {
580 "description": "Required. If the type is not set or is `TYPE _UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
581 "enum": [
582 "TYPE_UNSPECIFIED",
583 "PLAIN_TEXT",
584 "HTML"
585 ],
586 "enumDescriptions": [
587 "The content type is not specified.",
588 "Plain text",
589 "HTML"
590 ],
591 "type": "string"
592 },
593 "content": {
594 "description": "The content of the input in string format.",
595 "type": "string"
596 },
597 "gcsContentUri": {
598 "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.",
599 "type": "string"
600 }
601 },
602 "type": "object"
603 },
604 "Sentence": {
605 "description": "Represents a sentence in the input document.",
606 "id": "Sentence",
607 "properties": {
608 "text": {
609 "$ref": "TextSpan",
610 "description": "The sentence text."
611 },
612 "sentiment": {
613 "$ref": "Sentiment",
614 "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."
615 }
616 },
617 "type": "object"
618 },
619 "Sentiment": {
620 "description": "Represents the feeling associated with the entire te xt or entities in\nthe text.",
621 "id": "Sentiment",
622 "properties": {
623 "polarity": {
624 "description": "DEPRECATED FIELD - This field is being depre cated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.go ogle.com/natural-language/docs for more information.",
625 "format": "float",
626 "type": "number"
627 },
628 "score": {
629 "description": "Sentiment score between -1.0 (negative senti ment) and 1.0\n(positive sentiment).",
630 "format": "float",
631 "type": "number"
632 },
633 "magnitude": {
634 "description": "A non-negative number in the [0, +inf) range , which represents\nthe absolute magnitude of sentiment regardless of score (pos itive or\nnegative).",
635 "format": "float",
636 "type": "number"
637 }
638 },
639 "type": "object"
640 },
641 "AnalyzeEntitiesRequest": {
642 "description": "The entity analysis request message.",
643 "id": "AnalyzeEntitiesRequest",
644 "properties": {
645 "encodingType": {
646 "description": "The encoding type used by the API to calcula te offsets.",
647 "enum": [
648 "NONE",
649 "UTF8",
650 "UTF16",
651 "UTF32"
652 ],
653 "enumDescriptions": [
654 "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
655 "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.",
656 "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.",
657 "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."
658 ],
659 "type": "string"
660 },
661 "document": {
662 "$ref": "Document",
663 "description": "Input document."
664 }
665 },
666 "type": "object"
667 },
193 "PartOfSpeech": { 668 "PartOfSpeech": {
194 "description": "Represents part of speech information for a token.", 669 "description": "Represents part of speech information for a token.",
195 "id": "PartOfSpeech", 670 "id": "PartOfSpeech",
196 "properties": { 671 "properties": {
197 "voice": {
198 "description": "The grammatical voice.",
199 "enum": [
200 "VOICE_UNKNOWN",
201 "ACTIVE",
202 "CAUSATIVE",
203 "PASSIVE"
204 ],
205 "enumDescriptions": [
206 "Voice is not applicable in the analyzed language or is not predicted.",
207 "Active",
208 "Causative",
209 "Passive"
210 ],
211 "type": "string"
212 },
213 "aspect": {
214 "description": "The grammatical aspect.",
215 "enum": [
216 "ASPECT_UNKNOWN",
217 "PERFECTIVE",
218 "IMPERFECTIVE",
219 "PROGRESSIVE"
220 ],
221 "enumDescriptions": [
222 "Aspect is not applicable in the analyzed language or is not predicted.",
223 "Perfective",
224 "Imperfective",
225 "Progressive"
226 ],
227 "type": "string"
228 },
229 "mood": {
230 "description": "The grammatical mood.",
231 "enum": [
232 "MOOD_UNKNOWN",
233 "CONDITIONAL_MOOD",
234 "IMPERATIVE",
235 "INDICATIVE",
236 "INTERROGATIVE",
237 "JUSSIVE",
238 "SUBJUNCTIVE"
239 ],
240 "enumDescriptions": [
241 "Mood is not applicable in the analyzed language or is n ot predicted.",
242 "Conditional",
243 "Imperative",
244 "Indicative",
245 "Interrogative",
246 "Jussive",
247 "Subjunctive"
248 ],
249 "type": "string"
250 },
251 "tag": {
252 "description": "The part of speech tag.",
253 "enum": [
254 "UNKNOWN",
255 "ADJ",
256 "ADP",
257 "ADV",
258 "CONJ",
259 "DET",
260 "NOUN",
261 "NUM",
262 "PRON",
263 "PRT",
264 "PUNCT",
265 "VERB",
266 "X",
267 "AFFIX"
268 ],
269 "enumDescriptions": [
270 "Unknown",
271 "Adjective",
272 "Adposition (preposition and postposition)",
273 "Adverb",
274 "Conjunction",
275 "Determiner",
276 "Noun (common and proper)",
277 "Cardinal number",
278 "Pronoun",
279 "Particle or other function word",
280 "Punctuation",
281 "Verb (all tenses and modes)",
282 "Other: foreign words, typos, abbreviations",
283 "Affix"
284 ],
285 "type": "string"
286 },
287 "gender": {
288 "description": "The grammatical gender.",
289 "enum": [
290 "GENDER_UNKNOWN",
291 "FEMININE",
292 "MASCULINE",
293 "NEUTER"
294 ],
295 "enumDescriptions": [
296 "Gender is not applicable in the analyzed language or is not predicted.",
297 "Feminine",
298 "Masculine",
299 "Neuter"
300 ],
301 "type": "string"
302 },
303 "person": {
304 "description": "The grammatical person.",
305 "enum": [
306 "PERSON_UNKNOWN",
307 "FIRST",
308 "SECOND",
309 "THIRD",
310 "REFLEXIVE_PERSON"
311 ],
312 "enumDescriptions": [
313 "Person is not applicable in the analyzed language or is not predicted.",
314 "First",
315 "Second",
316 "Third",
317 "Reflexive"
318 ],
319 "type": "string"
320 },
321 "proper": { 672 "proper": {
322 "description": "The grammatical properness.", 673 "description": "The grammatical properness.",
323 "enum": [ 674 "enum": [
324 "PROPER_UNKNOWN", 675 "PROPER_UNKNOWN",
325 "PROPER", 676 "PROPER",
326 "NOT_PROPER" 677 "NOT_PROPER"
327 ], 678 ],
328 "enumDescriptions": [ 679 "enumDescriptions": [
329 "Proper is not applicable in the analyzed language or is not predicted.", 680 "Proper is not applicable in the analyzed language or is not predicted.",
330 "Proper", 681 "Proper",
(...skipping 115 matching lines...) Expand 10 before | Expand all | Expand 10 after
446 "PLURAL", 797 "PLURAL",
447 "DUAL" 798 "DUAL"
448 ], 799 ],
449 "enumDescriptions": [ 800 "enumDescriptions": [
450 "Number is not applicable in the analyzed language or is not predicted.", 801 "Number is not applicable in the analyzed language or is not predicted.",
451 "Singular", 802 "Singular",
452 "Plural", 803 "Plural",
453 "Dual" 804 "Dual"
454 ], 805 ],
455 "type": "string" 806 "type": "string"
807 },
808 "voice": {
809 "description": "The grammatical voice.",
810 "enum": [
811 "VOICE_UNKNOWN",
812 "ACTIVE",
813 "CAUSATIVE",
814 "PASSIVE"
815 ],
816 "enumDescriptions": [
817 "Voice is not applicable in the analyzed language or is not predicted.",
818 "Active",
819 "Causative",
820 "Passive"
821 ],
822 "type": "string"
823 },
824 "aspect": {
825 "description": "The grammatical aspect.",
826 "enum": [
827 "ASPECT_UNKNOWN",
828 "PERFECTIVE",
829 "IMPERFECTIVE",
830 "PROGRESSIVE"
831 ],
832 "enumDescriptions": [
833 "Aspect is not applicable in the analyzed language or is not predicted.",
834 "Perfective",
835 "Imperfective",
836 "Progressive"
837 ],
838 "type": "string"
839 },
840 "mood": {
841 "description": "The grammatical mood.",
842 "enum": [
843 "MOOD_UNKNOWN",
844 "CONDITIONAL_MOOD",
845 "IMPERATIVE",
846 "INDICATIVE",
847 "INTERROGATIVE",
848 "JUSSIVE",
849 "SUBJUNCTIVE"
850 ],
851 "enumDescriptions": [
852 "Mood is not applicable in the analyzed language or is n ot predicted.",
853 "Conditional",
854 "Imperative",
855 "Indicative",
856 "Interrogative",
857 "Jussive",
858 "Subjunctive"
859 ],
860 "type": "string"
861 },
862 "tag": {
863 "description": "The part of speech tag.",
864 "enum": [
865 "UNKNOWN",
866 "ADJ",
867 "ADP",
868 "ADV",
869 "CONJ",
870 "DET",
871 "NOUN",
872 "NUM",
873 "PRON",
874 "PRT",
875 "PUNCT",
876 "VERB",
877 "X",
878 "AFFIX"
879 ],
880 "enumDescriptions": [
881 "Unknown",
882 "Adjective",
883 "Adposition (preposition and postposition)",
884 "Adverb",
885 "Conjunction",
886 "Determiner",
887 "Noun (common and proper)",
888 "Cardinal number",
889 "Pronoun",
890 "Particle or other function word",
891 "Punctuation",
892 "Verb (all tenses and modes)",
893 "Other: foreign words, typos, abbreviations",
894 "Affix"
895 ],
896 "type": "string"
897 },
898 "gender": {
899 "description": "The grammatical gender.",
900 "enum": [
901 "GENDER_UNKNOWN",
902 "FEMININE",
903 "MASCULINE",
904 "NEUTER"
905 ],
906 "enumDescriptions": [
907 "Gender is not applicable in the analyzed language or is not predicted.",
908 "Feminine",
909 "Masculine",
910 "Neuter"
911 ],
912 "type": "string"
913 },
914 "person": {
915 "description": "The grammatical person.",
916 "enum": [
917 "PERSON_UNKNOWN",
918 "FIRST",
919 "SECOND",
920 "THIRD",
921 "REFLEXIVE_PERSON"
922 ],
923 "enumDescriptions": [
924 "Person is not applicable in the analyzed language or is not predicted.",
925 "First",
926 "Second",
927 "Third",
928 "Reflexive"
929 ],
930 "type": "string"
456 } 931 }
457 }, 932 },
458 "type": "object" 933 "type": "object"
459 }, 934 },
460 "AnalyzeSyntaxRequest": { 935 "AnalyzeSyntaxRequest": {
461 "description": "The syntax analysis request message.", 936 "description": "The syntax analysis request message.",
462 "id": "AnalyzeSyntaxRequest", 937 "id": "AnalyzeSyntaxRequest",
463 "properties": { 938 "properties": {
464 "encodingType": { 939 "encodingType": {
465 "description": "The encoding type used by the API to calcula te offsets.", 940 "description": "The encoding type used by the API to calcula te offsets.",
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
503 }, 978 },
504 "type": "array" 979 "type": "array"
505 } 980 }
506 }, 981 },
507 "type": "object" 982 "type": "object"
508 }, 983 },
509 "AnalyzeEntitiesResponse": { 984 "AnalyzeEntitiesResponse": {
510 "description": "The entity analysis response message.", 985 "description": "The entity analysis response message.",
511 "id": "AnalyzeEntitiesResponse", 986 "id": "AnalyzeEntitiesResponse",
512 "properties": { 987 "properties": {
988 "entities": {
989 "description": "The recognized entities in the input documen t.",
990 "items": {
991 "$ref": "Entity"
992 },
993 "type": "array"
994 },
513 "language": { 995 "language": {
514 "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.", 996 "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.",
515 "type": "string" 997 "type": "string"
516 },
517 "entities": {
518 "description": "The recognized entities in the input documen t.",
519 "items": {
520 "$ref": "Entity"
521 },
522 "type": "array"
523 }
524 },
525 "type": "object"
526 },
527 "AnalyzeSyntaxResponse": {
528 "description": "The syntax analysis response message.",
529 "id": "AnalyzeSyntaxResponse",
530 "properties": {
531 "language": {
532 "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.",
533 "type": "string"
534 },
535 "sentences": {
536 "description": "Sentences in the input document.",
537 "items": {
538 "$ref": "Sentence"
539 },
540 "type": "array"
541 },
542 "tokens": {
543 "description": "Tokens, along with their syntactic informati on, in the input document.",
544 "items": {
545 "$ref": "Token"
546 },
547 "type": "array"
548 } 998 }
549 }, 999 },
550 "type": "object" 1000 "type": "object"
551 }, 1001 },
552 "Entity": { 1002 "Entity": {
553 "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.", 1003 "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.",
554 "id": "Entity", 1004 "id": "Entity",
555 "properties": { 1005 "properties": {
556 "mentions": { 1006 "mentions": {
557 "description": "The mentions of this entity in the input doc ument. The API currently\nsupports proper noun mentions.", 1007 "description": "The mentions of this entity in the input doc ument. The API currently\nsupports proper noun mentions.",
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
596 "type": "object" 1046 "type": "object"
597 }, 1047 },
598 "salience": { 1048 "salience": {
599 "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.", 1049 "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.",
600 "format": "float", 1050 "format": "float",
601 "type": "number" 1051 "type": "number"
602 } 1052 }
603 }, 1053 },
604 "type": "object" 1054 "type": "object"
605 }, 1055 },
606 "AnnotateTextRequest": { 1056 "AnalyzeSyntaxResponse": {
607 "description": "The request message for the text annotation API, whi ch can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.", 1057 "description": "The syntax analysis response message.",
608 "id": "AnnotateTextRequest", 1058 "id": "AnalyzeSyntaxResponse",
609 "properties": {
610 "encodingType": {
611 "description": "The encoding type used by the API to calcula te offsets.",
612 "enum": [
613 "NONE",
614 "UTF8",
615 "UTF16",
616 "UTF32"
617 ],
618 "enumDescriptions": [
619 "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
620 "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.",
621 "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.",
622 "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."
623 ],
624 "type": "string"
625 },
626 "document": {
627 "$ref": "Document",
628 "description": "Input document."
629 },
630 "features": {
631 "$ref": "Features",
632 "description": "The enabled features."
633 }
634 },
635 "type": "object"
636 },
637 "AnnotateTextResponse": {
638 "description": "The text annotations response message.",
639 "id": "AnnotateTextResponse",
640 "properties": { 1059 "properties": {
641 "language": { 1060 "language": {
642 "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.", 1061 "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.",
643 "type": "string" 1062 "type": "string"
644 }, 1063 },
645 "sentences": { 1064 "sentences": {
646 "description": "Sentences in the input document. Populated i f the user enables\nAnnotateTextRequest.Features.extract_syntax.", 1065 "description": "Sentences in the input document.",
647 "items": { 1066 "items": {
648 "$ref": "Sentence" 1067 "$ref": "Sentence"
649 }, 1068 },
650 "type": "array" 1069 "type": "array"
651 }, 1070 },
652 "tokens": { 1071 "tokens": {
653 "description": "Tokens, along with their syntactic informati on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F eatures.extract_syntax.", 1072 "description": "Tokens, along with their syntactic informati on, in the input document.",
654 "items": { 1073 "items": {
655 "$ref": "Token" 1074 "$ref": "Token"
656 }, 1075 },
657 "type": "array" 1076 "type": "array"
658 }, 1077 }
659 "entities": { 1078 },
660 "description": "Entities, along with their semantic informat ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest. Features.extract_entities.", 1079 "type": "object"
661 "items": {
662 "$ref": "Entity"
663 },
664 "type": "array"
665 },
666 "documentSentiment": {
667 "$ref": "Sentiment",
668 "description": "The overall sentiment for the document. Popu lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime nt."
669 }
670 },
671 "type": "object"
672 },
673 "AnalyzeSentimentRequest": {
674 "description": "The sentiment analysis request message.",
675 "id": "AnalyzeSentimentRequest",
676 "properties": {
677 "encodingType": {
678 "description": "The encoding type used by the API to calcula te sentence offsets for the\nsentence sentiment.",
679 "enum": [
680 "NONE",
681 "UTF8",
682 "UTF16",
683 "UTF32"
684 ],
685 "enumDescriptions": [
686 "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
687 "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.",
688 "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.",
689 "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."
690 ],
691 "type": "string"
692 },
693 "document": {
694 "$ref": "Document",
695 "description": "Input document. Currently, `analyzeSentiment ` only supports English text\n(Document.language=\"EN\")."
696 }
697 },
698 "type": "object"
699 },
700 "DependencyEdge": {
701 "description": "Represents dependency parse tree information for a t oken.",
702 "id": "DependencyEdge",
703 "properties": {
704 "headTokenIndex": {
705 "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.",
706 "format": "int32",
707 "type": "integer"
708 },
709 "label": {
710 "description": "The parse label for the token.",
711 "enum": [
712 "UNKNOWN",
713 "ABBREV",
714 "ACOMP",
715 "ADVCL",
716 "ADVMOD",
717 "AMOD",
718 "APPOS",
719 "ATTR",
720 "AUX",
721 "AUXPASS",
722 "CC",
723 "CCOMP",
724 "CONJ",
725 "CSUBJ",
726 "CSUBJPASS",
727 "DEP",
728 "DET",
729 "DISCOURSE",
730 "DOBJ",
731 "EXPL",
732 "GOESWITH",
733 "IOBJ",
734 "MARK",
735 "MWE",
736 "MWV",
737 "NEG",
738 "NN",
739 "NPADVMOD",
740 "NSUBJ",
741 "NSUBJPASS",
742 "NUM",
743 "NUMBER",
744 "P",
745 "PARATAXIS",
746 "PARTMOD",
747 "PCOMP",
748 "POBJ",
749 "POSS",
750 "POSTNEG",
751 "PRECOMP",
752 "PRECONJ",
753 "PREDET",
754 "PREF",
755 "PREP",
756 "PRONL",
757 "PRT",
758 "PS",
759 "QUANTMOD",
760 "RCMOD",
761 "RCMODREL",
762 "RDROP",
763 "REF",
764 "REMNANT",
765 "REPARANDUM",
766 "ROOT",
767 "SNUM",
768 "SUFF",
769 "TMOD",
770 "TOPIC",
771 "VMOD",
772 "VOCATIVE",
773 "XCOMP",
774 "SUFFIX",
775 "TITLE",
776 "ADVPHMOD",
777 "AUXCAUS",
778 "AUXVV",
779 "DTMOD",
780 "FOREIGN",
781 "KW",
782 "LIST",
783 "NOMC",
784 "NOMCSUBJ",
785 "NOMCSUBJPASS",
786 "NUMC",
787 "COP",
788 "DISLOCATED"
789 ],
790 "enumDescriptions": [
791 "Unknown",
792 "Abbreviation modifier",
793 "Adjectival complement",
794 "Adverbial clause modifier",
795 "Adverbial modifier",
796 "Adjectival modifier of an NP",
797 "Appositional modifier of an NP",
798 "Attribute dependent of a copular verb",
799 "Auxiliary (non-main) verb",
800 "Passive auxiliary",
801 "Coordinating conjunction",
802 "Clausal complement of a verb or adjective",
803 "Conjunct",
804 "Clausal subject",
805 "Clausal passive subject",
806 "Dependency (unable to determine)",
807 "Determiner",
808 "Discourse",
809 "Direct object",
810 "Expletive",
811 "Goes with (part of a word in a text not well edited)",
812 "Indirect object",
813 "Marker (word introducing a subordinate clause)",
814 "Multi-word expression",
815 "Multi-word verbal expression",
816 "Negation modifier",
817 "Noun compound modifier",
818 "Noun phrase used as an adverbial modifier",
819 "Nominal subject",
820 "Passive nominal subject",
821 "Numeric modifier of a noun",
822 "Element of compound number",
823 "Punctuation mark",
824 "Parataxis relation",
825 "Participial modifier",
826 "The complement of a preposition is a clause",
827 "Object of a preposition",
828 "Possession modifier",
829 "Postverbal negative particle",
830 "Predicate complement",
831 "Preconjunt",
832 "Predeterminer",
833 "Prefix",
834 "Prepositional modifier",
835 "The relationship between a verb and verbal morpheme",
836 "Particle",
837 "Associative or possessive marker",
838 "Quantifier phrase modifier",
839 "Relative clause modifier",
840 "Complementizer in relative clause",
841 "Ellipsis without a preceding predicate",
842 "Referent",
843 "Remnant",
844 "Reparandum",
845 "Root",
846 "Suffix specifying a unit of number",
847 "Suffix",
848 "Temporal modifier",
849 "Topic marker",
850 "Clause headed by an infinite form of the verb that modi fies a noun",
851 "Vocative",
852 "Open clausal complement",
853 "Name suffix",
854 "Name title",
855 "Adverbial phrase modifier",
856 "Causative auxiliary",
857 "Helper auxiliary",
858 "Rentaishi (Prenominal modifier)",
859 "Foreign words",
860 "Keyword",
861 "List for chains of comparable items",
862 "Nominalized clause",
863 "Nominalized clausal subject",
864 "Nominalized clausal passive",
865 "Compound of numeric modifier",
866 "Copula",
867 "Dislocated relation (for fronted/topicalized elements)"
868 ],
869 "type": "string"
870 }
871 },
872 "type": "object"
873 },
874 "Token": {
875 "description": "Represents the smallest syntactic building block of the text.",
876 "id": "Token",
877 "properties": {
878 "text": {
879 "$ref": "TextSpan",
880 "description": "The token text."
881 },
882 "dependencyEdge": {
883 "$ref": "DependencyEdge",
884 "description": "Dependency tree parse for this token."
885 },
886 "lemma": {
887 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_ %28morphology%29) of the token.",
888 "type": "string"
889 },
890 "partOfSpeech": {
891 "$ref": "PartOfSpeech",
892 "description": "Parts of speech tag for this token."
893 }
894 },
895 "type": "object"
896 },
897 "TextSpan": {
898 "description": "Represents an output piece of text.",
899 "id": "TextSpan",
900 "properties": {
901 "content": {
902 "description": "The content of the output text.",
903 "type": "string"
904 },
905 "beginOffset": {
906 "description": "The API calculates the beginning offset of t he content in the original\ndocument according to the EncodingType specified in the API request.",
907 "format": "int32",
908 "type": "integer"
909 }
910 },
911 "type": "object"
912 },
913 "Status": {
914 "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` which can be used for common error conditions.\n\n# Lan guage 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` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\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\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e 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 may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
915 "id": "Status",
916 "properties": {
917 "message": {
918 "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.",
919 "type": "string"
920 },
921 "details": {
922 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
923 "items": {
924 "additionalProperties": {
925 "description": "Properties of the object. Contains f ield @type with type URL.",
926 "type": "any"
927 },
928 "type": "object"
929 },
930 "type": "array"
931 },
932 "code": {
933 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
934 "format": "int32",
935 "type": "integer"
936 }
937 },
938 "type": "object"
939 },
940 "Features": {
941 "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.",
942 "id": "Features",
943 "properties": {
944 "extractSyntax": {
945 "description": "Extract syntax information.",
946 "type": "boolean"
947 },
948 "extractDocumentSentiment": {
949 "description": "Extract document-level sentiment.",
950 "type": "boolean"
951 },
952 "extractEntities": {
953 "description": "Extract entities.",
954 "type": "boolean"
955 }
956 },
957 "type": "object"
958 },
959 "EntityMention": {
960 "description": "Represents a mention for an entity in the text. Curr ently, proper noun\nmentions are supported.",
961 "id": "EntityMention",
962 "properties": {
963 "text": {
964 "$ref": "TextSpan",
965 "description": "The mention text."
966 },
967 "type": {
968 "description": "The type of the entity mention.",
969 "enum": [
970 "TYPE_UNKNOWN",
971 "PROPER",
972 "COMMON"
973 ],
974 "enumDescriptions": [
975 "Unknown",
976 "Proper name",
977 "Common noun (or noun compound)"
978 ],
979 "type": "string"
980 }
981 },
982 "type": "object"
983 },
984 "Document": {
985 "description": "#################################################### ############ #\n\nRepresents the input to API methods.",
986 "id": "Document",
987 "properties": {
988 "language": {
989 "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**Current Language Restrictions:**\n\n * Only English, Span ish, and Japanese textual content are supported.\nIf the language (either specif ied by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
990 "type": "string"
991 },
992 "type": {
993 "description": "Required. If the type is not set or is `TYPE _UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
994 "enum": [
995 "TYPE_UNSPECIFIED",
996 "PLAIN_TEXT",
997 "HTML"
998 ],
999 "enumDescriptions": [
1000 "The content type is not specified.",
1001 "Plain text",
1002 "HTML"
1003 ],
1004 "type": "string"
1005 },
1006 "content": {
1007 "description": "The content of the input in string format.",
1008 "type": "string"
1009 },
1010 "gcsContentUri": {
1011 "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.",
1012 "type": "string"
1013 }
1014 },
1015 "type": "object"
1016 },
1017 "Sentence": {
1018 "description": "Represents a sentence in the input document.",
1019 "id": "Sentence",
1020 "properties": {
1021 "text": {
1022 "$ref": "TextSpan",
1023 "description": "The sentence text."
1024 },
1025 "sentiment": {
1026 "$ref": "Sentiment",
1027 "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."
1028 }
1029 },
1030 "type": "object"
1031 },
1032 "Sentiment": {
1033 "description": "Represents the feeling associated with the entire te xt or entities in\nthe text.",
1034 "id": "Sentiment",
1035 "properties": {
1036 "polarity": {
1037 "description": "DEPRECATED FIELD - This field is being depre cated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.go ogle.com/natural-language/docs for more information.",
1038 "format": "float",
1039 "type": "number"
1040 },
1041 "score": {
1042 "description": "Sentiment score between -1.0 (negative senti ment) and 1.0\n(positive sentiment).",
1043 "format": "float",
1044 "type": "number"
1045 },
1046 "magnitude": {
1047 "description": "A non-negative number in the [0, +inf) range , which represents\nthe absolute magnitude of sentiment regardless of score (pos itive or\nnegative).",
1048 "format": "float",
1049 "type": "number"
1050 }
1051 },
1052 "type": "object"
1053 },
1054 "AnalyzeEntitiesRequest": {
1055 "description": "The entity analysis request message.",
1056 "id": "AnalyzeEntitiesRequest",
1057 "properties": {
1058 "document": {
1059 "$ref": "Document",
1060 "description": "Input document."
1061 },
1062 "encodingType": {
1063 "description": "The encoding type used by the API to calcula te offsets.",
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 },
1079 "type": "object"
1080 } 1080 }
1081 }, 1081 },
1082 "servicePath": "", 1082 "servicePath": "",
1083 "title": "Google Cloud Natural Language API", 1083 "title": "Google Cloud Natural Language API",
1084 "version": "v1beta1" 1084 "version": "v1beta1"
1085 } 1085 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/dns__v2beta1.json ('k') | discovery/googleapis_beta/logging__v2beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698