Api-roll 43: 2016-12-13

discovery/googleapis_beta/language__v1beta1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/cloud-platform": {
                     "description": "View and manage your data across Google Cloud Platform services"
                 }
             }
         }
     },
@@ skipping 115 matching lines @@
                     "request": {
                         "$ref": "AnalyzeSentimentRequest"
                     },
                     "response": {
                         "$ref": "AnalyzeSentimentResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/cloud-platform"
                     ]
                 },
+                "analyzeSyntax": {
+                    "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+                    "httpMethod": "POST",
+                    "id": "language.documents.analyzeSyntax",
+                    "parameterOrder": [],
+                    "parameters": {},
+                    "path": "v1beta1/documents:analyzeSyntax",
+                    "request": {
+                        "$ref": "AnalyzeSyntaxRequest"
+                    },
+                    "response": {
+                        "$ref": "AnalyzeSyntaxResponse"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/cloud-platform"
+                    ]
+                },
                 "annotateText": {
                     "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
                     "httpMethod": "POST",
                     "id": "language.documents.annotateText",
                     "parameterOrder": [],
                     "parameters": {},
                     "path": "v1beta1/documents:annotateText",
                     "request": {
                         "$ref": "AnnotateTextRequest"
                     },
@@ skipping 17 matching lines @@
                     "response": {
                         "$ref": "AnalyzeEntitiesResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/cloud-platform"
                     ]
                 }
             }
         }
     },
