| { |
| "rootUrl": "https://language.googleapis.com/", |
| "title": "Cloud Natural Language API", |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "canonicalName": "Cloud Natural Language", |
| "name": "language", |
| "resources": { |
| "documents": { |
| "methods": { |
| "analyzeEntities": { |
| "description": "Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.", |
| "path": "v1/documents:analyzeEntities", |
| "parameters": {}, |
| "id": "language.documents.analyzeEntities", |
| "flatPath": "v1/documents:analyzeEntities", |
| "request": { |
| "$ref": "AnalyzeEntitiesRequest" |
| }, |
| "parameterOrder": [], |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "AnalyzeEntitiesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "classifyText": { |
| "parameters": {}, |
| "parameterOrder": [], |
| "description": "Classifies a document into categories.", |
| "httpMethod": "POST", |
| "flatPath": "v1/documents:classifyText", |
| "path": "v1/documents:classifyText", |
| "response": { |
| "$ref": "ClassifyTextResponse" |
| }, |
| "request": { |
| "$ref": "ClassifyTextRequest" |
| }, |
| "id": "language.documents.classifyText", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "analyzeSentiment": { |
| "httpMethod": "POST", |
| "path": "v1/documents:analyzeSentiment", |
| "request": { |
| "$ref": "AnalyzeSentimentRequest" |
| }, |
| "flatPath": "v1/documents:analyzeSentiment", |
| "response": { |
| "$ref": "AnalyzeSentimentResponse" |
| }, |
| "parameterOrder": [], |
| "id": "language.documents.analyzeSentiment", |
| "parameters": {}, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Analyzes the sentiment of the provided text." |
| }, |
| "annotateText": { |
| "path": "v1/documents:annotateText", |
| "id": "language.documents.annotateText", |
| "httpMethod": "POST", |
| "request": { |
| "$ref": "AnnotateTextRequest" |
| }, |
| "flatPath": "v1/documents:annotateText", |
| "parameterOrder": [], |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "AnnotateTextResponse" |
| }, |
| "parameters": {}, |
| "description": "A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call." |
| }, |
| "analyzeEntitySentiment": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "flatPath": "v1/documents:analyzeEntitySentiment", |
| "request": { |
| "$ref": "AnalyzeEntitySentimentRequest" |
| }, |
| "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.", |
| "response": { |
| "$ref": "AnalyzeEntitySentimentResponse" |
| }, |
| "path": "v1/documents:analyzeEntitySentiment", |
| "id": "language.documents.analyzeEntitySentiment", |
| "httpMethod": "POST", |
| "parameterOrder": [], |
| "parameters": {} |
| }, |
| "analyzeSyntax": { |
| "response": { |
| "$ref": "AnalyzeSyntaxResponse" |
| }, |
| "id": "language.documents.analyzeSyntax", |
| "flatPath": "v1/documents:analyzeSyntax", |
| "parameters": {}, |
| "parameterOrder": [], |
| "path": "v1/documents:analyzeSyntax", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-language", |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "POST", |
| "description": "Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.", |
| "request": { |
| "$ref": "AnalyzeSyntaxRequest" |
| } |
| } |
| } |
| } |
| }, |
| "baseUrl": "https://language.googleapis.com/", |
| "discoveryVersion": "v1", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "version": "v1", |
| "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", |
| "basePath": "", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| }, |
| "https://www.googleapis.com/auth/cloud-language": { |
| "description": "Apply machine learning models to reveal the structure and meaning of text" |
| } |
| } |
| } |
| }, |
| "schemas": { |
| "AnalyzeSyntaxResponse": { |
| "type": "object", |
| "description": "The syntax analysis response message.", |
| "id": "AnalyzeSyntaxResponse", |
| "properties": { |
| "tokens": { |
| "items": { |
| "$ref": "Token" |
| }, |
| "description": "Tokens, along with their syntactic information, in the input document.", |
| "type": "array" |
| }, |
| "language": { |
| "type": "string", |
| "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details." |
| }, |
| "sentences": { |
| "items": { |
| "$ref": "Sentence" |
| }, |
| "type": "array", |
| "description": "Sentences in the input document." |
| } |
| } |
| }, |
| "AnalyzeSentimentResponse": { |
| "properties": { |
| "documentSentiment": { |
| "description": "The overall sentiment of the input document.", |
| "$ref": "Sentiment" |
| }, |
| "sentences": { |
| "description": "The sentiment for all the sentences in the document.", |
| "type": "array", |
| "items": { |
| "$ref": "Sentence" |
| } |
| }, |
| "language": { |
| "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", |
| "type": "string" |
| } |
| }, |
| "id": "AnalyzeSentimentResponse", |
| "type": "object", |
| "description": "The sentiment analysis response message." |
| }, |
| "ClassifyTextResponse": { |
| "id": "ClassifyTextResponse", |
| "type": "object", |
| "properties": { |
| "categories": { |
| "items": { |
| "$ref": "ClassificationCategory" |
| }, |
| "description": "Categories representing the input document.", |
| "type": "array" |
| } |
| }, |
| "description": "The document classification response message." |
| }, |
| "AnalyzeSyntaxRequest": { |
| "properties": { |
| "document": { |
| "$ref": "Document", |
| "description": "Required. Input document." |
| }, |
| "encodingType": { |
| "description": "The encoding type used by the API to calculate offsets.", |
| "enumDescriptions": [ |
| "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." |
| ], |
| "type": "string", |
| "enum": [ |
| "NONE", |
| "UTF8", |
| "UTF16", |
| "UTF32" |
| ] |
| } |
| }, |
| "type": "object", |
| "description": "The syntax analysis request message.", |
| "id": "AnalyzeSyntaxRequest" |
| }, |
| "AnnotateTextResponse": { |
| "properties": { |
| "documentSentiment": { |
| "description": "The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.", |
| "$ref": "Sentiment" |
| }, |
| "entities": { |
| "description": "Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.", |
| "items": { |
| "$ref": "Entity" |
| }, |
| "type": "array" |
| }, |
| "sentences": { |
| "description": "Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", |
| "type": "array", |
| "items": { |
| "$ref": "Sentence" |
| } |
| }, |
| "language": { |
| "type": "string", |
| "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details." |
| }, |
| "categories": { |
| "items": { |
| "$ref": "ClassificationCategory" |
| }, |
| "type": "array", |
| "description": "Categories identified in the input document." |
| }, |
| "tokens": { |
| "description": "Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", |
| "items": { |
| "$ref": "Token" |
| }, |
| "type": "array" |
| } |
| }, |
| "id": "AnnotateTextResponse", |
| "description": "The text annotations response message.", |
| "type": "object" |
| }, |
| "AnalyzeEntitySentimentResponse": { |
| "type": "object", |
| "description": "The entity-level sentiment analysis response message.", |
| "id": "AnalyzeEntitySentimentResponse", |
| "properties": { |
| "entities": { |
| "type": "array", |
| "items": { |
| "$ref": "Entity" |
| }, |
| "description": "The recognized entities in the input document with associated sentiments." |
| }, |
| "language": { |
| "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", |
| "type": "string" |
| } |
| } |
| }, |
| "PartOfSpeech": { |
| "type": "object", |
| "properties": { |
| "proper": { |
| "enum": [ |
| "PROPER_UNKNOWN", |
| "PROPER", |
| "NOT_PROPER" |
| ], |
| "enumDescriptions": [ |
| "Proper is not applicable in the analyzed language or is not predicted.", |
| "Proper", |
| "Not proper" |
| ], |
| "description": "The grammatical properness.", |
| "type": "string" |
| }, |
| "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" |
| ], |
| "description": "The grammatical tense.", |
| "type": "string" |
| }, |
| "mood": { |
| "enum": [ |
| "MOOD_UNKNOWN", |
| "CONDITIONAL_MOOD", |
| "IMPERATIVE", |
| "INDICATIVE", |
| "INTERROGATIVE", |
| "JUSSIVE", |
| "SUBJUNCTIVE" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "Mood is not applicable in the analyzed language or is not predicted.", |
| "Conditional", |
| "Imperative", |
| "Indicative", |
| "Interrogative", |
| "Jussive", |
| "Subjunctive" |
| ], |
| "description": "The grammatical mood." |
| }, |
| "number": { |
| "enum": [ |
| "NUMBER_UNKNOWN", |
| "SINGULAR", |
| "PLURAL", |
| "DUAL" |
| ], |
| "type": "string", |
| "description": "The grammatical number.", |
| "enumDescriptions": [ |
| "Number is not applicable in the analyzed language or is not predicted.", |
| "Singular", |
| "Plural", |
| "Dual" |
| ] |
| }, |
| "gender": { |
| "enumDescriptions": [ |
| "Gender is not applicable in the analyzed language or is not predicted.", |
| "Feminine", |
| "Masculine", |
| "Neuter" |
| ], |
| "description": "The grammatical gender.", |
| "enum": [ |
| "GENDER_UNKNOWN", |
| "FEMININE", |
| "MASCULINE", |
| "NEUTER" |
| ], |
| "type": "string" |
| }, |
| "reciprocity": { |
| "enumDescriptions": [ |
| "Reciprocity is not applicable in the analyzed language or is not predicted.", |
| "Reciprocal", |
| "Non-reciprocal" |
| ], |
| "enum": [ |
| "RECIPROCITY_UNKNOWN", |
| "RECIPROCAL", |
| "NON_RECIPROCAL" |
| ], |
| "description": "The grammatical reciprocity.", |
| "type": "string" |
| }, |
| "case": { |
| "description": "The grammatical case.", |
| "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" |
| ], |
| "enum": [ |
| "CASE_UNKNOWN", |
| "ACCUSATIVE", |
| "ADVERBIAL", |
| "COMPLEMENTIVE", |
| "DATIVE", |
| "GENITIVE", |
| "INSTRUMENTAL", |
| "LOCATIVE", |
| "NOMINATIVE", |
| "OBLIQUE", |
| "PARTITIVE", |
| "PREPOSITIONAL", |
| "REFLEXIVE_CASE", |
| "RELATIVE_CASE", |
| "VOCATIVE" |
| ], |
| "type": "string" |
| }, |
| "form": { |
| "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" |
| ], |
| "enum": [ |
| "FORM_UNKNOWN", |
| "ADNOMIAL", |
| "AUXILIARY", |
| "COMPLEMENTIZER", |
| "FINAL_ENDING", |
| "GERUND", |
| "REALIS", |
| "IRREALIS", |
| "SHORT", |
| "LONG", |
| "ORDER", |
| "SPECIFIC" |
| ], |
| "description": "The grammatical form.", |
| "type": "string" |
| }, |
| "voice": { |
| "enum": [ |
| "VOICE_UNKNOWN", |
| "ACTIVE", |
| "CAUSATIVE", |
| "PASSIVE" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "Voice is not applicable in the analyzed language or is not predicted.", |
| "Active", |
| "Causative", |
| "Passive" |
| ], |
| "description": "The grammatical voice." |
| }, |
| "person": { |
| "enum": [ |
| "PERSON_UNKNOWN", |
| "FIRST", |
| "SECOND", |
| "THIRD", |
| "REFLEXIVE_PERSON" |
| ], |
| "description": "The grammatical person.", |
| "enumDescriptions": [ |
| "Person is not applicable in the analyzed language or is not predicted.", |
| "First", |
| "Second", |
| "Third", |
| "Reflexive" |
| ], |
| "type": "string" |
| }, |
| "tag": { |
| "description": "The part of speech tag.", |
| "type": "string", |
| "enum": [ |
| "UNKNOWN", |
| "ADJ", |
| "ADP", |
| "ADV", |
| "CONJ", |
| "DET", |
| "NOUN", |
| "NUM", |
| "PRON", |
| "PRT", |
| "PUNCT", |
| "VERB", |
| "X", |
| "AFFIX" |
| ], |
| "enumDescriptions": [ |
| "Unknown", |
| "Adjective", |
| "Adposition (preposition and postposition)", |
| "Adverb", |
| "Conjunction", |
| "Determiner", |
| "Noun (common and proper)", |
| "Cardinal number", |
| "Pronoun", |
| "Particle or other function word", |
| "Punctuation", |
| "Verb (all tenses and modes)", |
| "Other: foreign words, typos, abbreviations", |
| "Affix" |
| ] |
| }, |
| "aspect": { |
| "enumDescriptions": [ |
| "Aspect is not applicable in the analyzed language or is not predicted.", |
| "Perfective", |
| "Imperfective", |
| "Progressive" |
| ], |
| "type": "string", |
| "description": "The grammatical aspect.", |
| "enum": [ |
| "ASPECT_UNKNOWN", |
| "PERFECTIVE", |
| "IMPERFECTIVE", |
| "PROGRESSIVE" |
| ] |
| } |
| }, |
| "id": "PartOfSpeech", |
| "description": "Represents part of speech information for a token. Parts of speech are as defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf" |
| }, |
| "Document": { |
| "description": "################################################################ # Represents the input to API methods.", |
| "type": "object", |
| "properties": { |
| "content": { |
| "description": "The content of the input in string format. Cloud audit logging exempt since it is based on user data.", |
| "type": "string" |
| }, |
| "language": { |
| "type": "string", |
| "description": "The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned." |
| }, |
| "gcsContentUri": { |
| "description": "The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.", |
| "type": "string" |
| }, |
| "type": { |
| "enumDescriptions": [ |
| "The content type is not specified.", |
| "Plain text", |
| "HTML" |
| ], |
| "type": "string", |
| "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.", |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "PLAIN_TEXT", |
| "HTML" |
| ] |
| } |
| }, |
| "id": "Document" |
| }, |
| "Sentence": { |
| "description": "Represents a sentence in the input document.", |
| "type": "object", |
| "properties": { |
| "sentiment": { |
| "$ref": "Sentiment", |
| "description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." |
| }, |
| "text": { |
| "$ref": "TextSpan", |
| "description": "The sentence text." |
| } |
| }, |
| "id": "Sentence" |
| }, |
| "AnalyzeEntitiesResponse": { |
| "properties": { |
| "entities": { |
| "items": { |
| "$ref": "Entity" |
| }, |
| "type": "array", |
| "description": "The recognized entities in the input document." |
| }, |
| "language": { |
| "type": "string", |
| "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details." |
| } |
| }, |
| "type": "object", |
| "id": "AnalyzeEntitiesResponse", |
| "description": "The entity analysis response message." |
| }, |
| "DependencyEdge": { |
| "description": "Represents dependency parse tree information for a token. (For more information on dependency labels, see http://www.aclweb.org/anthology/P13-2017", |
| "id": "DependencyEdge", |
| "properties": { |
| "headTokenIndex": { |
| "format": "int32", |
| "description": "Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index.", |
| "type": "integer" |
| }, |
| "label": { |
| "enum": [ |
| "UNKNOWN", |
| "ABBREV", |
| "ACOMP", |
| "ADVCL", |
| "ADVMOD", |
| "AMOD", |
| "APPOS", |
| "ATTR", |
| "AUX", |
| "AUXPASS", |
| "CC", |
| "CCOMP", |
| "CONJ", |
| "CSUBJ", |
| "CSUBJPASS", |
| "DEP", |
| "DET", |
| "DISCOURSE", |
| "DOBJ", |
| "EXPL", |
| "GOESWITH", |
| "IOBJ", |
| "MARK", |
| "MWE", |
| "MWV", |
| "NEG", |
| "NN", |
| "NPADVMOD", |
| "NSUBJ", |
| "NSUBJPASS", |
| "NUM", |
| "NUMBER", |
| "P", |
| "PARATAXIS", |
| "PARTMOD", |
| "PCOMP", |
| "POBJ", |
| "POSS", |
| "POSTNEG", |
| "PRECOMP", |
| "PRECONJ", |
| "PREDET", |
| "PREF", |
| "PREP", |
| "PRONL", |
| "PRT", |
| "PS", |
| "QUANTMOD", |
| "RCMOD", |
| "RCMODREL", |
| "RDROP", |
| "REF", |
| "REMNANT", |
| "REPARANDUM", |
| "ROOT", |
| "SNUM", |
| "SUFF", |
| "TMOD", |
| "TOPIC", |
| "VMOD", |
| "VOCATIVE", |
| "XCOMP", |
| "SUFFIX", |
| "TITLE", |
| "ADVPHMOD", |
| "AUXCAUS", |
| "AUXVV", |
| "DTMOD", |
| "FOREIGN", |
| "KW", |
| "LIST", |
| "NOMC", |
| "NOMCSUBJ", |
| "NOMCSUBJPASS", |
| "NUMC", |
| "COP", |
| "DISLOCATED", |
| "ASP", |
| "GMOD", |
| "GOBJ", |
| "INFMOD", |
| "MES", |
| "NCOMP" |
| ], |
| "description": "The parse label for the token.", |
| "enumDescriptions": [ |
| "Unknown", |
| "Abbreviation modifier", |
| "Adjectival complement", |
| "Adverbial clause modifier", |
| "Adverbial modifier", |
| "Adjectival modifier of an NP", |
| "Appositional modifier of an NP", |
| "Attribute dependent of a copular verb", |
| "Auxiliary (non-main) verb", |
| "Passive auxiliary", |
| "Coordinating conjunction", |
| "Clausal complement of a verb or adjective", |
| "Conjunct", |
| "Clausal subject", |
| "Clausal passive subject", |
| "Dependency (unable to determine)", |
| "Determiner", |
| "Discourse", |
| "Direct object", |
| "Expletive", |
| "Goes with (part of a word in a text not well edited)", |
| "Indirect object", |
| "Marker (word introducing a subordinate clause)", |
| "Multi-word expression", |
| "Multi-word verbal expression", |
| "Negation modifier", |
| "Noun compound modifier", |
| "Noun phrase used as an adverbial modifier", |
| "Nominal subject", |
| "Passive nominal subject", |
| "Numeric modifier of a noun", |
| "Element of compound number", |
| "Punctuation mark", |
| "Parataxis relation", |
| "Participial modifier", |
| "The complement of a preposition is a clause", |
| "Object of a preposition", |
| "Possession modifier", |
| "Postverbal negative particle", |
| "Predicate complement", |
| "Preconjunt", |
| "Predeterminer", |
| "Prefix", |
| "Prepositional modifier", |
| "The relationship between a verb and verbal morpheme", |
| "Particle", |
| "Associative or possessive marker", |
| "Quantifier phrase modifier", |
| "Relative clause modifier", |
| "Complementizer in relative clause", |
| "Ellipsis without a preceding predicate", |
| "Referent", |
| "Remnant", |
| "Reparandum", |
| "Root", |
| "Suffix specifying a unit of number", |
| "Suffix", |
| "Temporal modifier", |
| "Topic marker", |
| "Clause headed by an infinite form of the verb that modifies a noun", |
| "Vocative", |
| "Open clausal complement", |
| "Name suffix", |
| "Name title", |
| "Adverbial phrase modifier", |
| "Causative auxiliary", |
| "Helper auxiliary", |
| "Rentaishi (Prenominal modifier)", |
| "Foreign words", |
| "Keyword", |
| "List for chains of comparable items", |
| "Nominalized clause", |
| "Nominalized clausal subject", |
| "Nominalized clausal passive", |
| "Compound of numeric modifier", |
| "Copula", |
| "Dislocated relation (for fronted/topicalized elements)", |
| "Aspect marker", |
| "Genitive modifier", |
| "Genitive object", |
| "Infinitival modifier", |
| "Measure", |
| "Nominal complement of a noun" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "TextSpan": { |
| "type": "object", |
| "id": "TextSpan", |
| "properties": { |
| "content": { |
| "type": "string", |
| "description": "The content of the output text." |
| }, |
| "beginOffset": { |
| "description": "The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.", |
| "format": "int32", |
| "type": "integer" |
| } |
| }, |
| "description": "Represents an output piece of text." |
| }, |
| "Token": { |
| "id": "Token", |
| "properties": { |
| "lemma": { |
| "type": "string", |
| "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token." |
| }, |
| "text": { |
| "description": "The token text.", |
| "$ref": "TextSpan" |
| }, |
| "partOfSpeech": { |
| "description": "Parts of speech tag for this token.", |
| "$ref": "PartOfSpeech" |
| }, |
| "dependencyEdge": { |
| "description": "Dependency tree parse for this token.", |
| "$ref": "DependencyEdge" |
| } |
| }, |
| "description": "Represents the smallest syntactic building block of the text.", |
| "type": "object" |
| }, |
| "Features": { |
| "id": "Features", |
| "type": "object", |
| "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.", |
| "properties": { |
| "extractEntitySentiment": { |
| "description": "Extract entities and their associated sentiment.", |
| "type": "boolean" |
| }, |
| "extractEntities": { |
| "type": "boolean", |
| "description": "Extract entities." |
| }, |
| "extractDocumentSentiment": { |
| "type": "boolean", |
| "description": "Extract document-level sentiment." |
| }, |
| "extractSyntax": { |
| "description": "Extract syntax information.", |
| "type": "boolean" |
| }, |
| "classifyText": { |
| "type": "boolean", |
| "description": "Classify the full document into categories." |
| } |
| } |
| }, |
| "AnalyzeSentimentRequest": { |
| "description": "The sentiment analysis request message.", |
| "type": "object", |
| "properties": { |
| "encodingType": { |
| "enumDescriptions": [ |
| "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." |
| ], |
| "enum": [ |
| "NONE", |
| "UTF8", |
| "UTF16", |
| "UTF32" |
| ], |
| "type": "string", |
| "description": "The encoding type used by the API to calculate sentence offsets." |
| }, |
| "document": { |
| "$ref": "Document", |
| "description": "Required. Input document." |
| } |
| }, |
| "id": "AnalyzeSentimentRequest" |
| }, |
| "AnalyzeEntitiesRequest": { |
| "type": "object", |
| "properties": { |
| "document": { |
| "description": "Required. Input document.", |
| "$ref": "Document" |
| }, |
| "encodingType": { |
| "description": "The encoding type used by the API to calculate offsets.", |
| "enum": [ |
| "NONE", |
| "UTF8", |
| "UTF16", |
| "UTF32" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." |
| ] |
| } |
| }, |
| "id": "AnalyzeEntitiesRequest", |
| "description": "The entity analysis request message." |
| }, |
| "Entity": { |
| "id": "Entity", |
| "description": "Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.", |
| "properties": { |
| "sentiment": { |
| "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.", |
| "$ref": "Sentiment" |
| }, |
| "mentions": { |
| "description": "The mentions of this entity in the input document. The API currently supports proper noun mentions.", |
| "items": { |
| "$ref": "EntityMention" |
| }, |
| "type": "array" |
| }, |
| "metadata": { |
| "type": "object", |
| "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", |
| "additionalProperties": { |
| "type": "string" |
| } |
| }, |
| "name": { |
| "type": "string", |
| "description": "The representative name for the entity." |
| }, |
| "salience": { |
| "format": "float", |
| "type": "number", |
| "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient." |
| }, |
| "type": { |
| "enum": [ |
| "UNKNOWN", |
| "PERSON", |
| "LOCATION", |
| "ORGANIZATION", |
| "EVENT", |
| "WORK_OF_ART", |
| "CONSUMER_GOOD", |
| "OTHER", |
| "PHONE_NUMBER", |
| "ADDRESS", |
| "DATE", |
| "NUMBER", |
| "PRICE" |
| ], |
| "description": "The entity type.", |
| "type": "string", |
| "enumDescriptions": [ |
| "Unknown", |
| "Person", |
| "Location", |
| "Organization", |
| "Event", |
| "Artwork", |
| "Consumer product", |
| "Other types of entities", |
| "Phone number The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text: * `number` - the actual number, broken down into sections as per local convention * `national_prefix` - country code, if detected * `area_code` - region or area code, if detected * `extension` - phone extension (to be dialed after connection), if detected", |
| "Address The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - street number * `locality` - city or town * `street_name` - street/route name, if detected * `postal_code` - postal code, if detected * `country` - country, if detected\u003c * `broad_region` - administrative area, such as the state, if detected * `narrow_region` - smaller administrative area, such as county, if detected * `sublocality` - used in Asian addresses to demark a district within a city, if detected", |
| "Date The metadata identifies the components of the date: * `year` - four digit year, if detected * `month` - two digit month number, if detected * `day` - two digit day number, if detected", |
| "Number The metadata is the number itself.", |
| "Price The metadata identifies the `value` and `currency`." |
| ] |
| } |
| }, |
| "type": "object" |
| }, |
| "Sentiment": { |
| "id": "Sentiment", |
| "properties": { |
| "magnitude": { |
| "format": "float", |
| "type": "number", |
| "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative)." |
| }, |
| "score": { |
| "format": "float", |
| "type": "number", |
| "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment)." |
| } |
| }, |
| "type": "object", |
| "description": "Represents the feeling associated with the entire text or entities in the text." |
| }, |
| "ClassificationCategory": { |
| "id": "ClassificationCategory", |
| "description": "Represents a category returned from the text classifier.", |
| "properties": { |
| "confidence": { |
| "format": "float", |
| "description": "The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.", |
| "type": "number" |
| }, |
| "name": { |
| "type": "string", |
| "description": "The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories)." |
| } |
| }, |
| "type": "object" |
| }, |
| "ClassifyTextRequest": { |
| "id": "ClassifyTextRequest", |
| "properties": { |
| "document": { |
| "description": "Required. Input document.", |
| "$ref": "Document" |
| } |
| }, |
| "description": "The document classification request message.", |
| "type": "object" |
| }, |
| "AnnotateTextRequest": { |
| "id": "AnnotateTextRequest", |
| "description": "The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.", |
| "properties": { |
| "features": { |
| "description": "Required. The enabled features.", |
| "$ref": "Features" |
| }, |
| "encodingType": { |
| "description": "The encoding type used by the API to calculate offsets.", |
| "type": "string", |
| "enum": [ |
| "NONE", |
| "UTF8", |
| "UTF16", |
| "UTF32" |
| ], |
| "enumDescriptions": [ |
| "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." |
| ] |
| }, |
| "document": { |
| "description": "Required. Input document.", |
| "$ref": "Document" |
| } |
| }, |
| "type": "object" |
| }, |
| "Status": { |
| "id": "Status", |
| "type": "object", |
| "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", |
| "properties": { |
| "message": { |
| "type": "string", |
| "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." |
| }, |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "type": "array", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." |
| } |
| } |
| }, |
| "EntityMention": { |
| "id": "EntityMention", |
| "description": "Represents a mention for an entity in the text. Currently, proper noun mentions are supported.", |
| "type": "object", |
| "properties": { |
| "sentiment": { |
| "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.", |
| "$ref": "Sentiment" |
| }, |
| "type": { |
| "type": "string", |
| "description": "The type of the entity mention.", |
| "enum": [ |
| "TYPE_UNKNOWN", |
| "PROPER", |
| "COMMON" |
| ], |
| "enumDescriptions": [ |
| "Unknown", |
| "Proper name", |
| "Common noun (or noun compound)" |
| ] |
| }, |
| "text": { |
| "description": "The mention text.", |
| "$ref": "TextSpan" |
| } |
| } |
| }, |
| "AnalyzeEntitySentimentRequest": { |
| "id": "AnalyzeEntitySentimentRequest", |
| "properties": { |
| "encodingType": { |
| "enum": [ |
| "NONE", |
| "UTF8", |
| "UTF16", |
| "UTF32" |
| ], |
| "description": "The encoding type used by the API to calculate offsets.", |
| "enumDescriptions": [ |
| "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", |
| "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." |
| ], |
| "type": "string" |
| }, |
| "document": { |
| "description": "Required. Input document.", |
| "$ref": "Document" |
| } |
| }, |
| "description": "The entity-level sentiment analysis request message.", |
| "type": "object" |
| } |
| }, |
| "protocol": "rest", |
| "mtlsRootUrl": "https://language.mtls.googleapis.com/", |
| "revision": "20200801", |
| "version_module": true, |
| "parameters": { |
| "key": { |
| "type": "string", |
| "location": "query", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." |
| }, |
| "$.xgafv": { |
| "type": "string", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "description": "V1 error format.", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "type": "boolean", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "location": "query", |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "type": "string" |
| }, |
| "alt": { |
| "location": "query", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "description": "Data format for response.", |
| "type": "string", |
| "default": "json" |
| }, |
| "upload_protocol": { |
| "location": "query", |
| "type": "string", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." |
| }, |
| "fields": { |
| "location": "query", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "type": "string" |
| }, |
| "access_token": { |
| "location": "query", |
| "description": "OAuth access token.", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user.", |
| "type": "string" |
| }, |
| "uploadType": { |
| "location": "query", |
| "type": "string", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." |
| }, |
| "callback": { |
| "location": "query", |
| "description": "JSONP", |
| "type": "string" |
| } |
| }, |
| "documentationLink": "https://cloud.google.com/natural-language/", |
| "kind": "discovery#restDescription", |
| "id": "language:v1", |
| "fullyEncodeReservedExpansion": true, |
| "servicePath": "", |
| "batchPath": "batch" |
| } |
