Blame - docs/dyn/language_v1beta1.documents.html - platform/external/python/google-api-python-client - Gitiles

blob: e908dc8da5e8b14a7c915a22948602ee5b4324ea [file] [log] [blame]

Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="language_v1beta1.html">Cloud Natural Language API</a> . <a href="language_v1beta1.documents.html">documents</a></h1>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	e833b79	2017-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 Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	82	<p class="firstline">Analyzes the sentiment of the provided text.</p>
				83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	84	<code><a href="#analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	85	<p class="firstline">Analyzes the syntax of the text and provides sentence boundaries and</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#annotateText">annotateText(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	88	<p class="firstline">A convenience method that provides all the features that analyzeSentiment,</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	89	<h3>Method Details</h3>
				90	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	91	<code class="details" id="analyzeEntities">analyzeEntities(body=None, x__xgafv=None)</code>
Sai Cheemalapati	e833b79	2017-03-24 15:06:46 -0700	[diff] [blame]	92	<pre>Finds named entities (currently proper names and common nouns) in the text
				93	along with entity types, salience, mentions for each entity, and
				94	other properties.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	95
				96	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	97	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	98	The object takes the form of:
				99
				100	{ # The entity analysis request message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	101	"encodingType": "A String", # The encoding type used by the API to calculate offsets.
				102	"document": { # ################################################################ # # Input document.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	103	#
				104	# Represents the input to API methods.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	105	"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
				106	# returns an `INVALID_ARGUMENT` error.
				107	"content": "A String", # The content of the input in string format.
				108	# Cloud audit logging exempt since it is based on user data.
				109	"gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	110	# This URI must be of the form: gs://bucket_name/object_name. For more
				111	# details, see https://cloud.google.com/storage/docs/reference-uris.
				112	# NOTE: Cloud Storage object versioning is not supported.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	113	"language": "A String", # The language of the document (if not specified, the language is
				114	# automatically detected). Both ISO and BCP-47 language codes are
				115	# accepted.<br>
				116	# [Language
				117	# Support](https://cloud.google.com/natural-language/docs/languages) lists
				118	# currently supported languages for each API method. If the language (either
				119	# specified by the caller or automatically detected) is not supported by the
				120	# called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	121	},
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	122	}
				123
				124	x__xgafv: string, V1 error format.
				125	Allowed values
				126	1 - v1 error format
				127	2 - v2 error format
				128
				129	Returns:
				130	An object of the form:
				131
				132	{ # The entity analysis response message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	133	"language": "A String", # The language of the text, which will be the same as the language specified
				134	# in the request or, if not specified, the automatically-detected language.
				135	# See Document.language field for more details.
				136	"entities": [ # The recognized entities in the input document.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	137	{ # Represents a phrase in the text that is a known entity, such as
				138	# a person, an organization, or location. The API associates information, such
				139	# as salience and mentions, with entities.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	140	"name": "A String", # The representative name for the entity.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	"type": "A String", # The entity type.
				142	"metadata": { # Metadata associated with the entity.
				143	#
				144	# Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
				145	# available. The associated keys are "wikipedia_url" and "mid", respectively.
				146	"a_key": "A String",
				147	},
				148	"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	149	#
				150	# The salience score for an entity provides information about the
				151	# importance or centrality of that entity to the entire document text.
				152	# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
				153	# salient.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"mentions": [ # The mentions of this entity in the input document. The API currently
				155	# supports proper noun mentions.
				156	{ # Represents a mention for an entity in the text. Currently, proper noun
				157	# mentions are supported.
				158	"text": { # Represents an output piece of text. # The mention text.
				159	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
				160	# document according to the EncodingType specified in the API request.
				161	"content": "A String", # The content of the output text.
				162	},
				163	"type": "A String", # The type of the entity mention.
				164	},
				165	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	166	},
				167	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	168	}</pre>
				169	</div>
				170
				171	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	172	<code class="details" id="analyzeSentiment">analyzeSentiment(body=None, x__xgafv=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	173	<pre>Analyzes the sentiment of the provided text.
				174
				175	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	176	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	177	The object takes the form of:
				178
				179	{ # The sentiment analysis request message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	180	"encodingType": "A String", # The encoding type used by the API to calculate sentence offsets for the
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	181	# sentence sentiment.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	182	"document": { # ################################################################ # # Input document.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	183	#
				184	# Represents the input to API methods.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	185	"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
				186	# returns an `INVALID_ARGUMENT` error.
				187	"content": "A String", # The content of the input in string format.
				188	# Cloud audit logging exempt since it is based on user data.
				189	"gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	190	# This URI must be of the form: gs://bucket_name/object_name. For more
				191	# details, see https://cloud.google.com/storage/docs/reference-uris.
				192	# NOTE: Cloud Storage object versioning is not supported.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	193	"language": "A String", # The language of the document (if not specified, the language is
				194	# automatically detected). Both ISO and BCP-47 language codes are
				195	# accepted.<br>
				196	# [Language
				197	# Support](https://cloud.google.com/natural-language/docs/languages) lists
				198	# currently supported languages for each API method. If the language (either
				199	# specified by the caller or automatically detected) is not supported by the
				200	# called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	201	},
				202	}
				203
				204	x__xgafv: string, V1 error format.
				205	Allowed values
				206	1 - v1 error format
				207	2 - v2 error format
				208
				209	Returns:
				210	An object of the form:
				211
				212	{ # The sentiment analysis response message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	213	"language": "A String", # The language of the text, which will be the same as the language specified
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	214	# in the request or, if not specified, the automatically-detected language.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	215	# See Document.language field for more details.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	"sentences": [ # The sentiment for all the sentences in the document.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	217	{ # Represents a sentence in the input document.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	218	"text": { # Represents an output piece of text. # The sentence text.
				219	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	220	# document according to the EncodingType specified in the API request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221	"content": "A String", # The content of the output text.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	222	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	223	"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	224	# AnnotateTextRequest.Features.extract_document_sentiment is set to
				225	# true, this field will contain the sentiment for the sentence.
				226	# the text.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	"polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	228	# favor of score. Please refer to our documentation at
				229	# https://cloud.google.com/natural-language/docs for more information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	230	"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	231	# (positive sentiment).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	232	"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	233	# the absolute magnitude of sentiment regardless of score (positive or
				234	# negative).
				235	},
				236	},
				237	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	238	"documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment of the input document.
				239	# the text.
				240	"polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
				241	# favor of score. Please refer to our documentation at
				242	# https://cloud.google.com/natural-language/docs for more information.
				243	"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
				244	# (positive sentiment).
				245	"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
				246	# the absolute magnitude of sentiment regardless of score (positive or
				247	# negative).
				248	},
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	249	}</pre>
				250	</div>
				251
				252	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	253	<code class="details" id="analyzeSyntax">analyzeSyntax(body=None, x__xgafv=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	254	<pre>Analyzes the syntax of the text and provides sentence boundaries and
				255	tokenization along with part of speech tags, dependency trees, and other
				256	properties.
				257
				258	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	259	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	260	The object takes the form of:
				261
				262	{ # The syntax analysis request message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	263	"encodingType": "A String", # The encoding type used by the API to calculate offsets.
				264	"document": { # ################################################################ # # Input document.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	265	#
				266	# Represents the input to API methods.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	267	"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
				268	# returns an `INVALID_ARGUMENT` error.
				269	"content": "A String", # The content of the input in string format.
				270	# Cloud audit logging exempt since it is based on user data.
				271	"gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	272	# This URI must be of the form: gs://bucket_name/object_name. For more
				273	# details, see https://cloud.google.com/storage/docs/reference-uris.
				274	# NOTE: Cloud Storage object versioning is not supported.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	275	"language": "A String", # The language of the document (if not specified, the language is
				276	# automatically detected). Both ISO and BCP-47 language codes are
				277	# accepted.<br>
				278	# [Language
				279	# Support](https://cloud.google.com/natural-language/docs/languages) lists
				280	# currently supported languages for each API method. If the language (either
				281	# specified by the caller or automatically detected) is not supported by the
				282	# called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	283	},
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	284	}
				285
				286	x__xgafv: string, V1 error format.
				287	Allowed values
				288	1 - v1 error format
				289	2 - v2 error format
				290
				291	Returns:
				292	An object of the form:
				293
				294	{ # The syntax analysis response message.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	295	"tokens": [ # Tokens, along with their syntactic information, in the input document.
				296	{ # Represents the smallest syntactic building block of the text.
				297	"partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
				298	"form": "A String", # The grammatical form.
				299	"number": "A String", # The grammatical number.
				300	"voice": "A String", # The grammatical voice.
				301	"aspect": "A String", # The grammatical aspect.
				302	"mood": "A String", # The grammatical mood.
				303	"tag": "A String", # The part of speech tag.
				304	"gender": "A String", # The grammatical gender.
				305	"person": "A String", # The grammatical person.
				306	"proper": "A String", # The grammatical properness.
				307	"case": "A String", # The grammatical case.
				308	"tense": "A String", # The grammatical tense.
				309	"reciprocity": "A String", # The grammatical reciprocity.
				310	},
				311	"text": { # Represents an output piece of text. # The token text.
				312	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
				313	# document according to the EncodingType specified in the API request.
				314	"content": "A String", # The content of the output text.
				315	},
				316	"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
				317	"label": "A String", # The parse label for the token.
				318	"headTokenIndex": 42, # Represents the head of this token in the dependency tree.
				319	# This is the index of the token which has an arc going to this token.
				320	# The index is the position of the token in the array of tokens returned
				321	# by the API method. If this token is a root token, then the
				322	# `head_token_index` is its own index.
				323	},
				324	"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
				325	},
				326	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	327	"language": "A String", # The language of the text, which will be the same as the language specified
				328	# in the request or, if not specified, the automatically-detected language.
				329	# See Document.language field for more details.
				330	"sentences": [ # Sentences in the input document.
				331	{ # Represents a sentence in the input document.
				332	"text": { # Represents an output piece of text. # The sentence text.
				333	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	334	# document according to the EncodingType specified in the API request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	"content": "A String", # The content of the output text.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	336	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	337	"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
				338	# AnnotateTextRequest.Features.extract_document_sentiment is set to
				339	# true, this field will contain the sentiment for the sentence.
				340	# the text.
				341	"polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
				342	# favor of score. Please refer to our documentation at
				343	# https://cloud.google.com/natural-language/docs for more information.
				344	"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
				345	# (positive sentiment).
				346	"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
				347	# the absolute magnitude of sentiment regardless of score (positive or
				348	# negative).
				349	},
				350	},
				351	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	352	}</pre>
				353	</div>
				354
				355	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	356	<code class="details" id="annotateText">annotateText(body=None, x__xgafv=None)</code>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	357	<pre>A convenience method that provides all the features that analyzeSentiment,
				358	analyzeEntities, and analyzeSyntax provide in one call.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	359
				360	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	361	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	362	The object takes the form of:
				363
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	364	{ # The request message for the text annotation API, which can perform multiple
				365	# analysis types (sentiment, entities, and syntax) in one call.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	366	"encodingType": "A String", # The encoding type used by the API to calculate offsets.
				367	"document": { # ################################################################ # # Input document.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	368	#
				369	# Represents the input to API methods.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	370	"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,
				371	# returns an `INVALID_ARGUMENT` error.
				372	"content": "A String", # The content of the input in string format.
				373	# Cloud audit logging exempt since it is based on user data.
				374	"gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	375	# This URI must be of the form: gs://bucket_name/object_name. For more
				376	# details, see https://cloud.google.com/storage/docs/reference-uris.
				377	# NOTE: Cloud Storage object versioning is not supported.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	378	"language": "A String", # The language of the document (if not specified, the language is
				379	# automatically detected). Both ISO and BCP-47 language codes are
				380	# accepted.<br>
				381	# [Language
				382	# Support](https://cloud.google.com/natural-language/docs/languages) lists
				383	# currently supported languages for each API method. If the language (either
				384	# specified by the caller or automatically detected) is not supported by the
				385	# called API method, an `INVALID_ARGUMENT` error is returned.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	386	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	387	"features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	388	# Setting each one to true will enable that specific analysis for the input.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	389	"extractSyntax": True or False, # Extract syntax information.
				390	"extractDocumentSentiment": True or False, # Extract document-level sentiment.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	391	"extractEntities": True or False, # Extract entities.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	392	},
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	393	}
				394
				395	x__xgafv: string, V1 error format.
				396	Allowed values
				397	1 - v1 error format
				398	2 - v2 error format
				399
				400	Returns:
				401	An object of the form:
				402
				403	{ # The text annotations response message.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	404	"tokens": [ # Tokens, along with their syntactic information, in the input document.
				405	# Populated if the user enables
				406	# AnnotateTextRequest.Features.extract_syntax.
				407	{ # Represents the smallest syntactic building block of the text.
				408	"partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
				409	"form": "A String", # The grammatical form.
				410	"number": "A String", # The grammatical number.
				411	"voice": "A String", # The grammatical voice.
				412	"aspect": "A String", # The grammatical aspect.
				413	"mood": "A String", # The grammatical mood.
				414	"tag": "A String", # The part of speech tag.
				415	"gender": "A String", # The grammatical gender.
				416	"person": "A String", # The grammatical person.
				417	"proper": "A String", # The grammatical properness.
				418	"case": "A String", # The grammatical case.
				419	"tense": "A String", # The grammatical tense.
				420	"reciprocity": "A String", # The grammatical reciprocity.
				421	},
				422	"text": { # Represents an output piece of text. # The token text.
				423	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
				424	# document according to the EncodingType specified in the API request.
				425	"content": "A String", # The content of the output text.
				426	},
				427	"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
				428	"label": "A String", # The parse label for the token.
				429	"headTokenIndex": 42, # Represents the head of this token in the dependency tree.
				430	# This is the index of the token which has an arc going to this token.
				431	# The index is the position of the token in the array of tokens returned
				432	# by the API method. If this token is a root token, then the
				433	# `head_token_index` is its own index.
				434	},
				435	"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
				436	},
				437	],
				438	"entities": [ # Entities, along with their semantic information, in the input document.
				439	# Populated if the user enables
				440	# AnnotateTextRequest.Features.extract_entities.
				441	{ # Represents a phrase in the text that is a known entity, such as
				442	# a person, an organization, or location. The API associates information, such
				443	# as salience and mentions, with entities.
				444	"name": "A String", # The representative name for the entity.
				445	"type": "A String", # The entity type.
				446	"metadata": { # Metadata associated with the entity.
				447	#
				448	# Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
				449	# available. The associated keys are "wikipedia_url" and "mid", respectively.
				450	"a_key": "A String",
				451	},
				452	"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
				453	#
				454	# The salience score for an entity provides information about the
				455	# importance or centrality of that entity to the entire document text.
				456	# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
				457	# salient.
				458	"mentions": [ # The mentions of this entity in the input document. The API currently
				459	# supports proper noun mentions.
				460	{ # Represents a mention for an entity in the text. Currently, proper noun
				461	# mentions are supported.
				462	"text": { # Represents an output piece of text. # The mention text.
				463	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
				464	# document according to the EncodingType specified in the API request.
				465	"content": "A String", # The content of the output text.
				466	},
				467	"type": "A String", # The type of the entity mention.
				468	},
				469	],
				470	},
				471	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	472	"documentSentiment": { # Represents the feeling associated with the entire text or entities in # The overall sentiment for the document. Populated if the user enables
				473	# AnnotateTextRequest.Features.extract_document_sentiment.
				474	# the text.
				475	"polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
				476	# favor of score. Please refer to our documentation at
				477	# https://cloud.google.com/natural-language/docs for more information.
				478	"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
				479	# (positive sentiment).
				480	"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
				481	# the absolute magnitude of sentiment regardless of score (positive or
				482	# negative).
				483	},
				484	"language": "A String", # The language of the text, which will be the same as the language specified
				485	# in the request or, if not specified, the automatically-detected language.
				486	# See Document.language field for more details.
				487	"sentences": [ # Sentences in the input document. Populated if the user enables
				488	# AnnotateTextRequest.Features.extract_syntax.
				489	{ # Represents a sentence in the input document.
				490	"text": { # Represents an output piece of text. # The sentence text.
				491	"beginOffset": 42, # The API calculates the beginning offset of the content in the original
				492	# document according to the EncodingType specified in the API request.
				493	"content": "A String", # The content of the output text.
				494	},
				495	"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if
				496	# AnnotateTextRequest.Features.extract_document_sentiment is set to
				497	# true, this field will contain the sentiment for the sentence.
				498	# the text.
				499	"polarity": 3.14, # DEPRECATED FIELD - This field is being deprecated in
				500	# favor of score. Please refer to our documentation at
				501	# https://cloud.google.com/natural-language/docs for more information.
				502	"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0
				503	# (positive sentiment).
				504	"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents
				505	# the absolute magnitude of sentiment regardless of score (positive or
				506	# negative).
				507	},
				508	},
				509	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	510	}</pre>
				511	</div>
				512
				513	</body></html>