blob: 05d96ec28b1e26723933e82d9ad88963f56b35bb [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001<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 -070075<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 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070079<p class="firstline">Finds named entities (currently proper names and common nouns) in the text</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<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 -070084 <code><a href="#analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080085<p class="firstline">Analyzes the sentiment of the provided text.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080088<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 -070090 <code><a href="#annotateText">annotateText(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080091<p class="firstline">A convenience method that provides all the features that analyzeSentiment,</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#classifyText">classifyText(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Classifies a document into categories.</p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080095<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070098 <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 -0800101
102Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800104 The object takes the form of:
105
106{ # The entity analysis request message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate offsets.
108 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800109 #
110 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
112 # This URI must be of the form: gs://bucket_name/object_name. For more
113 # details, see https://cloud.google.com/storage/docs/reference-uris.
114 # NOTE: Cloud Storage object versioning is not supported.
115 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800116 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
124 # returns an `INVALID_ARGUMENT` error.
125 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
126 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800127 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800128 }
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
140 # in the request or, if not specified, the automatically-detected language.
141 # See Document.language field for more details.
142 &quot;entities&quot;: [ # The recognized entities in the input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800143 { # Represents a phrase in the text that is a known entity, such as
144 # a person, an organization, or location. The API associates information, such
145 # as salience and mentions, with entities.
Bu Sun Kim65020912020-05-20 12:08:20 -0700146 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800147 # supports proper noun mentions.
148 { # Represents a mention for an entity in the text. Currently, proper noun
149 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
151 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800152 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700153 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800154 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
156 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
158 # true, this field will contain the sentiment expressed for this mention of
159 # the entity in the provided document.
160 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 # (positive sentiment).
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700164 # the absolute magnitude of sentiment regardless of score (positive or
165 # negative).
166 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800167 },
168 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
170 &quot;type&quot;: &quot;A String&quot;, # The entity type.
171 &quot;metadata&quot;: { # Metadata associated with the entity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172 #
173 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
174 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
175 # associated with other entity types, see the Type table below.
Bu Sun Kim65020912020-05-20 12:08:20 -0700176 &quot;a_key&quot;: &quot;A String&quot;,
177 },
178 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
179 #
180 # The salience score for an entity provides information about the
181 # importance or centrality of that entity to the entire document text.
182 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
183 # salient.
184 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
185 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
186 # true, this field will contain the aggregate sentiment expressed for this
187 # entity in the provided document.
188 # the text.
189 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
190 # (positive sentiment).
191 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
192 # the absolute magnitude of sentiment regardless of score (positive or
193 # negative).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 },
195 },
196 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700197 }</pre>
198</div>
199
200<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700201 <code class="details" id="analyzeEntitySentiment">analyzeEntitySentiment(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700202 <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 -0700206 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700207 The object takes the form of:
208
209{ # The entity-level sentiment analysis request message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate offsets.
211 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700212 #
213 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
215 # This URI must be of the form: gs://bucket_name/object_name. For more
216 # details, see https://cloud.google.com/storage/docs/reference-uris.
217 # NOTE: Cloud Storage object versioning is not supported.
218 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700219 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700220 # 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 Kim65020912020-05-20 12:08:20 -0700226 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
227 # returns an `INVALID_ARGUMENT` error.
228 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
229 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230 },
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700242 &quot;entities&quot;: [ # The recognized entities in the input document with associated sentiments.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700246 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700247 # supports proper noun mentions.
248 { # Represents a mention for an entity in the text. Currently, proper noun
249 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700250 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
251 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700252 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
256 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700257 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
258 # true, this field will contain the sentiment expressed for this mention of
259 # the entity in the provided document.
260 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700262 # (positive sentiment).
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 # the absolute magnitude of sentiment regardless of score (positive or
265 # negative).
266 },
267 },
268 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700269 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
270 &quot;type&quot;: &quot;A String&quot;, # The entity type.
271 &quot;metadata&quot;: { # Metadata associated with the entity.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800272 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700273 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
274 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
275 # associated with other entity types, see the Type table below.
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 &quot;a_key&quot;: &quot;A String&quot;,
277 },
278 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
279 #
280 # The salience score for an entity provides information about the
281 # importance or centrality of that entity to the entire document text.
282 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
283 # salient.
284 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
285 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
286 # true, this field will contain the aggregate sentiment expressed for this
287 # entity in the provided document.
288 # the text.
289 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
290 # (positive sentiment).
291 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
292 # the absolute magnitude of sentiment regardless of score (positive or
293 # negative).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800294 },
295 },
296 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700297 &quot;language&quot;: &quot;A String&quot;, # 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.
299 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800300 }</pre>
301</div>
302
303<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700304 <code class="details" id="analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800305 <pre>Analyzes the sentiment of the provided text.
306
307Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700308 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800309 The object takes the form of:
310
311{ # The sentiment analysis request message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700312 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate sentence offsets.
313 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800314 #
315 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700316 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
317 # This URI must be of the form: gs://bucket_name/object_name. For more
318 # details, see https://cloud.google.com/storage/docs/reference-uris.
319 # NOTE: Cloud Storage object versioning is not supported.
320 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800321 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700322 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700328 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
329 # returns an `INVALID_ARGUMENT` error.
330 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
331 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800332 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800333 }
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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700344 &quot;sentences&quot;: [ # The sentiment for all the sentences in the document.
345 { # Represents a sentence in the input document.
346 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
347 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
348 # document according to the EncodingType specified in the API request.
349 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
350 },
351 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
352 # AnnotateTextRequest.Features.extract_document_sentiment is set to
353 # true, this field will contain the sentiment for the sentence.
354 # the text.
355 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
356 # (positive sentiment).
357 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
358 # the absolute magnitude of sentiment regardless of score (positive or
359 # negative).
360 },
361 },
362 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700363 &quot;documentSentiment&quot;: { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800364 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700365 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800366 # (positive sentiment).
Bu Sun Kim65020912020-05-20 12:08:20 -0700367 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800368 # the absolute magnitude of sentiment regardless of score (positive or
369 # negative).
370 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700371 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800372 # in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400373 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800374 }</pre>
375</div>
376
377<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700378 <code class="details" id="analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800379 <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 -0700384 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800385 The object takes the form of:
386
387{ # The syntax analysis request message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700388 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate offsets.
389 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800390 #
391 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700392 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
393 # This URI must be of the form: gs://bucket_name/object_name. For more
394 # details, see https://cloud.google.com/storage/docs/reference-uris.
395 # NOTE: Cloud Storage object versioning is not supported.
396 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800397 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700398 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700404 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
405 # returns an `INVALID_ARGUMENT` error.
406 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
407 # Cloud audit logging exempt since it is based on user data.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800408 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800409 }
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700420 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
421 # in the request or, if not specified, the automatically-detected language.
422 # See Document.language field for more details.
423 &quot;sentences&quot;: [ # Sentences in the input document.
424 { # Represents a sentence in the input document.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700425 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
426 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
427 # document according to the EncodingType specified in the API request.
428 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
429 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700430 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
431 # AnnotateTextRequest.Features.extract_document_sentiment is set to
432 # true, this field will contain the sentiment for the sentence.
433 # the text.
434 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
435 # (positive sentiment).
436 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
437 # the absolute magnitude of sentiment regardless of score (positive or
438 # negative).
439 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700440 },
441 ],
442 &quot;tokens&quot;: [ # Tokens, along with their syntactic information, in the input document.
443 { # Represents the smallest syntactic building block of the text.
444 &quot;text&quot;: { # Represents an output piece of text. # The token text.
445 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
446 # document according to the EncodingType specified in the API request.
447 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Thomas Coffee2f245372017-03-27 10:39:26 -0700448 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700449 &quot;dependencyEdge&quot;: { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 # information on dependency labels, see
451 # http://www.aclweb.org/anthology/P13-2017
Bu Sun Kim65020912020-05-20 12:08:20 -0700452 &quot;headTokenIndex&quot;: 42, # Represents the head of this token in the dependency tree.
Dan O'Mearadd494642020-05-01 07:42:23 -0700453 # This is the index of the token which has an arc going to this token.
454 # The index is the position of the token in the array of tokens returned
455 # by the API method. If this token is a root token, then the
456 # `head_token_index` is its own index.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700457 &quot;label&quot;: &quot;A String&quot;, # The parse label for the token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700458 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700459 &quot;lemma&quot;: &quot;A String&quot;, # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
460 &quot;partOfSpeech&quot;: { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
461 # are as defined in
462 # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
Bu Sun Kim65020912020-05-20 12:08:20 -0700463 &quot;form&quot;: &quot;A String&quot;, # The grammatical form.
464 &quot;number&quot;: &quot;A String&quot;, # The grammatical number.
465 &quot;voice&quot;: &quot;A String&quot;, # The grammatical voice.
466 &quot;aspect&quot;: &quot;A String&quot;, # The grammatical aspect.
467 &quot;mood&quot;: &quot;A String&quot;, # The grammatical mood.
468 &quot;tag&quot;: &quot;A String&quot;, # The part of speech tag.
469 &quot;gender&quot;: &quot;A String&quot;, # The grammatical gender.
470 &quot;person&quot;: &quot;A String&quot;, # The grammatical person.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700471 &quot;proper&quot;: &quot;A String&quot;, # The grammatical properness.
472 &quot;case&quot;: &quot;A String&quot;, # The grammatical case.
473 &quot;tense&quot;: &quot;A String&quot;, # The grammatical tense.
474 &quot;reciprocity&quot;: &quot;A String&quot;, # The grammatical reciprocity.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800475 },
476 },
477 ],
478 }</pre>
479</div>
480
481<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700482 <code class="details" id="annotateText">annotateText(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800483 <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 -0700487 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800488 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700492 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate offsets.
493 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800494 #
495 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700496 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
497 # This URI must be of the form: gs://bucket_name/object_name. For more
498 # details, see https://cloud.google.com/storage/docs/reference-uris.
499 # NOTE: Cloud Storage object versioning is not supported.
500 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800501 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700502 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700508 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
509 # returns an `INVALID_ARGUMENT` error.
510 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
511 # Cloud audit logging exempt since it is based on user data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700512 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700513 &quot;features&quot;: { # 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 &quot;classifyText&quot;: True or False, # Classify the full document into categories.
516 &quot;extractSyntax&quot;: True or False, # Extract syntax information.
517 &quot;extractDocumentSentiment&quot;: True or False, # Extract document-level sentiment.
518 &quot;extractEntitySentiment&quot;: True or False, # Extract entities and their associated sentiment.
519 &quot;extractEntities&quot;: True or False, # Extract entities.
520 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800521 }
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 Kim4ed7d3f2020-05-27 12:20:54 -0700532 &quot;sentences&quot;: [ # Sentences in the input document. Populated if the user enables
533 # AnnotateTextRequest.Features.extract_syntax.
534 { # Represents a sentence in the input document.
535 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
536 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
537 # document according to the EncodingType specified in the API request.
538 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
539 },
540 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
541 # AnnotateTextRequest.Features.extract_document_sentiment is set to
542 # true, this field will contain the sentiment for the sentence.
543 # the text.
544 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
545 # (positive sentiment).
546 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
547 # the absolute magnitude of sentiment regardless of score (positive or
548 # negative).
549 },
550 },
551 ],
552 &quot;tokens&quot;: [ # Tokens, along with their syntactic information, in the input document.
553 # Populated if the user enables
554 # AnnotateTextRequest.Features.extract_syntax.
555 { # Represents the smallest syntactic building block of the text.
556 &quot;text&quot;: { # Represents an output piece of text. # The token text.
557 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
558 # document according to the EncodingType specified in the API request.
559 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
560 },
561 &quot;dependencyEdge&quot;: { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
562 # information on dependency labels, see
563 # http://www.aclweb.org/anthology/P13-2017
564 &quot;headTokenIndex&quot;: 42, # Represents the head of this token in the dependency tree.
565 # This is the index of the token which has an arc going to this token.
566 # The index is the position of the token in the array of tokens returned
567 # by the API method. If this token is a root token, then the
568 # `head_token_index` is its own index.
569 &quot;label&quot;: &quot;A String&quot;, # The parse label for the token.
570 },
571 &quot;lemma&quot;: &quot;A String&quot;, # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
572 &quot;partOfSpeech&quot;: { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
573 # are as defined in
574 # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
575 &quot;form&quot;: &quot;A String&quot;, # The grammatical form.
576 &quot;number&quot;: &quot;A String&quot;, # The grammatical number.
577 &quot;voice&quot;: &quot;A String&quot;, # The grammatical voice.
578 &quot;aspect&quot;: &quot;A String&quot;, # The grammatical aspect.
579 &quot;mood&quot;: &quot;A String&quot;, # The grammatical mood.
580 &quot;tag&quot;: &quot;A String&quot;, # The part of speech tag.
581 &quot;gender&quot;: &quot;A String&quot;, # The grammatical gender.
582 &quot;person&quot;: &quot;A String&quot;, # The grammatical person.
583 &quot;proper&quot;: &quot;A String&quot;, # The grammatical properness.
584 &quot;case&quot;: &quot;A String&quot;, # The grammatical case.
585 &quot;tense&quot;: &quot;A String&quot;, # The grammatical tense.
586 &quot;reciprocity&quot;: &quot;A String&quot;, # The grammatical reciprocity.
587 },
588 },
589 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700590 &quot;categories&quot;: [ # Categories identified in the input document.
591 { # Represents a category returned from the text classifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700592 &quot;confidence&quot;: 3.14, # The classifier&#x27;s confidence of the category. Number represents how certain
593 # the classifier is that this category represents the given text.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700594 &quot;name&quot;: &quot;A String&quot;, # The name of the category representing the document, from the [predefined
595 # taxonomy](https://cloud.google.com/natural-language/docs/categories).
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800596 },
597 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700598 &quot;documentSentiment&quot;: { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
599 # AnnotateTextRequest.Features.extract_document_sentiment.
600 # the text.
601 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
602 # (positive sentiment).
603 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
604 # the absolute magnitude of sentiment regardless of score (positive or
605 # negative).
606 },
607 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
608 # in the request or, if not specified, the automatically-detected language.
609 # See Document.language field for more details.
610 &quot;entities&quot;: [ # Entities, along with their semantic information, in the input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800611 # Populated if the user enables
612 # AnnotateTextRequest.Features.extract_entities.
613 { # Represents a phrase in the text that is a known entity, such as
614 # a person, an organization, or location. The API associates information, such
615 # as salience and mentions, with entities.
Bu Sun Kim65020912020-05-20 12:08:20 -0700616 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800617 # supports proper noun mentions.
618 { # Represents a mention for an entity in the text. Currently, proper noun
619 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700620 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
621 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800622 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700623 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800624 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700625 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
626 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700627 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
628 # true, this field will contain the sentiment expressed for this mention of
629 # the entity in the provided document.
630 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700631 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700632 # (positive sentiment).
Bu Sun Kim65020912020-05-20 12:08:20 -0700633 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700634 # the absolute magnitude of sentiment regardless of score (positive or
635 # negative).
636 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800637 },
638 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700639 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
640 &quot;type&quot;: &quot;A String&quot;, # The entity type.
641 &quot;metadata&quot;: { # Metadata associated with the entity.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800642 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700643 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
644 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
645 # associated with other entity types, see the Type table below.
Bu Sun Kim65020912020-05-20 12:08:20 -0700646 &quot;a_key&quot;: &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800647 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700648 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
649 #
650 # The salience score for an entity provides information about the
651 # importance or centrality of that entity to the entire document text.
652 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
653 # salient.
654 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
655 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
656 # true, this field will contain the aggregate sentiment expressed for this
657 # entity in the provided document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800658 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700659 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800660 # (positive sentiment).
Bu Sun Kim65020912020-05-20 12:08:20 -0700661 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800662 # the absolute magnitude of sentiment regardless of score (positive or
663 # negative).
664 },
665 },
666 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700667 }</pre>
668</div>
669
670<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700671 <code class="details" id="classifyText">classifyText(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700672 <pre>Classifies a document into categories.
673
674Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700675 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700676 The object takes the form of:
677
678{ # The document classification request message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700679 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700680 #
681 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700682 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
683 # This URI must be of the form: gs://bucket_name/object_name. For more
684 # details, see https://cloud.google.com/storage/docs/reference-uris.
685 # NOTE: Cloud Storage object versioning is not supported.
686 &quot;language&quot;: &quot;A String&quot;, # The language of the document (if not specified, the language is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700687 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700688 # 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 Kim65020912020-05-20 12:08:20 -0700694 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
695 # returns an `INVALID_ARGUMENT` error.
696 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
697 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700698 },
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700710 &quot;categories&quot;: [ # Categories representing the input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700711 { # Represents a category returned from the text classifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700712 &quot;confidence&quot;: 3.14, # The classifier&#x27;s confidence of the category. Number represents how certain
713 # the classifier is that this category represents the given text.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700714 &quot;name&quot;: &quot;A String&quot;, # The name of the category representing the document, from the [predefined
715 # taxonomy](https://cloud.google.com/natural-language/docs/categories).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 },
717 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800718 }</pre>
719</div>
720
721</body></html>