"description":"Apply machine learning models to reveal the structure and meaning of text"
}
}
}
},
"rootUrl":"https://language.googleapis.com/",
"ownerDomain":"google.com",
"name":"language",
"batchPath":"batch",
"title":"Google Cloud Natural Language API",
"ownerName":"Google",
"resources":{
"documents":{
"methods":{
"analyzeSyntax":{
"request":{
"$ref":"AnalyzeSyntaxRequest"
},
"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",
"parameterOrder":[],
"response":{
"$ref":"AnalyzeSyntaxResponse"
},
"parameters":{},
"scopes":[
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath":"v1beta1/documents:analyzeSyntax",
"id":"language.documents.analyzeSyntax",
"path":"v1beta1/documents:analyzeSyntax"
},
"analyzeSentiment":{
"request":{
"$ref":"AnalyzeSentimentRequest"
},
"description":"Analyzes the sentiment of the provided text.",
"httpMethod":"POST",
"parameterOrder":[],
"response":{
"$ref":"AnalyzeSentimentResponse"
},
"parameters":{},
"scopes":[
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath":"v1beta1/documents:analyzeSentiment",
"id":"language.documents.analyzeSentiment",
"path":"v1beta1/documents:analyzeSentiment"
},
"annotateText":{
"response":{
"$ref":"AnnotateTextResponse"
},
"parameterOrder":[],
"httpMethod":"POST",
"scopes":[
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters":{},
"flatPath":"v1beta1/documents:annotateText",
"path":"v1beta1/documents:annotateText",
"id":"language.documents.annotateText",
"description":"A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
"request":{
"$ref":"AnnotateTextRequest"
}
},
"analyzeEntities":{
"response":{
"$ref":"AnalyzeEntitiesResponse"
},
"parameterOrder":[],
"httpMethod":"POST",
"scopes":[
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters":{},
"flatPath":"v1beta1/documents:analyzeEntities",
"path":"v1beta1/documents:analyzeEntities",
"id":"language.documents.analyzeEntities",
"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.",
"request":{
"$ref":"AnalyzeEntitiesRequest"
}
}
}
}
},
"parameters":{
"upload_protocol":{
"location":"query",
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type":"string"
},
"prettyPrint":{
"description":"Returns response with indentations and line breaks.",
"type":"boolean",
"default":"true",
"location":"query"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type":"string",
"location":"query"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"type":"string",
"location":"query"
},
"callback":{
"location":"query",
"description":"JSONP",
"type":"string"
},
"$.xgafv":{
"enumDescriptions":[
"v1 error format",
"v2 error format"
],
"location":"query",
"enum":[
"1",
"2"
],
"description":"V1 error format.",
"type":"string"
},
"alt":{
"description":"Data format for response.",
"default":"json",
"enum":[
"json",
"media",
"proto"
],
"type":"string",
"enumDescriptions":[
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query"
},
"key":{
"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.",
"type":"string"
},
"access_token":{
"location":"query",
"description":"OAuth access token.",
"type":"string"
},
"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"
},
"pp":{
"location":"query",
"description":"Pretty-print response.",
"type":"boolean",
"default":"true"
},
"bearer_token":{
"location":"query",
"description":"OAuth bearer token.",
"type":"string"
},
"oauth_token":{
"type":"string",
"location":"query",
"description":"OAuth 2.0 token for the current user."
}
},
"version":"v1beta1",
"baseUrl":"https://language.googleapis.com/",
"kind":"discovery#restDescription",
"description":"Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"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."
],
"enum":[
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"description":"The encoding type used by the API to calculate offsets.",
"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.",
"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.",
"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.",
"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.",
"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."
"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.",
"description":"The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
"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."
"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."
"description":"The text annotations response message.",
"type":"object",
"properties":{
"documentSentiment":{
"description":"The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
"$ref":"Sentiment"
},
"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"
},
"sentences":{
"description":"Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type":"array",
"items":{
"$ref":"Sentence"
}
},
"tokens":{
"type":"array",
"items":{
"$ref":"Token"
},
"description":"Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
},
"entities":{
"description":"Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
"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.",
"description":"The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
"description":"[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type":"string"
}
},
"id":"Token"
},
"Status":{
"description":"The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should 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 that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\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\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language 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` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\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\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type":"object",
"properties":{
"code":{
"description":"The status code, which should be an enum value of google.rpc.Code.",
"description":"A developer-facing error message, which should 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.",
"description":"All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input."
},
"Sentence":{
"id":"Sentence",
"description":"Represents a sentence in the input document.",
"type":"object",
"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."
}
}
},
"Document":{
"description":"################################################################ #\n\nRepresents the input to API methods.",
"type":"object",
"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.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\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 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.",
"description":"A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
"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"
},
"score":{
"description":"Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
"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."