-    "revision": "20161103",
+    "revision": "20161205",
     "rootUrl": "https://language.googleapis.com/",
     "schemas": {
         "Document": {
             "description": "################################################################ #\n\nRepresents the input to API methods.",
             "id": "Document",
             "properties": {
                 "language": {
-                    "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.<br>\n**Current Language Restrictions:**\n\n * Only English, Spanish, and Japanese textual content\n   are supported, with the following additional restriction:\n   * `analyzeSentiment` only supports English text.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+                    "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.<br>\n**Current Language Restrictions:**\n\n * Only English, Spanish, and Japanese textual content are supported.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
                     "type": "string"
                 },
                 "gcsContentUri": {
-                    "description": "The Google Cloud Storage URI where the file content is located.",
+                    "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.\nNOTE: Cloud Storage object versioning is not supported.",
                     "type": "string"
                 },
                 "type": {
                     "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
                     "enum": [
                         "TYPE_UNSPECIFIED",
                         "PLAIN_TEXT",
                         "HTML"
                     ],
                     "enumDescriptions": [
@@ skipping 80 matching lines @@
             },
             "type": "object"
         },
         "EntityMention": {
             "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
             "id": "EntityMention",
             "properties": {
                 "text": {
                     "$ref": "TextSpan",
                     "description": "The mention text."
+                },
+                "type": {
+                    "description": "The type of the entity mention.",
+                    "enum": [
+                        "TYPE_UNKNOWN",
+                        "PROPER",
+                        "COMMON"
+                    ],
+                    "enumDescriptions": [
+                        "Unknown",
+                        "Proper name",
+                        "Common noun (or noun compound)"
+                    ],
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "AnalyzeSentimentRequest": {
             "description": "The sentiment analysis request message.",
             "id": "AnalyzeSentimentRequest",
             "properties": {
                 "document": {
                     "$ref": "Document",
                     "description": "Input document. Currently, `analyzeSentiment` only supports English text\n(Document.language=\"EN\")."
+                },
+                "encodingType": {
+                    "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+                    "enum": [
+                        "NONE",
+                        "UTF8",
+                        "UTF16",
+                        "UTF32"
+                    ],
+                    "enumDescriptions": [
+                        "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+                        "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+                        "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+                        "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."
+                    ],
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "AnalyzeSentimentResponse": {
             "description": "The sentiment analysis response message.",
             "id": "AnalyzeSentimentResponse",
             "properties": {
                 "documentSentiment": {
                     "$ref": "Sentiment",
                     "description": "The overall sentiment of the input document."
                 },
                 "language": {
                     "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.",
                     "type": "string"
+                },
+                "sentences": {
+                    "description": "The sentiment for all the sentences in the document.",
+                    "items": {
+                        "$ref": "Sentence"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "AnalyzeSyntaxRequest": {
+            "description": "The syntax analysis request message.",
+            "id": "AnalyzeSyntaxRequest",
+            "properties": {
+                "document": {
+                    "$ref": "Document",
+                    "description": "Input document."
+                },
+                "encodingType": {
+                    "description": "The encoding type used by the API to calculate offsets.",
+                    "enum": [
+                        "NONE",
+                        "UTF8",
+                        "UTF16",
+                        "UTF32"
+                    ],
+                    "enumDescriptions": [
+                        "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+                        "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+                        "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+                        "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."
+                    ],
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "DependencyEdge": {
             "description": "Represents dependency parse tree information for a token.",
             "id": "DependencyEdge",
             "properties": {
                 "headTokenIndex": {
                     "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\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 its own index.",
@@ skipping 158 matching lines @@
                         "Nominalized clausal passive",
                         "Compound of numeric modifier",
                         "Copula",
                         "Dislocated relation (for fronted/topicalized elements)"
                     ],
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "AnalyzeSyntaxResponse": {
+            "description": "The syntax analysis response message.",
+            "id": "AnalyzeSyntaxResponse",
+            "properties": {
+                "language": {
+                    "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+                    "type": "string"
+                },
+                "tokens": {
+                    "description": "Tokens, along with their syntactic information, in the input document.",
+                    "items": {
+                        "$ref": "Token"
+                    },
+                    "type": "array"
+                },
+                "sentences": {
+                    "description": "Sentences in the input document.",
+                    "items": {
+                        "$ref": "Sentence"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "AnnotateTextRequest": {
             "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
             "id": "AnnotateTextRequest",
             "properties": {
                 "document": {
                     "$ref": "Document",
                     "description": "Input document."
                 },
                 "encodingType": {
                     "description": "The encoding type used by the API to calculate offsets.",
@@ skipping 18 matching lines @@
             },
             "type": "object"
         },
         "Sentence": {
             "description": "Represents a sentence in the input document.",
             "id": "Sentence",
             "properties": {
                 "text": {
                     "$ref": "TextSpan",
                     "description": "The sentence text."
+                },
+                "sentiment": {
+                    "$ref": "Sentiment",
+                    "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
                 }
             },
             "type": "object"
         },
         "Features": {
             "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
             "id": "Features",
             "properties": {
                 "extractDocumentSentiment": {
                     "description": "Extract document-level sentiment.",
                     "type": "boolean"
                 },
                 "extractEntities": {
                     "description": "Extract entities.",
                     "type": "boolean"
                 },
                 "extractSyntax": {
                     "description": "Extract syntax information.",
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "PartOfSpeech": {
             "description": "Represents part of speech information for a token.",
             "id": "PartOfSpeech",
             "properties": {
+                "aspect": {
+                    "description": "The grammatical aspect.",
+                    "enum": [
+                        "ASPECT_UNKNOWN",
+                        "PERFECTIVE",
+                        "IMPERFECTIVE",
+                        "PROGRESSIVE"
+                    ],
+                    "enumDescriptions": [
+                        "Aspect is not applicable in the analyzed language or is not predicted.",
+                        "Perfective",
+                        "Imperfective",
+                        "Progressive"
+                    ],
+                    "type": "string"
+                },
+                "gender": {
+                    "description": "The grammatical gender.",
+                    "enum": [
+                        "GENDER_UNKNOWN",
+                        "FEMININE",
+                        "MASCULINE",
+                        "NEUTER"
+                    ],
+                    "enumDescriptions": [
+                        "Gender is not applicable in the analyzed language or is not predicted.",
+                        "Feminine",
+                        "Masculine",
+                        "Neuter"
+                    ],
+                    "type": "string"
+                },
+                "person": {
+                    "description": "The grammatical person.",
+                    "enum": [
+                        "PERSON_UNKNOWN",
+                        "FIRST",
+                        "SECOND",
+                        "THIRD",
+                        "REFLEXIVE_PERSON"
+                    ],
+                    "enumDescriptions": [
+                        "Person is not applicable in the analyzed language or is not predicted.",
+                        "First",
+                        "Second",
+                        "Third",
+                        "Reflexive"
+                    ],
+                    "type": "string"
+                },
+                "case": {
+                    "description": "The grammatical case.",
+                    "enum": [
+                        "CASE_UNKNOWN",
+                        "ACCUSATIVE",
+                        "ADVERBIAL",
+                        "COMPLEMENTIVE",
+                        "DATIVE",
+                        "GENITIVE",
+                        "INSTRUMENTAL",
+                        "LOCATIVE",
+                        "NOMINATIVE",
+                        "OBLIQUE",
+                        "PARTITIVE",
+                        "PREPOSITIONAL",
+                        "REFLEXIVE_CASE",
+                        "RELATIVE_CASE",
+                        "VOCATIVE"
+                    ],
+                    "enumDescriptions": [
+                        "Case is not applicable in the analyzed language or is not predicted.",
+                        "Accusative",
+                        "Adverbial",
+                        "Complementive",
+                        "Dative",
+                        "Genitive",
+                        "Instrumental",
+                        "Locative",
+                        "Nominative",
+                        "Oblique",
+                        "Partitive",
+                        "Prepositional",
+                        "Reflexive",
+                        "Relative",
+                        "Vocative"
+                    ],
+                    "type": "string"
+                },
+                "form": {
+                    "description": "The grammatical form.",
+                    "enum": [
+                        "FORM_UNKNOWN",
+                        "ADNOMIAL",
+                        "AUXILIARY",
+                        "COMPLEMENTIZER",
+                        "FINAL_ENDING",
+                        "GERUND",
+                        "REALIS",
+                        "IRREALIS",
+                        "SHORT",
+                        "LONG",
+                        "ORDER",
+                        "SPECIFIC"
+                    ],
+                    "enumDescriptions": [
+                        "Form is not applicable in the analyzed language or is not predicted.",
+                        "Adnomial",
+                        "Auxiliary",
+                        "Complementizer",
+                        "Final ending",
+                        "Gerund",
+                        "Realis",
+                        "Irrealis",
+                        "Short form",
+                        "Long form",
+                        "Order form",
+                        "Specific form"
+                    ],
+                    "type": "string"
+                },
+                "tense": {
+                    "description": "The grammatical tense.",
+                    "enum": [
+                        "TENSE_UNKNOWN",
+                        "CONDITIONAL_TENSE",
+                        "FUTURE",
+                        "PAST",
+                        "PRESENT",
+                        "IMPERFECT",
+                        "PLUPERFECT"
+                    ],
+                    "enumDescriptions": [
+                        "Tense is not applicable in the analyzed language or is not predicted.",
+                        "Conditional",
+                        "Future",
+                        "Past",
+                        "Present",
+                        "Imperfect",
+                        "Pluperfect"
+                    ],
+                    "type": "string"
+                },
+                "proper": {
+                    "description": "The grammatical properness.",
+                    "enum": [
+                        "PROPER_UNKNOWN",
+                        "PROPER",
+                        "NOT_PROPER"
+                    ],
+                    "enumDescriptions": [
+                        "Proper is not applicable in the analyzed language or is not predicted.",
+                        "Proper",
+                        "Not proper"
+                    ],
+                    "type": "string"
+                },
+                "mood": {
+                    "description": "The grammatical mood.",
+                    "enum": [
+                        "MOOD_UNKNOWN",
+                        "CONDITIONAL_MOOD",
+                        "IMPERATIVE",
+                        "INDICATIVE",
+                        "INTERROGATIVE",
+                        "JUSSIVE",
+                        "SUBJUNCTIVE"
+                    ],
+                    "enumDescriptions": [
+                        "Mood is not applicable in the analyzed language or is not predicted.",
+                        "Conditional",
+                        "Imperative",
+                        "Indicative",
+                        "Interrogative",
+                        "Jussive",
+                        "Subjunctive"
+                    ],
+                    "type": "string"
+                },
                 "tag": {
                     "description": "The part of speech tag.",
                     "enum": [
                         "UNKNOWN",
                         "ADJ",
                         "ADP",
                         "ADV",
                         "CONJ",
                         "DET",
                         "NOUN",
@@ skipping 15 matching lines @@
                         "Noun (common and proper)",
                         "Cardinal number",
                         "Pronoun",
                         "Particle or other function word",
                         "Punctuation",
                         "Verb (all tenses and modes)",
                         "Other: foreign words, typos, abbreviations",
                         "Affix"
                     ],
                     "type": "string"
+                },
+                "number": {
+                    "description": "The grammatical number.",
+                    "enum": [
+                        "NUMBER_UNKNOWN",
+                        "SINGULAR",
+                        "PLURAL",
+                        "DUAL"
+                    ],
+                    "enumDescriptions": [
+                        "Number is not applicable in the analyzed language or is not predicted.",
+                        "Singular",
+                        "Plural",
+                        "Dual"
+                    ],
+                    "type": "string"
+                },
+                "reciprocity": {
+                    "description": "The grammatical reciprocity.",
+                    "enum": [
+                        "RECIPROCITY_UNKNOWN",
+                        "RECIPROCAL",
+                        "NON_RECIPROCAL"
+                    ],
+                    "enumDescriptions": [
+                        "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+                        "Reciprocal",
+                        "Non-reciprocal"
+                    ],
+                    "type": "string"
+                },
+                "voice": {
+                    "description": "The grammatical voice.",
+                    "enum": [
+                        "VOICE_UNKNOWN",
+                        "ACTIVE",
+                        "CAUSATIVE",
+                        "PASSIVE"
+                    ],
+                    "enumDescriptions": [
+                        "Voice is not applicable in the analyzed language or is not predicted.",
+                        "Active",
+                        "Causative",
+                        "Passive"
+                    ],
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "AnnotateTextResponse": {
             "description": "The text annotations response message.",
             "id": "AnnotateTextResponse",
             "properties": {
                 "entities": {
                     "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
@@ skipping 28 matching lines @@
             "type": "object"
         },
         "Entity": {
             "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
             "id": "Entity",
             "properties": {
                 "metadata": {
                     "additionalProperties": {
                         "type": "string"
                     },
-                    "description": "Metadata associated with the entity.\n\nCurrently, only Wikipedia URLs are provided, if available.\nThe associated key is \"wikipedia_url\".",
+                    "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
                     "type": "object"
                 },
                 "salience": {
                     "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information 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\nsalient.",
                     "format": "float",
                     "type": "number"
                 },
                 "type": {
                     "description": "The entity type.",
                     "enum": [
@@ skipping 29 matching lines @@
                     "description": "The representative name for the entity.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "Sentiment": {
             "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
             "id": "Sentiment",
             "properties": {
+                "score": {
+                    "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+                    "format": "float",
+                    "type": "number"
+                },
                 "polarity": {
                     "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
                     "format": "float",
                     "type": "number"
                 },
                 "magnitude": {
-                    "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of polarity (positive or\nnegative).",
+                    "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
                     "format": "float",
                     "type": "number"
                 }
             },
             "type": "object"
         },
         "Token": {
             "description": "Represents the smallest syntactic building block of the text.",
             "id": "Token",
             "properties": {
                 "text": {
                     "$ref": "TextSpan",
                     "description": "The token text."
                 },
                 "partOfSpeech": {
                     "$ref": "PartOfSpeech",
                     "description": "Parts of speech tag for this token."
                 },
                 "dependencyEdge": {
                     "$ref": "DependencyEdge",
                     "description": "Dependency tree parse for this token."
                 },
                 "lemma": {
-                    "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_(morphology))\nof the token.",
+                    "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "AnalyzeEntitiesResponse": {
             "description": "The entity analysis response message.",
             "id": "AnalyzeEntitiesResponse",
             "properties": {
                 "entities": {
                     "description": "The recognized entities in the input document.",
                     "items": {
                         "$ref": "Entity"
                     },
                     "type": "array"
                 },
                 "language": {
                     "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
                     "type": "string"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Cloud Natural Language API",
     "version": "v1beta1"
 }