Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / language_v1.documents.html
blob: 91923972fa9ad94f30e0b57716619a102b8530fd [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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &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 -0800[diff] [blame]109 #
110 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111 &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 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
124 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
126 # returns an `INVALID_ARGUMENT` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &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 -0800[diff] [blame]143 { # 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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
147 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
148 # true, this field will contain the aggregate sentiment expressed for this
149 # entity in the provided document.
150 # the text.
151 &quot;magnitude&quot;: 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 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
155 # (positive sentiment).
156 },
157 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
158 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
159 #
160 # The salience score for an entity provides information about the
161 # importance or centrality of that entity to the entire document text.
162 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
163 # salient.
164 &quot;metadata&quot;: { # Metadata associated with the entity.
165 #
166 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
167 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
168 # associated with other entity types, see the Type table below.
169 &quot;a_key&quot;: &quot;A String&quot;,
170 },
171 &quot;type&quot;: &quot;A String&quot;, # The entity type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 # supports proper noun mentions.
174 { # Represents a mention for an entity in the text. Currently, proper noun
175 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
177 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]178 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]180 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
182 &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 -0700[diff] [blame]183 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
184 # true, this field will contain the sentiment expressed for this mention of
185 # the entity in the provided document.
186 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 # the absolute magnitude of sentiment regardless of score (positive or
189 # negative).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]190 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
191 # (positive sentiment).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]193 },
194 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 },
196 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 &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 -0700[diff] [blame]212 #
213 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &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 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
227 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
229 # returns an `INVALID_ARGUMENT` error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]242 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
243 # in the request or, if not specified, the automatically-detected language.
244 # See Document.language field for more details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 &quot;entities&quot;: [ # The recognized entities in the input document with associated sentiments.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 { # Represents a phrase in the text that is a known entity, such as
247 # a person, an organization, or location. The API associates information, such
248 # as salience and mentions, with entities.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
250 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
251 # true, this field will contain the aggregate sentiment expressed for this
252 # entity in the provided document.
253 # the text.
254 &quot;magnitude&quot;: 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 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
258 # (positive sentiment).
259 },
260 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
261 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
262 #
263 # The salience score for an entity provides information about the
264 # importance or centrality of that entity to the entire document text.
265 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
266 # salient.
267 &quot;metadata&quot;: { # Metadata associated with the entity.
268 #
269 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
270 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
271 # associated with other entity types, see the Type table below.
272 &quot;a_key&quot;: &quot;A String&quot;,
273 },
274 &quot;type&quot;: &quot;A String&quot;, # The entity type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 # supports proper noun mentions.
277 { # Represents a mention for an entity in the text. Currently, proper noun
278 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]279 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
280 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]282 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
285 &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 -0700[diff] [blame]286 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
287 # true, this field will contain the sentiment expressed for this mention of
288 # the entity in the provided document.
289 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 # the absolute magnitude of sentiment regardless of score (positive or
292 # negative).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]293 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
294 # (positive sentiment).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 },
296 },
297 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]298 },
299 ],
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312 &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 -0800[diff] [blame]314 #
315 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]316 &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 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]328 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
329 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]330 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
331 # returns an `INVALID_ARGUMENT` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]344 &quot;sentences&quot;: [ # The sentiment for all the sentences in the document.
345 { # Represents a sentence in the input document.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]346 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
347 # AnnotateTextRequest.Features.extract_document_sentiment is set to
348 # true, this field will contain the sentiment for the sentence.
349 # the text.
350 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
351 # the absolute magnitude of sentiment regardless of score (positive or
352 # negative).
353 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
354 # (positive sentiment).
355 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]356 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
357 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
358 # document according to the EncodingType specified in the API request.
359 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
360 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]361 },
362 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 &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 -0800[diff] [blame]364 # in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]365 # See Document.language field for more details.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]366 &quot;documentSentiment&quot;: { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
367 # the text.
368 &quot;magnitude&quot;: 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 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
372 # (positive sentiment).
373 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 &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 -0800[diff] [blame]390 #
391 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]392 &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 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]404 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
405 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]406 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
407 # returns an `INVALID_ARGUMENT` error.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 &quot;tokens&quot;: [ # Tokens, along with their syntactic information, in the input document.
421 { # Represents the smallest syntactic building block of the text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]422 &quot;partOfSpeech&quot;: { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
423 # are as defined in
424 # http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
425 &quot;tag&quot;: &quot;A String&quot;, # The part of speech tag.
426 &quot;reciprocity&quot;: &quot;A String&quot;, # The grammatical reciprocity.
427 &quot;voice&quot;: &quot;A String&quot;, # The grammatical voice.
428 &quot;person&quot;: &quot;A String&quot;, # The grammatical person.
429 &quot;tense&quot;: &quot;A String&quot;, # The grammatical tense.
430 &quot;proper&quot;: &quot;A String&quot;, # The grammatical properness.
431 &quot;gender&quot;: &quot;A String&quot;, # The grammatical gender.
432 &quot;form&quot;: &quot;A String&quot;, # The grammatical form.
433 &quot;aspect&quot;: &quot;A String&quot;, # The grammatical aspect.
434 &quot;case&quot;: &quot;A String&quot;, # The grammatical case.
435 &quot;mood&quot;: &quot;A String&quot;, # The grammatical mood.
436 &quot;number&quot;: &quot;A String&quot;, # The grammatical number.
437 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]438 &quot;text&quot;: { # Represents an output piece of text. # The token text.
439 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
440 # document according to the EncodingType specified in the API request.
441 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]442 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &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 -0700[diff] [blame]444 # information on dependency labels, see
445 # http://www.aclweb.org/anthology/P13-2017
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]446 &quot;headTokenIndex&quot;: 42, # Represents the head of this token in the dependency tree.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]451 &quot;label&quot;: &quot;A String&quot;, # The parse label for the token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]452 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]453 &quot;lemma&quot;: &quot;A String&quot;, # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]454 },
455 ],
456 &quot;sentences&quot;: [ # Sentences in the input document.
457 { # Represents a sentence in the input document.
458 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
459 # AnnotateTextRequest.Features.extract_document_sentiment is set to
460 # true, this field will contain the sentiment for the sentence.
461 # the text.
462 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
463 # the absolute magnitude of sentiment regardless of score (positive or
464 # negative).
465 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
466 # (positive sentiment).
467 },
468 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
469 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
470 # document according to the EncodingType specified in the API request.
471 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]472 },
473 },
474 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]475 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
476 # in the request or, if not specified, the automatically-detected language.
477 # See Document.language field for more details.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]492 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]493 #
494 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]495 &quot;gcsContentUri&quot;: &quot;A String&quot;, # The Google Cloud Storage URI where the file content is located.
496 # This URI must be of the form: gs://bucket_name/object_name. For more
497 # details, see https://cloud.google.com/storage/docs/reference-uris.
498 # NOTE: Cloud Storage object versioning is not supported.
499 &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 -0800[diff] [blame]500 # automatically detected). Both ISO and BCP-47 language codes are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]501 # accepted.&lt;br&gt;
502 # [Language
503 # Support](https://cloud.google.com/natural-language/docs/languages) lists
504 # currently supported languages for each API method. If the language (either
505 # specified by the caller or automatically detected) is not supported by the
506 # called API method, an `INVALID_ARGUMENT` error is returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
508 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]509 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
510 # returns an `INVALID_ARGUMENT` error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]512 &quot;encodingType&quot;: &quot;A String&quot;, # The encoding type used by the API to calculate offsets.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]513 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]515 &quot;extractEntitySentiment&quot;: True or False, # Extract entities and their associated sentiment.
516 &quot;extractEntities&quot;: True or False, # Extract entities.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]517 &quot;extractSyntax&quot;: True or False, # Extract syntax information.
518 &quot;extractDocumentSentiment&quot;: True or False, # Extract document-level sentiment.
519 &quot;classifyText&quot;: True or False, # Classify the full document into categories.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]532 &quot;categories&quot;: [ # Categories identified in the input document.
533 { # Represents a category returned from the text classifier.
534 &quot;confidence&quot;: 3.14, # The classifier&#x27;s confidence of the category. Number represents how certain
535 # the classifier is that this category represents the given text.
536 &quot;name&quot;: &quot;A String&quot;, # The name of the category representing the document, from the [predefined
537 # taxonomy](https://cloud.google.com/natural-language/docs/categories).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]538 },
539 ],
540 &quot;tokens&quot;: [ # Tokens, along with their syntactic information, in the input document.
541 # Populated if the user enables
542 # AnnotateTextRequest.Features.extract_syntax.
543 { # Represents the smallest syntactic building block of the text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]544 &quot;partOfSpeech&quot;: { # 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 &quot;tag&quot;: &quot;A String&quot;, # The part of speech tag.
548 &quot;reciprocity&quot;: &quot;A String&quot;, # The grammatical reciprocity.
549 &quot;voice&quot;: &quot;A String&quot;, # The grammatical voice.
550 &quot;person&quot;: &quot;A String&quot;, # The grammatical person.
551 &quot;tense&quot;: &quot;A String&quot;, # The grammatical tense.
552 &quot;proper&quot;: &quot;A String&quot;, # The grammatical properness.
553 &quot;gender&quot;: &quot;A String&quot;, # The grammatical gender.
554 &quot;form&quot;: &quot;A String&quot;, # The grammatical form.
555 &quot;aspect&quot;: &quot;A String&quot;, # The grammatical aspect.
556 &quot;case&quot;: &quot;A String&quot;, # The grammatical case.
557 &quot;mood&quot;: &quot;A String&quot;, # The grammatical mood.
558 &quot;number&quot;: &quot;A String&quot;, # The grammatical number.
559 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]560 &quot;text&quot;: { # Represents an output piece of text. # The token text.
561 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
562 # document according to the EncodingType specified in the API request.
563 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
564 },
565 &quot;dependencyEdge&quot;: { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
566 # information on dependency labels, see
567 # http://www.aclweb.org/anthology/P13-2017
568 &quot;headTokenIndex&quot;: 42, # Represents the head of this token in the dependency tree.
569 # This is the index of the token which has an arc going to this token.
570 # The index is the position of the token in the array of tokens returned
571 # by the API method. If this token is a root token, then the
572 # `head_token_index` is its own index.
573 &quot;label&quot;: &quot;A String&quot;, # The parse label for the token.
574 },
575 &quot;lemma&quot;: &quot;A String&quot;, # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]576 },
577 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]578 &quot;language&quot;: &quot;A String&quot;, # The language of the text, which will be the same as the language specified
579 # in the request or, if not specified, the automatically-detected language.
580 # See Document.language field for more details.
581 &quot;entities&quot;: [ # Entities, along with their semantic information, in the input document.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]582 # Populated if the user enables
583 # AnnotateTextRequest.Features.extract_entities.
584 { # Represents a phrase in the text that is a known entity, such as
585 # a person, an organization, or location. The API associates information, such
586 # as salience and mentions, with entities.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]587 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if
588 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
589 # true, this field will contain the aggregate sentiment expressed for this
590 # entity in the provided document.
591 # the text.
592 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
593 # the absolute magnitude of sentiment regardless of score (positive or
594 # negative).
595 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
596 # (positive sentiment).
597 },
598 &quot;name&quot;: &quot;A String&quot;, # The representative name for the entity.
599 &quot;salience&quot;: 3.14, # The salience score associated with the entity in the [0, 1.0] range.
600 #
601 # The salience score for an entity provides information about the
602 # importance or centrality of that entity to the entire document text.
603 # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
604 # salient.
605 &quot;metadata&quot;: { # Metadata associated with the entity.
606 #
607 # For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
608 # and Knowledge Graph MID (`mid`), if they are available. For the metadata
609 # associated with other entity types, see the Type table below.
610 &quot;a_key&quot;: &quot;A String&quot;,
611 },
612 &quot;type&quot;: &quot;A String&quot;, # The entity type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]613 &quot;mentions&quot;: [ # The mentions of this entity in the input document. The API currently
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]614 # supports proper noun mentions.
615 { # Represents a mention for an entity in the text. Currently, proper noun
616 # mentions are supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]617 &quot;text&quot;: { # Represents an output piece of text. # The mention text.
618 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]619 # document according to the EncodingType specified in the API request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]620 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]621 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]622 &quot;type&quot;: &quot;A String&quot;, # The type of the entity mention.
623 &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 -0700[diff] [blame]624 # AnnotateTextRequest.Features.extract_entity_sentiment is set to
625 # true, this field will contain the sentiment expressed for this mention of
626 # the entity in the provided document.
627 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]628 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 # the absolute magnitude of sentiment regardless of score (positive or
630 # negative).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]631 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
632 # (positive sentiment).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]633 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]634 },
635 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]636 },
637 ],
638 &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
639 # AnnotateTextRequest.Features.extract_document_sentiment.
640 # the text.
641 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
642 # the absolute magnitude of sentiment regardless of score (positive or
643 # negative).
644 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
645 # (positive sentiment).
646 },
647 &quot;sentences&quot;: [ # Sentences in the input document. Populated if the user enables
648 # AnnotateTextRequest.Features.extract_syntax.
649 { # Represents a sentence in the input document.
650 &quot;sentiment&quot;: { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
651 # AnnotateTextRequest.Features.extract_document_sentiment is set to
652 # true, this field will contain the sentiment for the sentence.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]653 # the text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]654 &quot;magnitude&quot;: 3.14, # A non-negative number in the [0, +inf) range, which represents
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]655 # the absolute magnitude of sentiment regardless of score (positive or
656 # negative).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]657 &quot;score&quot;: 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
658 # (positive sentiment).
659 },
660 &quot;text&quot;: { # Represents an output piece of text. # The sentence text.
661 &quot;beginOffset&quot;: 42, # The API calculates the beginning offset of the content in the original
662 # document according to the EncodingType specified in the API request.
663 &quot;content&quot;: &quot;A String&quot;, # The content of the output text.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]664 },
665 },
666 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]679 &quot;document&quot;: { # ################################################################ # # Required. Input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]680 #
681 # Represents the input to API methods.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]682 &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 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]694 &quot;content&quot;: &quot;A String&quot;, # The content of the input in string format.
695 # Cloud audit logging exempt since it is based on user data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]696 &quot;type&quot;: &quot;A String&quot;, # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
697 # returns an `INVALID_ARGUMENT` error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]710 &quot;categories&quot;: [ # Categories representing the input document.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 { # Represents a category returned from the text classifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]712 &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 -0700[diff] [blame]714 &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 -0700[diff] [blame]716 },
717 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]718 }</pre>
719</div>
720
721</body></html>