Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / language_v1.documents.html
blob: a43da71f446c9bbf0fb63d8af39091b123823b41 [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="language_v1.html">Cloud Natural Language API</a> . <a href="language_v1.documents.html">documents</a></h1>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]79<p class="firstline">Finds named entities (currently proper names and common nouns) in the text</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Finds entities, similar to AnalyzeEntities in the text and analyzes</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Analyzes the sentiment of the provided text.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88<p class="firstline">Analyzes the syntax of the text and provides sentence boundaries and</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#annotateText">annotateText(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]91<p class="firstline">A convenience method that provides all the features that analyzeSentiment,</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#classifyText">classifyText(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Classifies a document into categories.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 <code class="details" id="analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]98 <pre>Finds named entities (currently proper names and common nouns) in the text
99along with entity types, salience, mentions for each entity, and
100other properties.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]101
102Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]104 The object takes the form of:
105
106{ # The entity analysis request message.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]107 "encodingType": "A String", # The encoding type used by the API to calculate offsets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 "document": { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]109 #
110 # Represents the input to API methods.
111 "content": "A String", # The content of the input in string format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
114 # returns an `INVALID_ARGUMENT` error.
115 "language": "A String", # The language of the document (if not specified, the language is
116 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 # accepted.&lt;br&gt;
118 # [Language
119 # Support](https://cloud.google.com/natural-language/docs/languages) lists
120 # currently supported languages for each API method. If the language (either
121 # specified by the caller or automatically detected) is not supported by the
122 # called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]123 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
124 # This URI must be of the form: gs://bucket_name/object_name. For more
125 # details, see https://cloud.google.com/storage/docs/reference-uris.
126 # NOTE: Cloud Storage object versioning is not supported.
127 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]128 }
129
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 { # The entity analysis response message.
139 "entities": [ # The recognized entities in the input document.
140 { # Represents a phrase in the text that is a known entity, such as
141 # a person, an organization, or location. The API associates information, such
142 # as salience and mentions, with entities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 "name": "A String", # The representative name for the entity.
144 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
145 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
146 # true, this field will contain the aggregate sentiment expressed for this
147 # entity in the provided document.
148 # the text.
149 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
150 # (positive sentiment).
151 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
152 # the absolute magnitude of sentiment regardless of score (positive or
153 # negative).
154 },
155 "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
156 #
157 # The salience score for an entity provides information about the
158 # importance or centrality of that entity to the entire document text.
159 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
160 # salient.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]161 "mentions": [ # The mentions of this entity in the input document. The API currently
162 # supports proper noun mentions.
163 { # Represents a mention for an entity in the text. Currently, proper noun
164 # mentions are supported.
165 "text": { # Represents an output piece of text. # The mention text.
166 "content": "A String", # The content of the output text.
167 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
168 # document according to the EncodingType specified in the API request.
169 },
170 "type": "A String", # The type of the entity mention.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
172 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
173 # true, this field will contain the sentiment expressed for this mention of
174 # the entity in the provided document.
175 # the text.
176 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
177 # (positive sentiment).
178 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
179 # the absolute magnitude of sentiment regardless of score (positive or
180 # negative).
181 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]182 },
183 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "type": "A String", # The entity type.
185 "metadata": { # Metadata associated with the entity.
186 #
187 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
188 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
189 # associated with other entity types, see the Type table below.
190 "a_key": "A String",
191 },
192 },
193 ],
194 "language": "A String", # The language of the text, which will be the same as the language specified
195 # in the request or, if not specified, the automatically-detected language.
196 # See Document.language field for more details.
197 }</pre>
198</div>
199
200<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 <code class="details" id="analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 <pre>Finds entities, similar to AnalyzeEntities in the text and analyzes
203sentiment associated with each entity and its mentions.
204
205Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]206 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 The object takes the form of:
208
209{ # The entity-level sentiment analysis request message.
210 "encodingType": "A String", # The encoding type used by the API to calculate offsets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 "document": { # ################################################################ # # Required. Input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 #
213 # Represents the input to API methods.
214 "content": "A String", # The content of the input in string format.
215 # Cloud audit logging exempt since it is based on user data.
216 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
217 # returns an `INVALID_ARGUMENT` error.
218 "language": "A String", # The language of the document (if not specified, the language is
219 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 # accepted.&lt;br&gt;
221 # [Language
222 # Support](https://cloud.google.com/natural-language/docs/languages) lists
223 # currently supported languages for each API method. If the language (either
224 # specified by the caller or automatically detected) is not supported by the
225 # called API method, an `INVALID_ARGUMENT` error is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
227 # This URI must be of the form: gs://bucket_name/object_name. For more
228 # details, see https://cloud.google.com/storage/docs/reference-uris.
229 # NOTE: Cloud Storage object versioning is not supported.
230 },
231 }
232
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238Returns:
239 An object of the form:
240
241 { # The entity-level sentiment analysis response message.
242 "entities": [ # The recognized entities in the input document with associated sentiments.
243 { # Represents a phrase in the text that is a known entity, such as
244 # a person, an organization, or location. The API associates information, such
245 # as salience and mentions, with entities.
246 "name": "A String", # The representative name for the entity.
247 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
248 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
249 # true, this field will contain the aggregate sentiment expressed for this
250 # entity in the provided document.
251 # the text.
252 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
253 # (positive sentiment).
254 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
255 # the absolute magnitude of sentiment regardless of score (positive or
256 # negative).
257 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]258 "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
259 #
260 # The salience score for an entity provides information about the
261 # importance or centrality of that entity to the entire document text.
262 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
263 # salient.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "mentions": [ # The mentions of this entity in the input document. The API currently
265 # supports proper noun mentions.
266 { # Represents a mention for an entity in the text. Currently, proper noun
267 # mentions are supported.
268 "text": { # Represents an output piece of text. # The mention text.
269 "content": "A String", # The content of the output text.
270 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
271 # document according to the EncodingType specified in the API request.
272 },
273 "type": "A String", # The type of the entity mention.
274 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
275 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
276 # true, this field will contain the sentiment expressed for this mention of
277 # the entity in the provided document.
278 # the text.
279 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
280 # (positive sentiment).
281 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
282 # the absolute magnitude of sentiment regardless of score (positive or
283 # negative).
284 },
285 },
286 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]287 "type": "A String", # The entity type.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]288 "metadata": { # Metadata associated with the entity.
289 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
291 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
292 # associated with other entity types, see the Type table below.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]293 "a_key": "A String",
294 },
295 },
296 ],
297 "language": "A String", # The language of the text, which will be the same as the language specified
298 # in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]299 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]300 }</pre>
301</div>
302
303<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 <code class="details" id="analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]305 <pre>Analyzes the sentiment of the provided text.
306
307Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]308 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]309 The object takes the form of:
310
311{ # The sentiment analysis request message.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets.
313 "document": { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]314 #
315 # Represents the input to API methods.
316 "content": "A String", # The content of the input in string format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]318 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
319 # returns an `INVALID_ARGUMENT` error.
320 "language": "A String", # The language of the document (if not specified, the language is
321 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]322 # accepted.&lt;br&gt;
323 # [Language
324 # Support](https://cloud.google.com/natural-language/docs/languages) lists
325 # currently supported languages for each API method. If the language (either
326 # specified by the caller or automatically detected) is not supported by the
327 # called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]328 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
329 # This URI must be of the form: gs://bucket_name/object_name. For more
330 # details, see https://cloud.google.com/storage/docs/reference-uris.
331 # NOTE: Cloud Storage object versioning is not supported.
332 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]333 }
334
335 x__xgafv: string, V1 error format.
336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
339
340Returns:
341 An object of the form:
342
343 { # The sentiment analysis response message.
344 "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
345 # the text.
346 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
347 # (positive sentiment).
348 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
349 # the absolute magnitude of sentiment regardless of score (positive or
350 # negative).
351 },
352 "language": "A String", # The language of the text, which will be the same as the language specified
353 # in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]354 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]355 "sentences": [ # The sentiment for all the sentences in the document.
356 { # Represents a sentence in the input document.
357 "text": { # Represents an output piece of text. # The sentence text.
358 "content": "A String", # The content of the output text.
359 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
360 # document according to the EncodingType specified in the API request.
361 },
362 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
363 # AnnotateTextRequest.Features.extract_document_sentiment is set to
364 # true, this field will contain the sentiment for the sentence.
365 # the text.
366 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
367 # (positive sentiment).
368 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
369 # the absolute magnitude of sentiment regardless of score (positive or
370 # negative).
371 },
372 },
373 ],
374 }</pre>
375</div>
376
377<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]378 <code class="details" id="analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]379 <pre>Analyzes the syntax of the text and provides sentence boundaries and
380tokenization along with part of speech tags, dependency trees, and other
381properties.
382
383Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]385 The object takes the form of:
386
387{ # The syntax analysis request message.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]388 "encodingType": "A String", # The encoding type used by the API to calculate offsets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "document": { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]390 #
391 # Represents the input to API methods.
392 "content": "A String", # The content of the input in string format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]394 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
395 # returns an `INVALID_ARGUMENT` error.
396 "language": "A String", # The language of the document (if not specified, the language is
397 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 # accepted.&lt;br&gt;
399 # [Language
400 # Support](https://cloud.google.com/natural-language/docs/languages) lists
401 # currently supported languages for each API method. If the language (either
402 # specified by the caller or automatically detected) is not supported by the
403 # called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]404 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
405 # This URI must be of the form: gs://bucket_name/object_name. For more
406 # details, see https://cloud.google.com/storage/docs/reference-uris.
407 # NOTE: Cloud Storage object versioning is not supported.
408 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]409 }
410
411 x__xgafv: string, V1 error format.
412 Allowed values
413 1 - v1 error format
414 2 - v2 error format
415
416Returns:
417 An object of the form:
418
419 { # The syntax analysis response message.
420 "tokens": [ # Tokens, along with their syntactic information, in the input document.
421 { # Represents the smallest syntactic building block of the text.
422 "text": { # Represents an output piece of text. # The token text.
423 "content": "A String", # The content of the output text.
424 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
425 # document according to the EncodingType specified in the API request.
426 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]427 "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
428 # are as defined in
429 # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
430 "case": "A String", # The grammatical case.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 "aspect": "A String", # The grammatical aspect.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]432 "form": "A String", # The grammatical form.
433 "gender": "A String", # The grammatical gender.
434 "number": "A String", # The grammatical number.
435 "person": "A String", # The grammatical person.
436 "tag": "A String", # The part of speech tag.
437 "tense": "A String", # The grammatical tense.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 "reciprocity": "A String", # The grammatical reciprocity.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]439 "proper": "A String", # The grammatical properness.
440 "voice": "A String", # The grammatical voice.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 "mood": "A String", # The grammatical mood.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]442 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]443 "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
444 # information on dependency labels, see
445 # http://www.aclweb.org/anthology/P13-2017
446 "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
447 # This is the index of the token which has an arc going to this token.
448 # The index is the position of the token in the array of tokens returned
449 # by the API method. If this token is a root token, then the
450 # `head_token_index` is its own index.
451 "label": "A String", # The parse label for the token.
452 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]453 "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
454 },
455 ],
456 "language": "A String", # The language of the text, which will be the same as the language specified
457 # in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]458 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]459 "sentences": [ # Sentences in the input document.
460 { # Represents a sentence in the input document.
461 "text": { # Represents an output piece of text. # The sentence text.
462 "content": "A String", # The content of the output text.
463 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
464 # document according to the EncodingType specified in the API request.
465 },
466 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
467 # AnnotateTextRequest.Features.extract_document_sentiment is set to
468 # true, this field will contain the sentiment for the sentence.
469 # the text.
470 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
471 # (positive sentiment).
472 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
473 # the absolute magnitude of sentiment regardless of score (positive or
474 # negative).
475 },
476 },
477 ],
478 }</pre>
479</div>
480
481<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 <code class="details" id="annotateText">annotateText(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]483 <pre>A convenience method that provides all the features that analyzeSentiment,
484analyzeEntities, and analyzeSyntax provide in one call.
485
486Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]488 The object takes the form of:
489
490{ # The request message for the text annotation API, which can perform multiple
491 # analysis types (sentiment, entities, and syntax) in one call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]492 "encodingType": "A String", # The encoding type used by the API to calculate offsets.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]493 "document": { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]494 #
495 # Represents the input to API methods.
496 "content": "A String", # The content of the input in string format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]498 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
499 # returns an `INVALID_ARGUMENT` error.
500 "language": "A String", # The language of the document (if not specified, the language is
501 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]502 # accepted.&lt;br&gt;
503 # [Language
504 # Support](https://cloud.google.com/natural-language/docs/languages) lists
505 # currently supported languages for each API method. If the language (either
506 # specified by the caller or automatically detected) is not supported by the
507 # called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]508 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
509 # This URI must be of the form: gs://bucket_name/object_name. For more
510 # details, see https://cloud.google.com/storage/docs/reference-uris.
511 # NOTE: Cloud Storage object versioning is not supported.
512 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]513 "features": { # All available features for sentiment, syntax, and semantic analysis. # Required. The enabled features.
514 # Setting each one to true will enable that specific analysis for the input.
515 "extractDocumentSentiment": True or False, # Extract document-level sentiment.
516 "extractEntitySentiment": True or False, # Extract entities and their associated sentiment.
517 "extractSyntax": True or False, # Extract syntax information.
518 "extractEntities": True or False, # Extract entities.
519 "classifyText": True or False, # Classify the full document into categories.
520 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]521 }
522
523 x__xgafv: string, V1 error format.
524 Allowed values
525 1 - v1 error format
526 2 - v2 error format
527
528Returns:
529 An object of the form:
530
531 { # The text annotations response message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 "language": "A String", # The language of the text, which will be the same as the language specified
533 # in the request or, if not specified, the automatically-detected language.
534 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]535 "tokens": [ # Tokens, along with their syntactic information, in the input document.
536 # Populated if the user enables
537 # AnnotateTextRequest.Features.extract_syntax.
538 { # Represents the smallest syntactic building block of the text.
539 "text": { # Represents an output piece of text. # The token text.
540 "content": "A String", # The content of the output text.
541 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
542 # document according to the EncodingType specified in the API request.
543 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]544 "partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
545 # are as defined in
546 # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
547 "case": "A String", # The grammatical case.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]548 "aspect": "A String", # The grammatical aspect.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]549 "form": "A String", # The grammatical form.
550 "gender": "A String", # The grammatical gender.
551 "number": "A String", # The grammatical number.
552 "person": "A String", # The grammatical person.
553 "tag": "A String", # The part of speech tag.
554 "tense": "A String", # The grammatical tense.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555 "reciprocity": "A String", # The grammatical reciprocity.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]556 "proper": "A String", # The grammatical properness.
557 "voice": "A String", # The grammatical voice.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]558 "mood": "A String", # The grammatical mood.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]559 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]560 "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
561 # information on dependency labels, see
562 # http://www.aclweb.org/anthology/P13-2017
563 "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
564 # This is the index of the token which has an arc going to this token.
565 # The index is the position of the token in the array of tokens returned
566 # by the API method. If this token is a root token, then the
567 # `head_token_index` is its own index.
568 "label": "A String", # The parse label for the token.
569 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]570 "lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
571 },
572 ],
573 "entities": [ # Entities, along with their semantic information, in the input document.
574 # Populated if the user enables
575 # AnnotateTextRequest.Features.extract_entities.
576 { # Represents a phrase in the text that is a known entity, such as
577 # a person, an organization, or location. The API associates information, such
578 # as salience and mentions, with entities.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]579 "name": "A String", # The representative name for the entity.
580 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
581 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
582 # true, this field will contain the aggregate sentiment expressed for this
583 # entity in the provided document.
584 # the text.
585 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
586 # (positive sentiment).
587 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
588 # the absolute magnitude of sentiment regardless of score (positive or
589 # negative).
590 },
591 "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
592 #
593 # The salience score for an entity provides information about the
594 # importance or centrality of that entity to the entire document text.
595 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
596 # salient.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]597 "mentions": [ # The mentions of this entity in the input document. The API currently
598 # supports proper noun mentions.
599 { # Represents a mention for an entity in the text. Currently, proper noun
600 # mentions are supported.
601 "text": { # Represents an output piece of text. # The mention text.
602 "content": "A String", # The content of the output text.
603 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
604 # document according to the EncodingType specified in the API request.
605 },
606 "type": "A String", # The type of the entity mention.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]607 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
608 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
609 # true, this field will contain the sentiment expressed for this mention of
610 # the entity in the provided document.
611 # the text.
612 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
613 # (positive sentiment).
614 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
615 # the absolute magnitude of sentiment regardless of score (positive or
616 # negative).
617 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]618 },
619 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]620 "type": "A String", # The entity type.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]621 "metadata": { # Metadata associated with the entity.
622 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
624 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
625 # associated with other entity types, see the Type table below.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]626 "a_key": "A String",
627 },
628 },
629 ],
630 "documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
631 # AnnotateTextRequest.Features.extract_document_sentiment.
632 # the text.
633 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
634 # (positive sentiment).
635 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
636 # the absolute magnitude of sentiment regardless of score (positive or
637 # negative).
638 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]639 "sentences": [ # Sentences in the input document. Populated if the user enables
640 # AnnotateTextRequest.Features.extract_syntax.
641 { # Represents a sentence in the input document.
642 "text": { # Represents an output piece of text. # The sentence text.
643 "content": "A String", # The content of the output text.
644 "beginOffset": 42, # The API calculates the beginning offset of the content in the original
645 # document according to the EncodingType specified in the API request.
646 },
647 "sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
648 # AnnotateTextRequest.Features.extract_document_sentiment is set to
649 # true, this field will contain the sentiment for the sentence.
650 # the text.
651 "score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
652 # (positive sentiment).
653 "magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
654 # the absolute magnitude of sentiment regardless of score (positive or
655 # negative).
656 },
657 },
658 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]659 "categories": [ # Categories identified in the input document.
660 { # Represents a category returned from the text classifier.
661 "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
662 # the classifier is that this category represents the given text.
663 "name": "A String", # The name of the category representing the document, from the [predefined
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]664 # taxonomy](https://cloud.google.com/natural-language/docs/categories).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]665 },
666 ],
667 }</pre>
668</div>
669
670<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]671 <code class="details" id="classifyText">classifyText(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]672 <pre>Classifies a document into categories.
673
674Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 The object takes the form of:
677
678{ # The document classification request message.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]679 "document": { # ################################################################ # # Required. Input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]680 #
681 # Represents the input to API methods.
682 "content": "A String", # The content of the input in string format.
683 # Cloud audit logging exempt since it is based on user data.
684 "type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
685 # returns an `INVALID_ARGUMENT` error.
686 "language": "A String", # The language of the document (if not specified, the language is
687 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]688 # accepted.&lt;br&gt;
689 # [Language
690 # Support](https://cloud.google.com/natural-language/docs/languages) lists
691 # currently supported languages for each API method. If the language (either
692 # specified by the caller or automatically detected) is not supported by the
693 # called API method, an `INVALID_ARGUMENT` error is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 "gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
695 # This URI must be of the form: gs://bucket_name/object_name. For more
696 # details, see https://cloud.google.com/storage/docs/reference-uris.
697 # NOTE: Cloud Storage object versioning is not supported.
698 },
699 }
700
701 x__xgafv: string, V1 error format.
702 Allowed values
703 1 - v1 error format
704 2 - v2 error format
705
706Returns:
707 An object of the form:
708
709 { # The document classification response message.
710 "categories": [ # Categories representing the input document.
711 { # Represents a category returned from the text classifier.
712 "confidence": 3.14, # The classifier's confidence of the category. Number represents how certain
713 # the classifier is that this category represents the given text.
714 "name": "A String", # The name of the category representing the document, from the [predefined
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 # taxonomy](https://cloud.google.com/natural-language/docs/categories).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 },
717 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]718 }</pre>
719</div>
720
721</body></html>