OLD | NEW |
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 }, |
| 8 "https://www.googleapis.com/auth/cloud-language": { |
| 9 "description": "Apply machine learning models to reveal the
structure and meaning of text" |
7 } | 10 } |
8 } | 11 } |
9 } | 12 } |
10 }, | 13 }, |
11 "basePath": "", | 14 "basePath": "", |
12 "baseUrl": "https://language.googleapis.com/", | 15 "baseUrl": "https://language.googleapis.com/", |
13 "batchPath": "batch", | 16 "batchPath": "batch", |
14 "canonicalName": "Cloud Natural Language", | 17 "canonicalName": "Cloud Natural Language", |
15 "description": "Provides natural language understanding technologies to deve
lopers. Examples include sentiment analysis, entity recognition, entity sentimen
t analysis, and text annotations.", | 18 "description": "Provides natural language understanding technologies to deve
lopers. Examples include sentiment analysis, entity recognition, entity sentimen
t analysis, and text annotations.", |
16 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
(...skipping 22 matching lines...) Expand all Loading... |
39 "uploadType": { | 42 "uploadType": { |
40 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
41 "location": "query", | 44 "location": "query", |
42 "type": "string" | 45 "type": "string" |
43 }, | 46 }, |
44 "fields": { | 47 "fields": { |
45 "description": "Selector specifying which fields to include in a par
tial response.", | 48 "description": "Selector specifying which fields to include in a par
tial response.", |
46 "location": "query", | 49 "location": "query", |
47 "type": "string" | 50 "type": "string" |
48 }, | 51 }, |
49 "callback": { | |
50 "description": "JSONP", | |
51 "location": "query", | |
52 "type": "string" | |
53 }, | |
54 "$.xgafv": { | 52 "$.xgafv": { |
55 "description": "V1 error format.", | 53 "description": "V1 error format.", |
56 "enum": [ | 54 "enum": [ |
57 "1", | 55 "1", |
58 "2" | 56 "2" |
59 ], | 57 ], |
60 "enumDescriptions": [ | 58 "enumDescriptions": [ |
61 "v1 error format", | 59 "v1 error format", |
62 "v2 error format" | 60 "v2 error format" |
63 ], | 61 ], |
64 "location": "query", | 62 "location": "query", |
65 "type": "string" | 63 "type": "string" |
66 }, | 64 }, |
| 65 "callback": { |
| 66 "description": "JSONP", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
67 "alt": { | 70 "alt": { |
68 "default": "json", | 71 "default": "json", |
69 "description": "Data format for response.", | 72 "description": "Data format for response.", |
70 "enum": [ | 73 "enum": [ |
71 "json", | 74 "json", |
72 "media", | 75 "media", |
73 "proto" | 76 "proto" |
74 ], | 77 ], |
75 "enumDescriptions": [ | 78 "enumDescriptions": [ |
76 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
77 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
78 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
79 ], | 82 ], |
80 "location": "query", | 83 "location": "query", |
81 "type": "string" | 84 "type": "string" |
82 }, | 85 }, |
| 86 "access_token": { |
| 87 "description": "OAuth access token.", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
83 "key": { | 91 "key": { |
84 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 92 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
85 "location": "query", | 93 "location": "query", |
86 "type": "string" | 94 "type": "string" |
87 }, | 95 }, |
88 "access_token": { | |
89 "description": "OAuth access token.", | |
90 "location": "query", | |
91 "type": "string" | |
92 }, | |
93 "quotaUser": { | 96 "quotaUser": { |
94 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
95 "location": "query", | 98 "location": "query", |
96 "type": "string" | 99 "type": "string" |
97 }, | 100 }, |
98 "pp": { | 101 "pp": { |
99 "default": "true", | 102 "default": "true", |
100 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
101 "location": "query", | 104 "location": "query", |
102 "type": "boolean" | 105 "type": "boolean" |
103 }, | 106 }, |
104 "bearer_token": { | 107 "bearer_token": { |
105 "description": "OAuth bearer token.", | 108 "description": "OAuth bearer token.", |
106 "location": "query", | 109 "location": "query", |
107 "type": "string" | 110 "type": "string" |
108 }, | 111 }, |
109 "oauth_token": { | 112 "oauth_token": { |
110 "description": "OAuth 2.0 token for the current user.", | 113 "description": "OAuth 2.0 token for the current user.", |
111 "location": "query", | 114 "location": "query", |
112 "type": "string" | 115 "type": "string" |
113 } | 116 } |
114 }, | 117 }, |
115 "protocol": "rest", | 118 "protocol": "rest", |
116 "resources": { | 119 "resources": { |
117 "documents": { | 120 "documents": { |
118 "methods": { | 121 "methods": { |
| 122 "analyzeSyntax": { |
| 123 "description": "Analyzes the syntax of the text and provides
sentence boundaries and\ntokenization along with part of speech tags, dependenc
y trees, and other\nproperties.", |
| 124 "httpMethod": "POST", |
| 125 "id": "language.documents.analyzeSyntax", |
| 126 "parameterOrder": [], |
| 127 "parameters": {}, |
| 128 "path": "v1beta1/documents:analyzeSyntax", |
| 129 "request": { |
| 130 "$ref": "AnalyzeSyntaxRequest" |
| 131 }, |
| 132 "response": { |
| 133 "$ref": "AnalyzeSyntaxResponse" |
| 134 }, |
| 135 "scopes": [ |
| 136 "https://www.googleapis.com/auth/cloud-language", |
| 137 "https://www.googleapis.com/auth/cloud-platform" |
| 138 ] |
| 139 }, |
119 "analyzeSentiment": { | 140 "analyzeSentiment": { |
120 "description": "Analyzes the sentiment of the provided text.
", | 141 "description": "Analyzes the sentiment of the provided text.
", |
121 "httpMethod": "POST", | 142 "httpMethod": "POST", |
122 "id": "language.documents.analyzeSentiment", | 143 "id": "language.documents.analyzeSentiment", |
123 "parameterOrder": [], | 144 "parameterOrder": [], |
124 "parameters": {}, | 145 "parameters": {}, |
125 "path": "v1beta1/documents:analyzeSentiment", | 146 "path": "v1beta1/documents:analyzeSentiment", |
126 "request": { | 147 "request": { |
127 "$ref": "AnalyzeSentimentRequest" | 148 "$ref": "AnalyzeSentimentRequest" |
128 }, | 149 }, |
129 "response": { | 150 "response": { |
130 "$ref": "AnalyzeSentimentResponse" | 151 "$ref": "AnalyzeSentimentResponse" |
131 }, | 152 }, |
132 "scopes": [ | 153 "scopes": [ |
| 154 "https://www.googleapis.com/auth/cloud-language", |
133 "https://www.googleapis.com/auth/cloud-platform" | 155 "https://www.googleapis.com/auth/cloud-platform" |
134 ] | 156 ] |
135 }, | 157 }, |
136 "annotateText": { | 158 "annotateText": { |
137 "description": "A convenience method that provides all the f
eatures that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in on
e call.", | 159 "description": "A convenience method that provides all the f
eatures that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in on
e call.", |
138 "httpMethod": "POST", | 160 "httpMethod": "POST", |
139 "id": "language.documents.annotateText", | 161 "id": "language.documents.annotateText", |
140 "parameterOrder": [], | 162 "parameterOrder": [], |
141 "parameters": {}, | 163 "parameters": {}, |
142 "path": "v1beta1/documents:annotateText", | 164 "path": "v1beta1/documents:annotateText", |
143 "request": { | 165 "request": { |
144 "$ref": "AnnotateTextRequest" | 166 "$ref": "AnnotateTextRequest" |
145 }, | 167 }, |
146 "response": { | 168 "response": { |
147 "$ref": "AnnotateTextResponse" | 169 "$ref": "AnnotateTextResponse" |
148 }, | 170 }, |
149 "scopes": [ | 171 "scopes": [ |
| 172 "https://www.googleapis.com/auth/cloud-language", |
150 "https://www.googleapis.com/auth/cloud-platform" | 173 "https://www.googleapis.com/auth/cloud-platform" |
151 ] | 174 ] |
152 }, | 175 }, |
153 "analyzeEntities": { | 176 "analyzeEntities": { |
154 "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.", | 177 "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.", |
155 "httpMethod": "POST", | 178 "httpMethod": "POST", |
156 "id": "language.documents.analyzeEntities", | 179 "id": "language.documents.analyzeEntities", |
157 "parameterOrder": [], | 180 "parameterOrder": [], |
158 "parameters": {}, | 181 "parameters": {}, |
159 "path": "v1beta1/documents:analyzeEntities", | 182 "path": "v1beta1/documents:analyzeEntities", |
160 "request": { | 183 "request": { |
161 "$ref": "AnalyzeEntitiesRequest" | 184 "$ref": "AnalyzeEntitiesRequest" |
162 }, | 185 }, |
163 "response": { | 186 "response": { |
164 "$ref": "AnalyzeEntitiesResponse" | 187 "$ref": "AnalyzeEntitiesResponse" |
165 }, | 188 }, |
166 "scopes": [ | 189 "scopes": [ |
167 "https://www.googleapis.com/auth/cloud-platform" | 190 "https://www.googleapis.com/auth/cloud-language", |
168 ] | |
169 }, | |
170 "analyzeSyntax": { | |
171 "description": "Analyzes the syntax of the text and provides
sentence boundaries and\ntokenization along with part of speech tags, dependenc
y trees, and other\nproperties.", | |
172 "httpMethod": "POST", | |
173 "id": "language.documents.analyzeSyntax", | |
174 "parameterOrder": [], | |
175 "parameters": {}, | |
176 "path": "v1beta1/documents:analyzeSyntax", | |
177 "request": { | |
178 "$ref": "AnalyzeSyntaxRequest" | |
179 }, | |
180 "response": { | |
181 "$ref": "AnalyzeSyntaxResponse" | |
182 }, | |
183 "scopes": [ | |
184 "https://www.googleapis.com/auth/cloud-platform" | 191 "https://www.googleapis.com/auth/cloud-platform" |
185 ] | 192 ] |
186 } | 193 } |
187 } | 194 } |
188 } | 195 } |
189 }, | 196 }, |
190 "revision": "20170619", | 197 "revision": "20170726", |
191 "rootUrl": "https://language.googleapis.com/", | 198 "rootUrl": "https://language.googleapis.com/", |
192 "schemas": { | 199 "schemas": { |
193 "Status": { | 200 "AnnotateTextRequest": { |
194 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | 201 "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": "Status", | 202 "id": "AnnotateTextRequest", |
196 "properties": { | |
197 "message": { | |
198 "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.", | |
199 "type": "string" | |
200 }, | |
201 "details": { | |
202 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
203 "items": { | |
204 "additionalProperties": { | |
205 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
206 "type": "any" | |
207 }, | |
208 "type": "object" | |
209 }, | |
210 "type": "array" | |
211 }, | |
212 "code": { | |
213 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
214 "format": "int32", | |
215 "type": "integer" | |
216 } | |
217 }, | |
218 "type": "object" | |
219 }, | |
220 "EntityMention": { | |
221 "description": "Represents a mention for an entity in the text. Curr
ently, proper noun\nmentions are supported.", | |
222 "id": "EntityMention", | |
223 "properties": { | |
224 "text": { | |
225 "$ref": "TextSpan", | |
226 "description": "The mention text." | |
227 }, | |
228 "type": { | |
229 "description": "The type of the entity mention.", | |
230 "enum": [ | |
231 "TYPE_UNKNOWN", | |
232 "PROPER", | |
233 "COMMON" | |
234 ], | |
235 "enumDescriptions": [ | |
236 "Unknown", | |
237 "Proper name", | |
238 "Common noun (or noun compound)" | |
239 ], | |
240 "type": "string" | |
241 } | |
242 }, | |
243 "type": "object" | |
244 }, | |
245 "Features": { | |
246 "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.", | |
247 "id": "Features", | |
248 "properties": { | |
249 "extractSyntax": { | |
250 "description": "Extract syntax information.", | |
251 "type": "boolean" | |
252 }, | |
253 "extractDocumentSentiment": { | |
254 "description": "Extract document-level sentiment.", | |
255 "type": "boolean" | |
256 }, | |
257 "extractEntities": { | |
258 "description": "Extract entities.", | |
259 "type": "boolean" | |
260 } | |
261 }, | |
262 "type": "object" | |
263 }, | |
264 "Document": { | |
265 "description": "####################################################
############ #\n\nRepresents the input to API methods.", | |
266 "id": "Document", | |
267 "properties": { | |
268 "gcsContentUri": { | |
269 "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.", | |
270 "type": "string" | |
271 }, | |
272 "language": { | |
273 "description": "The language of the document (if not specifi
ed, the language is\nautomatically detected). Both ISO and BCP-47 language codes
are\naccepted.<br>\n[Language Support](/natural-language/docs/languages)\nlists
currently supported languages for each API method.\nIf the language (either spe
cified by the caller or automatically detected)\nis not supported by the called
API method, an `INVALID_ARGUMENT` error\nis returned.", | |
274 "type": "string" | |
275 }, | |
276 "type": { | |
277 "description": "Required. If the type is not set or is `TYPE
_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", | |
278 "enum": [ | |
279 "TYPE_UNSPECIFIED", | |
280 "PLAIN_TEXT", | |
281 "HTML" | |
282 ], | |
283 "enumDescriptions": [ | |
284 "The content type is not specified.", | |
285 "Plain text", | |
286 "HTML" | |
287 ], | |
288 "type": "string" | |
289 }, | |
290 "content": { | |
291 "description": "The content of the input in string format.", | |
292 "type": "string" | |
293 } | |
294 }, | |
295 "type": "object" | |
296 }, | |
297 "Sentence": { | |
298 "description": "Represents a sentence in the input document.", | |
299 "id": "Sentence", | |
300 "properties": { | |
301 "text": { | |
302 "$ref": "TextSpan", | |
303 "description": "The sentence text." | |
304 }, | |
305 "sentiment": { | |
306 "$ref": "Sentiment", | |
307 "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." | |
308 } | |
309 }, | |
310 "type": "object" | |
311 }, | |
312 "Sentiment": { | |
313 "description": "Represents the feeling associated with the entire te
xt or entities in\nthe text.", | |
314 "id": "Sentiment", | |
315 "properties": { | |
316 "polarity": { | |
317 "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.", | |
318 "format": "float", | |
319 "type": "number" | |
320 }, | |
321 "score": { | |
322 "description": "Sentiment score between -1.0 (negative senti
ment) and 1.0\n(positive sentiment).", | |
323 "format": "float", | |
324 "type": "number" | |
325 }, | |
326 "magnitude": { | |
327 "description": "A non-negative number in the [0, +inf) range
, which represents\nthe absolute magnitude of sentiment regardless of score (pos
itive or\nnegative).", | |
328 "format": "float", | |
329 "type": "number" | |
330 } | |
331 }, | |
332 "type": "object" | |
333 }, | |
334 "AnalyzeEntitiesRequest": { | |
335 "description": "The entity analysis request message.", | |
336 "id": "AnalyzeEntitiesRequest", | |
337 "properties": { | 203 "properties": { |
338 "encodingType": { | 204 "encodingType": { |
339 "description": "The encoding type used by the API to calcula
te offsets.", | 205 "description": "The encoding type used by the API to calcula
te offsets.", |
340 "enum": [ | 206 "enum": [ |
341 "NONE", | 207 "NONE", |
342 "UTF8", | 208 "UTF8", |
| 209 "UTF16", |
| 210 "UTF32" |
| 211 ], |
| 212 "enumDescriptions": [ |
| 213 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
| 214 "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.", |
| 215 "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.", |
| 216 "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." |
| 217 ], |
| 218 "type": "string" |
| 219 }, |
| 220 "document": { |
| 221 "$ref": "Document", |
| 222 "description": "Input document." |
| 223 }, |
| 224 "features": { |
| 225 "$ref": "Features", |
| 226 "description": "The enabled features." |
| 227 } |
| 228 }, |
| 229 "type": "object" |
| 230 }, |
| 231 "AnnotateTextResponse": { |
| 232 "description": "The text annotations response message.", |
| 233 "id": "AnnotateTextResponse", |
| 234 "properties": { |
| 235 "documentSentiment": { |
| 236 "$ref": "Sentiment", |
| 237 "description": "The overall sentiment for the document. Popu
lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime
nt." |
| 238 }, |
| 239 "language": { |
| 240 "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.", |
| 241 "type": "string" |
| 242 }, |
| 243 "sentences": { |
| 244 "description": "Sentences in the input document. Populated i
f the user enables\nAnnotateTextRequest.Features.extract_syntax.", |
| 245 "items": { |
| 246 "$ref": "Sentence" |
| 247 }, |
| 248 "type": "array" |
| 249 }, |
| 250 "tokens": { |
| 251 "description": "Tokens, along with their syntactic informati
on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F
eatures.extract_syntax.", |
| 252 "items": { |
| 253 "$ref": "Token" |
| 254 }, |
| 255 "type": "array" |
| 256 }, |
| 257 "entities": { |
| 258 "description": "Entities, along with their semantic informat
ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.
Features.extract_entities.", |
| 259 "items": { |
| 260 "$ref": "Entity" |
| 261 }, |
| 262 "type": "array" |
| 263 } |
| 264 }, |
| 265 "type": "object" |
| 266 }, |
| 267 "AnalyzeSentimentRequest": { |
| 268 "description": "The sentiment analysis request message.", |
| 269 "id": "AnalyzeSentimentRequest", |
| 270 "properties": { |
| 271 "encodingType": { |
| 272 "description": "The encoding type used by the API to calcula
te sentence offsets for the\nsentence sentiment.", |
| 273 "enum": [ |
| 274 "NONE", |
| 275 "UTF8", |
343 "UTF16", | 276 "UTF16", |
344 "UTF32" | 277 "UTF32" |
345 ], | 278 ], |
346 "enumDescriptions": [ | 279 "enumDescriptions": [ |
347 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | 280 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
348 "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.", | 281 "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.", |
349 "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.", | 282 "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.", |
350 "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." | 283 "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." |
351 ], | 284 ], |
352 "type": "string" | 285 "type": "string" |
353 }, | 286 }, |
354 "document": { | 287 "document": { |
355 "$ref": "Document", | 288 "$ref": "Document", |
356 "description": "Input document." | 289 "description": "Input document." |
357 } | 290 } |
358 }, | 291 }, |
359 "type": "object" | 292 "type": "object" |
360 }, | 293 }, |
| 294 "DependencyEdge": { |
| 295 "description": "Represents dependency parse tree information for a t
oken.", |
| 296 "id": "DependencyEdge", |
| 297 "properties": { |
| 298 "headTokenIndex": { |
| 299 "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.", |
| 300 "format": "int32", |
| 301 "type": "integer" |
| 302 }, |
| 303 "label": { |
| 304 "description": "The parse label for the token.", |
| 305 "enum": [ |
| 306 "UNKNOWN", |
| 307 "ABBREV", |
| 308 "ACOMP", |
| 309 "ADVCL", |
| 310 "ADVMOD", |
| 311 "AMOD", |
| 312 "APPOS", |
| 313 "ATTR", |
| 314 "AUX", |
| 315 "AUXPASS", |
| 316 "CC", |
| 317 "CCOMP", |
| 318 "CONJ", |
| 319 "CSUBJ", |
| 320 "CSUBJPASS", |
| 321 "DEP", |
| 322 "DET", |
| 323 "DISCOURSE", |
| 324 "DOBJ", |
| 325 "EXPL", |
| 326 "GOESWITH", |
| 327 "IOBJ", |
| 328 "MARK", |
| 329 "MWE", |
| 330 "MWV", |
| 331 "NEG", |
| 332 "NN", |
| 333 "NPADVMOD", |
| 334 "NSUBJ", |
| 335 "NSUBJPASS", |
| 336 "NUM", |
| 337 "NUMBER", |
| 338 "P", |
| 339 "PARATAXIS", |
| 340 "PARTMOD", |
| 341 "PCOMP", |
| 342 "POBJ", |
| 343 "POSS", |
| 344 "POSTNEG", |
| 345 "PRECOMP", |
| 346 "PRECONJ", |
| 347 "PREDET", |
| 348 "PREF", |
| 349 "PREP", |
| 350 "PRONL", |
| 351 "PRT", |
| 352 "PS", |
| 353 "QUANTMOD", |
| 354 "RCMOD", |
| 355 "RCMODREL", |
| 356 "RDROP", |
| 357 "REF", |
| 358 "REMNANT", |
| 359 "REPARANDUM", |
| 360 "ROOT", |
| 361 "SNUM", |
| 362 "SUFF", |
| 363 "TMOD", |
| 364 "TOPIC", |
| 365 "VMOD", |
| 366 "VOCATIVE", |
| 367 "XCOMP", |
| 368 "SUFFIX", |
| 369 "TITLE", |
| 370 "ADVPHMOD", |
| 371 "AUXCAUS", |
| 372 "AUXVV", |
| 373 "DTMOD", |
| 374 "FOREIGN", |
| 375 "KW", |
| 376 "LIST", |
| 377 "NOMC", |
| 378 "NOMCSUBJ", |
| 379 "NOMCSUBJPASS", |
| 380 "NUMC", |
| 381 "COP", |
| 382 "DISLOCATED" |
| 383 ], |
| 384 "enumDescriptions": [ |
| 385 "Unknown", |
| 386 "Abbreviation modifier", |
| 387 "Adjectival complement", |
| 388 "Adverbial clause modifier", |
| 389 "Adverbial modifier", |
| 390 "Adjectival modifier of an NP", |
| 391 "Appositional modifier of an NP", |
| 392 "Attribute dependent of a copular verb", |
| 393 "Auxiliary (non-main) verb", |
| 394 "Passive auxiliary", |
| 395 "Coordinating conjunction", |
| 396 "Clausal complement of a verb or adjective", |
| 397 "Conjunct", |
| 398 "Clausal subject", |
| 399 "Clausal passive subject", |
| 400 "Dependency (unable to determine)", |
| 401 "Determiner", |
| 402 "Discourse", |
| 403 "Direct object", |
| 404 "Expletive", |
| 405 "Goes with (part of a word in a text not well edited)", |
| 406 "Indirect object", |
| 407 "Marker (word introducing a subordinate clause)", |
| 408 "Multi-word expression", |
| 409 "Multi-word verbal expression", |
| 410 "Negation modifier", |
| 411 "Noun compound modifier", |
| 412 "Noun phrase used as an adverbial modifier", |
| 413 "Nominal subject", |
| 414 "Passive nominal subject", |
| 415 "Numeric modifier of a noun", |
| 416 "Element of compound number", |
| 417 "Punctuation mark", |
| 418 "Parataxis relation", |
| 419 "Participial modifier", |
| 420 "The complement of a preposition is a clause", |
| 421 "Object of a preposition", |
| 422 "Possession modifier", |
| 423 "Postverbal negative particle", |
| 424 "Predicate complement", |
| 425 "Preconjunt", |
| 426 "Predeterminer", |
| 427 "Prefix", |
| 428 "Prepositional modifier", |
| 429 "The relationship between a verb and verbal morpheme", |
| 430 "Particle", |
| 431 "Associative or possessive marker", |
| 432 "Quantifier phrase modifier", |
| 433 "Relative clause modifier", |
| 434 "Complementizer in relative clause", |
| 435 "Ellipsis without a preceding predicate", |
| 436 "Referent", |
| 437 "Remnant", |
| 438 "Reparandum", |
| 439 "Root", |
| 440 "Suffix specifying a unit of number", |
| 441 "Suffix", |
| 442 "Temporal modifier", |
| 443 "Topic marker", |
| 444 "Clause headed by an infinite form of the verb that modi
fies a noun", |
| 445 "Vocative", |
| 446 "Open clausal complement", |
| 447 "Name suffix", |
| 448 "Name title", |
| 449 "Adverbial phrase modifier", |
| 450 "Causative auxiliary", |
| 451 "Helper auxiliary", |
| 452 "Rentaishi (Prenominal modifier)", |
| 453 "Foreign words", |
| 454 "Keyword", |
| 455 "List for chains of comparable items", |
| 456 "Nominalized clause", |
| 457 "Nominalized clausal subject", |
| 458 "Nominalized clausal passive", |
| 459 "Compound of numeric modifier", |
| 460 "Copula", |
| 461 "Dislocated relation (for fronted/topicalized elements)" |
| 462 ], |
| 463 "type": "string" |
| 464 } |
| 465 }, |
| 466 "type": "object" |
| 467 }, |
| 468 "TextSpan": { |
| 469 "description": "Represents an output piece of text.", |
| 470 "id": "TextSpan", |
| 471 "properties": { |
| 472 "beginOffset": { |
| 473 "description": "The API calculates the beginning offset of t
he content in the original\ndocument according to the EncodingType specified in
the API request.", |
| 474 "format": "int32", |
| 475 "type": "integer" |
| 476 }, |
| 477 "content": { |
| 478 "description": "The content of the output text.", |
| 479 "type": "string" |
| 480 } |
| 481 }, |
| 482 "type": "object" |
| 483 }, |
| 484 "Token": { |
| 485 "description": "Represents the smallest syntactic building block of
the text.", |
| 486 "id": "Token", |
| 487 "properties": { |
| 488 "dependencyEdge": { |
| 489 "$ref": "DependencyEdge", |
| 490 "description": "Dependency tree parse for this token." |
| 491 }, |
| 492 "text": { |
| 493 "$ref": "TextSpan", |
| 494 "description": "The token text." |
| 495 }, |
| 496 "lemma": { |
| 497 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_
%28morphology%29) of the token.", |
| 498 "type": "string" |
| 499 }, |
| 500 "partOfSpeech": { |
| 501 "$ref": "PartOfSpeech", |
| 502 "description": "Parts of speech tag for this token." |
| 503 } |
| 504 }, |
| 505 "type": "object" |
| 506 }, |
| 507 "Status": { |
| 508 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
| 509 "id": "Status", |
| 510 "properties": { |
| 511 "code": { |
| 512 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 513 "format": "int32", |
| 514 "type": "integer" |
| 515 }, |
| 516 "message": { |
| 517 "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.", |
| 518 "type": "string" |
| 519 }, |
| 520 "details": { |
| 521 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 522 "items": { |
| 523 "additionalProperties": { |
| 524 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 525 "type": "any" |
| 526 }, |
| 527 "type": "object" |
| 528 }, |
| 529 "type": "array" |
| 530 } |
| 531 }, |
| 532 "type": "object" |
| 533 }, |
| 534 "Features": { |
| 535 "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.", |
| 536 "id": "Features", |
| 537 "properties": { |
| 538 "extractEntities": { |
| 539 "description": "Extract entities.", |
| 540 "type": "boolean" |
| 541 }, |
| 542 "extractDocumentSentiment": { |
| 543 "description": "Extract document-level sentiment.", |
| 544 "type": "boolean" |
| 545 }, |
| 546 "extractSyntax": { |
| 547 "description": "Extract syntax information.", |
| 548 "type": "boolean" |
| 549 } |
| 550 }, |
| 551 "type": "object" |
| 552 }, |
| 553 "EntityMention": { |
| 554 "description": "Represents a mention for an entity in the text. Curr
ently, proper noun\nmentions are supported.", |
| 555 "id": "EntityMention", |
| 556 "properties": { |
| 557 "type": { |
| 558 "description": "The type of the entity mention.", |
| 559 "enum": [ |
| 560 "TYPE_UNKNOWN", |
| 561 "PROPER", |
| 562 "COMMON" |
| 563 ], |
| 564 "enumDescriptions": [ |
| 565 "Unknown", |
| 566 "Proper name", |
| 567 "Common noun (or noun compound)" |
| 568 ], |
| 569 "type": "string" |
| 570 }, |
| 571 "text": { |
| 572 "$ref": "TextSpan", |
| 573 "description": "The mention text." |
| 574 } |
| 575 }, |
| 576 "type": "object" |
| 577 }, |
| 578 "Sentence": { |
| 579 "description": "Represents a sentence in the input document.", |
| 580 "id": "Sentence", |
| 581 "properties": { |
| 582 "text": { |
| 583 "$ref": "TextSpan", |
| 584 "description": "The sentence text." |
| 585 }, |
| 586 "sentiment": { |
| 587 "$ref": "Sentiment", |
| 588 "description": "For calls to AnalyzeSentiment or if\nAnnotat
eTextRequest.Features.extract_document_sentiment is set to\ntrue, this field wil
l contain the sentiment for the sentence." |
| 589 } |
| 590 }, |
| 591 "type": "object" |
| 592 }, |
| 593 "Document": { |
| 594 "description": "####################################################
############ #\n\nRepresents the input to API methods.", |
| 595 "id": "Document", |
| 596 "properties": { |
| 597 "content": { |
| 598 "description": "The content of the input in string format.", |
| 599 "type": "string" |
| 600 }, |
| 601 "type": { |
| 602 "description": "Required. If the type is not set or is `TYPE
_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", |
| 603 "enum": [ |
| 604 "TYPE_UNSPECIFIED", |
| 605 "PLAIN_TEXT", |
| 606 "HTML" |
| 607 ], |
| 608 "enumDescriptions": [ |
| 609 "The content type is not specified.", |
| 610 "Plain text", |
| 611 "HTML" |
| 612 ], |
| 613 "type": "string" |
| 614 }, |
| 615 "gcsContentUri": { |
| 616 "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.", |
| 617 "type": "string" |
| 618 }, |
| 619 "language": { |
| 620 "description": "The language of the document (if not specifi
ed, the language is\nautomatically detected). Both ISO and BCP-47 language codes
are\naccepted.<br>\n[Language Support](/natural-language/docs/languages)\nlists
currently supported languages for each API method.\nIf the language (either spe
cified by the caller or automatically detected)\nis not supported by the called
API method, an `INVALID_ARGUMENT` error\nis returned.", |
| 621 "type": "string" |
| 622 } |
| 623 }, |
| 624 "type": "object" |
| 625 }, |
| 626 "Sentiment": { |
| 627 "description": "Represents the feeling associated with the entire te
xt or entities in\nthe text.", |
| 628 "id": "Sentiment", |
| 629 "properties": { |
| 630 "score": { |
| 631 "description": "Sentiment score between -1.0 (negative senti
ment) and 1.0\n(positive sentiment).", |
| 632 "format": "float", |
| 633 "type": "number" |
| 634 }, |
| 635 "polarity": { |
| 636 "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.", |
| 637 "format": "float", |
| 638 "type": "number" |
| 639 }, |
| 640 "magnitude": { |
| 641 "description": "A non-negative number in the [0, +inf) range
, which represents\nthe absolute magnitude of sentiment regardless of score (pos
itive or\nnegative).", |
| 642 "format": "float", |
| 643 "type": "number" |
| 644 } |
| 645 }, |
| 646 "type": "object" |
| 647 }, |
| 648 "AnalyzeEntitiesRequest": { |
| 649 "description": "The entity analysis request message.", |
| 650 "id": "AnalyzeEntitiesRequest", |
| 651 "properties": { |
| 652 "encodingType": { |
| 653 "description": "The encoding type used by the API to calcula
te offsets.", |
| 654 "enum": [ |
| 655 "NONE", |
| 656 "UTF8", |
| 657 "UTF16", |
| 658 "UTF32" |
| 659 ], |
| 660 "enumDescriptions": [ |
| 661 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", |
| 662 "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.", |
| 663 "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.", |
| 664 "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." |
| 665 ], |
| 666 "type": "string" |
| 667 }, |
| 668 "document": { |
| 669 "$ref": "Document", |
| 670 "description": "Input document." |
| 671 } |
| 672 }, |
| 673 "type": "object" |
| 674 }, |
361 "PartOfSpeech": { | 675 "PartOfSpeech": { |
362 "description": "Represents part of speech information for a token.", | 676 "description": "Represents part of speech information for a token.", |
363 "id": "PartOfSpeech", | 677 "id": "PartOfSpeech", |
364 "properties": { | 678 "properties": { |
365 "person": { | |
366 "description": "The grammatical person.", | |
367 "enum": [ | |
368 "PERSON_UNKNOWN", | |
369 "FIRST", | |
370 "SECOND", | |
371 "THIRD", | |
372 "REFLEXIVE_PERSON" | |
373 ], | |
374 "enumDescriptions": [ | |
375 "Person is not applicable in the analyzed language or is
not predicted.", | |
376 "First", | |
377 "Second", | |
378 "Third", | |
379 "Reflexive" | |
380 ], | |
381 "type": "string" | |
382 }, | |
383 "proper": { | |
384 "description": "The grammatical properness.", | |
385 "enum": [ | |
386 "PROPER_UNKNOWN", | |
387 "PROPER", | |
388 "NOT_PROPER" | |
389 ], | |
390 "enumDescriptions": [ | |
391 "Proper is not applicable in the analyzed language or is
not predicted.", | |
392 "Proper", | |
393 "Not proper" | |
394 ], | |
395 "type": "string" | |
396 }, | |
397 "case": { | |
398 "description": "The grammatical case.", | |
399 "enum": [ | |
400 "CASE_UNKNOWN", | |
401 "ACCUSATIVE", | |
402 "ADVERBIAL", | |
403 "COMPLEMENTIVE", | |
404 "DATIVE", | |
405 "GENITIVE", | |
406 "INSTRUMENTAL", | |
407 "LOCATIVE", | |
408 "NOMINATIVE", | |
409 "OBLIQUE", | |
410 "PARTITIVE", | |
411 "PREPOSITIONAL", | |
412 "REFLEXIVE_CASE", | |
413 "RELATIVE_CASE", | |
414 "VOCATIVE" | |
415 ], | |
416 "enumDescriptions": [ | |
417 "Case is not applicable in the analyzed language or is n
ot predicted.", | |
418 "Accusative", | |
419 "Adverbial", | |
420 "Complementive", | |
421 "Dative", | |
422 "Genitive", | |
423 "Instrumental", | |
424 "Locative", | |
425 "Nominative", | |
426 "Oblique", | |
427 "Partitive", | |
428 "Prepositional", | |
429 "Reflexive", | |
430 "Relative", | |
431 "Vocative" | |
432 ], | |
433 "type": "string" | |
434 }, | |
435 "tense": { | |
436 "description": "The grammatical tense.", | |
437 "enum": [ | |
438 "TENSE_UNKNOWN", | |
439 "CONDITIONAL_TENSE", | |
440 "FUTURE", | |
441 "PAST", | |
442 "PRESENT", | |
443 "IMPERFECT", | |
444 "PLUPERFECT" | |
445 ], | |
446 "enumDescriptions": [ | |
447 "Tense is not applicable in the analyzed language or is
not predicted.", | |
448 "Conditional", | |
449 "Future", | |
450 "Past", | |
451 "Present", | |
452 "Imperfect", | |
453 "Pluperfect" | |
454 ], | |
455 "type": "string" | |
456 }, | |
457 "reciprocity": { | |
458 "description": "The grammatical reciprocity.", | |
459 "enum": [ | |
460 "RECIPROCITY_UNKNOWN", | |
461 "RECIPROCAL", | |
462 "NON_RECIPROCAL" | |
463 ], | |
464 "enumDescriptions": [ | |
465 "Reciprocity is not applicable in the analyzed language
or is not\npredicted.", | |
466 "Reciprocal", | |
467 "Non-reciprocal" | |
468 ], | |
469 "type": "string" | |
470 }, | |
471 "form": { | 679 "form": { |
472 "description": "The grammatical form.", | 680 "description": "The grammatical form.", |
473 "enum": [ | 681 "enum": [ |
474 "FORM_UNKNOWN", | 682 "FORM_UNKNOWN", |
475 "ADNOMIAL", | 683 "ADNOMIAL", |
476 "AUXILIARY", | 684 "AUXILIARY", |
477 "COMPLEMENTIZER", | 685 "COMPLEMENTIZER", |
478 "FINAL_ENDING", | 686 "FINAL_ENDING", |
479 "GERUND", | 687 "GERUND", |
480 "REALIS", | 688 "REALIS", |
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
614 "MASCULINE", | 822 "MASCULINE", |
615 "NEUTER" | 823 "NEUTER" |
616 ], | 824 ], |
617 "enumDescriptions": [ | 825 "enumDescriptions": [ |
618 "Gender is not applicable in the analyzed language or is
not predicted.", | 826 "Gender is not applicable in the analyzed language or is
not predicted.", |
619 "Feminine", | 827 "Feminine", |
620 "Masculine", | 828 "Masculine", |
621 "Neuter" | 829 "Neuter" |
622 ], | 830 ], |
623 "type": "string" | 831 "type": "string" |
| 832 }, |
| 833 "person": { |
| 834 "description": "The grammatical person.", |
| 835 "enum": [ |
| 836 "PERSON_UNKNOWN", |
| 837 "FIRST", |
| 838 "SECOND", |
| 839 "THIRD", |
| 840 "REFLEXIVE_PERSON" |
| 841 ], |
| 842 "enumDescriptions": [ |
| 843 "Person is not applicable in the analyzed language or is
not predicted.", |
| 844 "First", |
| 845 "Second", |
| 846 "Third", |
| 847 "Reflexive" |
| 848 ], |
| 849 "type": "string" |
| 850 }, |
| 851 "proper": { |
| 852 "description": "The grammatical properness.", |
| 853 "enum": [ |
| 854 "PROPER_UNKNOWN", |
| 855 "PROPER", |
| 856 "NOT_PROPER" |
| 857 ], |
| 858 "enumDescriptions": [ |
| 859 "Proper is not applicable in the analyzed language or is
not predicted.", |
| 860 "Proper", |
| 861 "Not proper" |
| 862 ], |
| 863 "type": "string" |
| 864 }, |
| 865 "case": { |
| 866 "description": "The grammatical case.", |
| 867 "enum": [ |
| 868 "CASE_UNKNOWN", |
| 869 "ACCUSATIVE", |
| 870 "ADVERBIAL", |
| 871 "COMPLEMENTIVE", |
| 872 "DATIVE", |
| 873 "GENITIVE", |
| 874 "INSTRUMENTAL", |
| 875 "LOCATIVE", |
| 876 "NOMINATIVE", |
| 877 "OBLIQUE", |
| 878 "PARTITIVE", |
| 879 "PREPOSITIONAL", |
| 880 "REFLEXIVE_CASE", |
| 881 "RELATIVE_CASE", |
| 882 "VOCATIVE" |
| 883 ], |
| 884 "enumDescriptions": [ |
| 885 "Case is not applicable in the analyzed language or is n
ot predicted.", |
| 886 "Accusative", |
| 887 "Adverbial", |
| 888 "Complementive", |
| 889 "Dative", |
| 890 "Genitive", |
| 891 "Instrumental", |
| 892 "Locative", |
| 893 "Nominative", |
| 894 "Oblique", |
| 895 "Partitive", |
| 896 "Prepositional", |
| 897 "Reflexive", |
| 898 "Relative", |
| 899 "Vocative" |
| 900 ], |
| 901 "type": "string" |
| 902 }, |
| 903 "tense": { |
| 904 "description": "The grammatical tense.", |
| 905 "enum": [ |
| 906 "TENSE_UNKNOWN", |
| 907 "CONDITIONAL_TENSE", |
| 908 "FUTURE", |
| 909 "PAST", |
| 910 "PRESENT", |
| 911 "IMPERFECT", |
| 912 "PLUPERFECT" |
| 913 ], |
| 914 "enumDescriptions": [ |
| 915 "Tense is not applicable in the analyzed language or is
not predicted.", |
| 916 "Conditional", |
| 917 "Future", |
| 918 "Past", |
| 919 "Present", |
| 920 "Imperfect", |
| 921 "Pluperfect" |
| 922 ], |
| 923 "type": "string" |
| 924 }, |
| 925 "reciprocity": { |
| 926 "description": "The grammatical reciprocity.", |
| 927 "enum": [ |
| 928 "RECIPROCITY_UNKNOWN", |
| 929 "RECIPROCAL", |
| 930 "NON_RECIPROCAL" |
| 931 ], |
| 932 "enumDescriptions": [ |
| 933 "Reciprocity is not applicable in the analyzed language
or is not\npredicted.", |
| 934 "Reciprocal", |
| 935 "Non-reciprocal" |
| 936 ], |
| 937 "type": "string" |
624 } | 938 } |
625 }, | 939 }, |
626 "type": "object" | 940 "type": "object" |
627 }, | 941 }, |
628 "AnalyzeSyntaxRequest": { | 942 "AnalyzeSyntaxRequest": { |
629 "description": "The syntax analysis request message.", | 943 "description": "The syntax analysis request message.", |
630 "id": "AnalyzeSyntaxRequest", | 944 "id": "AnalyzeSyntaxRequest", |
631 "properties": { | 945 "properties": { |
632 "encodingType": { | 946 "encodingType": { |
633 "description": "The encoding type used by the API to calcula
te offsets.", | 947 "description": "The encoding type used by the API to calcula
te offsets.", |
(...skipping 15 matching lines...) Expand all Loading... |
649 "$ref": "Document", | 963 "$ref": "Document", |
650 "description": "Input document." | 964 "description": "Input document." |
651 } | 965 } |
652 }, | 966 }, |
653 "type": "object" | 967 "type": "object" |
654 }, | 968 }, |
655 "AnalyzeSentimentResponse": { | 969 "AnalyzeSentimentResponse": { |
656 "description": "The sentiment analysis response message.", | 970 "description": "The sentiment analysis response message.", |
657 "id": "AnalyzeSentimentResponse", | 971 "id": "AnalyzeSentimentResponse", |
658 "properties": { | 972 "properties": { |
659 "language": { | |
660 "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.", | |
661 "type": "string" | |
662 }, | |
663 "sentences": { | 973 "sentences": { |
664 "description": "The sentiment for all the sentences in the d
ocument.", | 974 "description": "The sentiment for all the sentences in the d
ocument.", |
665 "items": { | 975 "items": { |
666 "$ref": "Sentence" | 976 "$ref": "Sentence" |
667 }, | 977 }, |
668 "type": "array" | 978 "type": "array" |
669 }, | 979 }, |
670 "documentSentiment": { | 980 "documentSentiment": { |
671 "$ref": "Sentiment", | 981 "$ref": "Sentiment", |
672 "description": "The overall sentiment of the input document.
" | 982 "description": "The overall sentiment of the input document.
" |
| 983 }, |
| 984 "language": { |
| 985 "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.", |
| 986 "type": "string" |
673 } | 987 } |
674 }, | 988 }, |
675 "type": "object" | 989 "type": "object" |
676 }, | 990 }, |
677 "AnalyzeEntitiesResponse": { | 991 "AnalyzeEntitiesResponse": { |
678 "description": "The entity analysis response message.", | 992 "description": "The entity analysis response message.", |
679 "id": "AnalyzeEntitiesResponse", | 993 "id": "AnalyzeEntitiesResponse", |
680 "properties": { | 994 "properties": { |
681 "language": { | 995 "language": { |
682 "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.", |
(...skipping 17 matching lines...) Expand all Loading... |
700 "description": "The mentions of this entity in the input doc
ument. The API currently\nsupports proper noun mentions.", | 1014 "description": "The mentions of this entity in the input doc
ument. The API currently\nsupports proper noun mentions.", |
701 "items": { | 1015 "items": { |
702 "$ref": "EntityMention" | 1016 "$ref": "EntityMention" |
703 }, | 1017 }, |
704 "type": "array" | 1018 "type": "array" |
705 }, | 1019 }, |
706 "name": { | 1020 "name": { |
707 "description": "The representative name for the entity.", | 1021 "description": "The representative name for the entity.", |
708 "type": "string" | 1022 "type": "string" |
709 }, | 1023 }, |
| 1024 "salience": { |
| 1025 "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.", |
| 1026 "format": "float", |
| 1027 "type": "number" |
| 1028 }, |
| 1029 "metadata": { |
| 1030 "additionalProperties": { |
| 1031 "type": "string" |
| 1032 }, |
| 1033 "description": "Metadata associated with the entity.\n\nCurr
ently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The
associated keys are \"wikipedia_url\" and \"mid\", respectively.", |
| 1034 "type": "object" |
| 1035 }, |
710 "type": { | 1036 "type": { |
711 "description": "The entity type.", | 1037 "description": "The entity type.", |
712 "enum": [ | 1038 "enum": [ |
713 "UNKNOWN", | 1039 "UNKNOWN", |
714 "PERSON", | 1040 "PERSON", |
715 "LOCATION", | 1041 "LOCATION", |
716 "ORGANIZATION", | 1042 "ORGANIZATION", |
717 "EVENT", | 1043 "EVENT", |
718 "WORK_OF_ART", | 1044 "WORK_OF_ART", |
719 "CONSUMER_GOOD", | 1045 "CONSUMER_GOOD", |
720 "OTHER" | 1046 "OTHER" |
721 ], | 1047 ], |
722 "enumDescriptions": [ | 1048 "enumDescriptions": [ |
723 "Unknown", | 1049 "Unknown", |
724 "Person", | 1050 "Person", |
725 "Location", | 1051 "Location", |
726 "Organization", | 1052 "Organization", |
727 "Event", | 1053 "Event", |
728 "Work of art", | 1054 "Work of art", |
729 "Consumer goods", | 1055 "Consumer goods", |
730 "Other types" | 1056 "Other types" |
731 ], | 1057 ], |
732 "type": "string" | 1058 "type": "string" |
733 }, | |
734 "metadata": { | |
735 "additionalProperties": { | |
736 "type": "string" | |
737 }, | |
738 "description": "Metadata associated with the entity.\n\nCurr
ently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The
associated keys are \"wikipedia_url\" and \"mid\", respectively.", | |
739 "type": "object" | |
740 }, | |
741 "salience": { | |
742 "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.", | |
743 "format": "float", | |
744 "type": "number" | |
745 } | 1059 } |
746 }, | 1060 }, |
747 "type": "object" | 1061 "type": "object" |
748 }, | 1062 }, |
749 "AnalyzeSyntaxResponse": { | 1063 "AnalyzeSyntaxResponse": { |
750 "description": "The syntax analysis response message.", | 1064 "description": "The syntax analysis response message.", |
751 "id": "AnalyzeSyntaxResponse", | 1065 "id": "AnalyzeSyntaxResponse", |
752 "properties": { | 1066 "properties": { |
753 "language": { | |
754 "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.", | |
755 "type": "string" | |
756 }, | |
757 "sentences": { | 1067 "sentences": { |
758 "description": "Sentences in the input document.", | 1068 "description": "Sentences in the input document.", |
759 "items": { | 1069 "items": { |
760 "$ref": "Sentence" | 1070 "$ref": "Sentence" |
761 }, | 1071 }, |
762 "type": "array" | 1072 "type": "array" |
763 }, | 1073 }, |
764 "tokens": { | 1074 "tokens": { |
765 "description": "Tokens, along with their syntactic informati
on, in the input document.", | 1075 "description": "Tokens, along with their syntactic informati
on, in the input document.", |
766 "items": { | 1076 "items": { |
767 "$ref": "Token" | 1077 "$ref": "Token" |
768 }, | 1078 }, |
769 "type": "array" | 1079 "type": "array" |
770 } | |
771 }, | |
772 "type": "object" | |
773 }, | |
774 "AnnotateTextRequest": { | |
775 "description": "The request message for the text annotation API, whi
ch can perform multiple\nanalysis types (sentiment, entities, and syntax) in one
call.", | |
776 "id": "AnnotateTextRequest", | |
777 "properties": { | |
778 "encodingType": { | |
779 "description": "The encoding type used by the API to calcula
te offsets.", | |
780 "enum": [ | |
781 "NONE", | |
782 "UTF8", | |
783 "UTF16", | |
784 "UTF32" | |
785 ], | |
786 "enumDescriptions": [ | |
787 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | |
788 "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.", | |
789 "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.", | |
790 "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." | |
791 ], | |
792 "type": "string" | |
793 }, | 1080 }, |
794 "document": { | |
795 "$ref": "Document", | |
796 "description": "Input document." | |
797 }, | |
798 "features": { | |
799 "$ref": "Features", | |
800 "description": "The enabled features." | |
801 } | |
802 }, | |
803 "type": "object" | |
804 }, | |
805 "AnalyzeSentimentRequest": { | |
806 "description": "The sentiment analysis request message.", | |
807 "id": "AnalyzeSentimentRequest", | |
808 "properties": { | |
809 "encodingType": { | |
810 "description": "The encoding type used by the API to calcula
te sentence offsets for the\nsentence sentiment.", | |
811 "enum": [ | |
812 "NONE", | |
813 "UTF8", | |
814 "UTF16", | |
815 "UTF32" | |
816 ], | |
817 "enumDescriptions": [ | |
818 "If `EncodingType` is not specified, encoding-dependent
information (such as\n`begin_offset`) will be set at `-1`.", | |
819 "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.", | |
820 "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.", | |
821 "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." | |
822 ], | |
823 "type": "string" | |
824 }, | |
825 "document": { | |
826 "$ref": "Document", | |
827 "description": "Input document." | |
828 } | |
829 }, | |
830 "type": "object" | |
831 }, | |
832 "AnnotateTextResponse": { | |
833 "description": "The text annotations response message.", | |
834 "id": "AnnotateTextResponse", | |
835 "properties": { | |
836 "language": { | 1081 "language": { |
837 "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.", | 1082 "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.", |
838 "type": "string" | 1083 "type": "string" |
839 }, | |
840 "sentences": { | |
841 "description": "Sentences in the input document. Populated i
f the user enables\nAnnotateTextRequest.Features.extract_syntax.", | |
842 "items": { | |
843 "$ref": "Sentence" | |
844 }, | |
845 "type": "array" | |
846 }, | |
847 "tokens": { | |
848 "description": "Tokens, along with their syntactic informati
on, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.F
eatures.extract_syntax.", | |
849 "items": { | |
850 "$ref": "Token" | |
851 }, | |
852 "type": "array" | |
853 }, | |
854 "entities": { | |
855 "description": "Entities, along with their semantic informat
ion, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.
Features.extract_entities.", | |
856 "items": { | |
857 "$ref": "Entity" | |
858 }, | |
859 "type": "array" | |
860 }, | |
861 "documentSentiment": { | |
862 "$ref": "Sentiment", | |
863 "description": "The overall sentiment for the document. Popu
lated if the user enables\nAnnotateTextRequest.Features.extract_document_sentime
nt." | |
864 } | 1084 } |
865 }, | 1085 }, |
866 "type": "object" | |
867 }, | |
868 "DependencyEdge": { | |
869 "description": "Represents dependency parse tree information for a t
oken.", | |
870 "id": "DependencyEdge", | |
871 "properties": { | |
872 "label": { | |
873 "description": "The parse label for the token.", | |
874 "enum": [ | |
875 "UNKNOWN", | |
876 "ABBREV", | |
877 "ACOMP", | |
878 "ADVCL", | |
879 "ADVMOD", | |
880 "AMOD", | |
881 "APPOS", | |
882 "ATTR", | |
883 "AUX", | |
884 "AUXPASS", | |
885 "CC", | |
886 "CCOMP", | |
887 "CONJ", | |
888 "CSUBJ", | |
889 "CSUBJPASS", | |
890 "DEP", | |
891 "DET", | |
892 "DISCOURSE", | |
893 "DOBJ", | |
894 "EXPL", | |
895 "GOESWITH", | |
896 "IOBJ", | |
897 "MARK", | |
898 "MWE", | |
899 "MWV", | |
900 "NEG", | |
901 "NN", | |
902 "NPADVMOD", | |
903 "NSUBJ", | |
904 "NSUBJPASS", | |
905 "NUM", | |
906 "NUMBER", | |
907 "P", | |
908 "PARATAXIS", | |
909 "PARTMOD", | |
910 "PCOMP", | |
911 "POBJ", | |
912 "POSS", | |
913 "POSTNEG", | |
914 "PRECOMP", | |
915 "PRECONJ", | |
916 "PREDET", | |
917 "PREF", | |
918 "PREP", | |
919 "PRONL", | |
920 "PRT", | |
921 "PS", | |
922 "QUANTMOD", | |
923 "RCMOD", | |
924 "RCMODREL", | |
925 "RDROP", | |
926 "REF", | |
927 "REMNANT", | |
928 "REPARANDUM", | |
929 "ROOT", | |
930 "SNUM", | |
931 "SUFF", | |
932 "TMOD", | |
933 "TOPIC", | |
934 "VMOD", | |
935 "VOCATIVE", | |
936 "XCOMP", | |
937 "SUFFIX", | |
938 "TITLE", | |
939 "ADVPHMOD", | |
940 "AUXCAUS", | |
941 "AUXVV", | |
942 "DTMOD", | |
943 "FOREIGN", | |
944 "KW", | |
945 "LIST", | |
946 "NOMC", | |
947 "NOMCSUBJ", | |
948 "NOMCSUBJPASS", | |
949 "NUMC", | |
950 "COP", | |
951 "DISLOCATED" | |
952 ], | |
953 "enumDescriptions": [ | |
954 "Unknown", | |
955 "Abbreviation modifier", | |
956 "Adjectival complement", | |
957 "Adverbial clause modifier", | |
958 "Adverbial modifier", | |
959 "Adjectival modifier of an NP", | |
960 "Appositional modifier of an NP", | |
961 "Attribute dependent of a copular verb", | |
962 "Auxiliary (non-main) verb", | |
963 "Passive auxiliary", | |
964 "Coordinating conjunction", | |
965 "Clausal complement of a verb or adjective", | |
966 "Conjunct", | |
967 "Clausal subject", | |
968 "Clausal passive subject", | |
969 "Dependency (unable to determine)", | |
970 "Determiner", | |
971 "Discourse", | |
972 "Direct object", | |
973 "Expletive", | |
974 "Goes with (part of a word in a text not well edited)", | |
975 "Indirect object", | |
976 "Marker (word introducing a subordinate clause)", | |
977 "Multi-word expression", | |
978 "Multi-word verbal expression", | |
979 "Negation modifier", | |
980 "Noun compound modifier", | |
981 "Noun phrase used as an adverbial modifier", | |
982 "Nominal subject", | |
983 "Passive nominal subject", | |
984 "Numeric modifier of a noun", | |
985 "Element of compound number", | |
986 "Punctuation mark", | |
987 "Parataxis relation", | |
988 "Participial modifier", | |
989 "The complement of a preposition is a clause", | |
990 "Object of a preposition", | |
991 "Possession modifier", | |
992 "Postverbal negative particle", | |
993 "Predicate complement", | |
994 "Preconjunt", | |
995 "Predeterminer", | |
996 "Prefix", | |
997 "Prepositional modifier", | |
998 "The relationship between a verb and verbal morpheme", | |
999 "Particle", | |
1000 "Associative or possessive marker", | |
1001 "Quantifier phrase modifier", | |
1002 "Relative clause modifier", | |
1003 "Complementizer in relative clause", | |
1004 "Ellipsis without a preceding predicate", | |
1005 "Referent", | |
1006 "Remnant", | |
1007 "Reparandum", | |
1008 "Root", | |
1009 "Suffix specifying a unit of number", | |
1010 "Suffix", | |
1011 "Temporal modifier", | |
1012 "Topic marker", | |
1013 "Clause headed by an infinite form of the verb that modi
fies a noun", | |
1014 "Vocative", | |
1015 "Open clausal complement", | |
1016 "Name suffix", | |
1017 "Name title", | |
1018 "Adverbial phrase modifier", | |
1019 "Causative auxiliary", | |
1020 "Helper auxiliary", | |
1021 "Rentaishi (Prenominal modifier)", | |
1022 "Foreign words", | |
1023 "Keyword", | |
1024 "List for chains of comparable items", | |
1025 "Nominalized clause", | |
1026 "Nominalized clausal subject", | |
1027 "Nominalized clausal passive", | |
1028 "Compound of numeric modifier", | |
1029 "Copula", | |
1030 "Dislocated relation (for fronted/topicalized elements)" | |
1031 ], | |
1032 "type": "string" | |
1033 }, | |
1034 "headTokenIndex": { | |
1035 "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.", | |
1036 "format": "int32", | |
1037 "type": "integer" | |
1038 } | |
1039 }, | |
1040 "type": "object" | |
1041 }, | |
1042 "TextSpan": { | |
1043 "description": "Represents an output piece of text.", | |
1044 "id": "TextSpan", | |
1045 "properties": { | |
1046 "beginOffset": { | |
1047 "description": "The API calculates the beginning offset of t
he content in the original\ndocument according to the EncodingType specified in
the API request.", | |
1048 "format": "int32", | |
1049 "type": "integer" | |
1050 }, | |
1051 "content": { | |
1052 "description": "The content of the output text.", | |
1053 "type": "string" | |
1054 } | |
1055 }, | |
1056 "type": "object" | |
1057 }, | |
1058 "Token": { | |
1059 "description": "Represents the smallest syntactic building block of
the text.", | |
1060 "id": "Token", | |
1061 "properties": { | |
1062 "partOfSpeech": { | |
1063 "$ref": "PartOfSpeech", | |
1064 "description": "Parts of speech tag for this token." | |
1065 }, | |
1066 "text": { | |
1067 "$ref": "TextSpan", | |
1068 "description": "The token text." | |
1069 }, | |
1070 "dependencyEdge": { | |
1071 "$ref": "DependencyEdge", | |
1072 "description": "Dependency tree parse for this token." | |
1073 }, | |
1074 "lemma": { | |
1075 "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_
%28morphology%29) of the token.", | |
1076 "type": "string" | |
1077 } | |
1078 }, | |
1079 "type": "object" | 1086 "type": "object" |
1080 } | 1087 } |
1081 }, | 1088 }, |
1082 "servicePath": "", | 1089 "servicePath": "", |
1083 "title": "Google Cloud Natural Language API", | 1090 "title": "Google Cloud Natural Language API", |
1084 "version": "v1beta1" | 1091 "version": "v1beta1" |
1085 } | 1092 } |
OLD | NEW |