Blame - docs/dyn/translate_v2.translations.html - platform/external/python/google-api-python-client

blob: 347a68c0f0ea50af27e76f69b222c2af5ad8fa54 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	75	<h1><a href="translate_v2.html">Google Cloud Translation API</a> . <a href="translate_v2.translations.html">translations</a></h1>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#list">list(q, target, cid=None, format=None, source=None, model=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	82	<p class="firstline">Translates input text, returning translated text.</p>
				83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	84	<code><a href="#translate">translate(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	85	<p class="firstline">Translates input text, returning translated text.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	86	<h3>Method Details</h3>
				87	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	88	<code class="details" id="close">close()</code>
				89	<pre>Close httplib2 connections.</pre>
				90	</div>
				91
				92	<div class="method">
				93	<code class="details" id="list">list(q, target, cid=None, format=None, source=None, model=None, x__xgafv=None)</code>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	94	<pre>Translates input text, returning translated text.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	95
				96	Args:
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	97	q: string, The input text to translate. Repeat this parameter to perform translation
				98	operations on multiple text inputs. (required) (repeated)
				99	target: string, The language to use for translation of the input text, set to one of the
				100	language codes listed in Language Support. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	101	cid: string, The customization id for translate (repeated)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	102	format: string, The format of the source text, in either HTML (default) or plain-text. A
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	value of "html" indicates HTML and a value of "text" indicates plain-text.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	104	Allowed values
				105	html - Specifies the input is in HTML
				106	text - Specifies the input is in plain textual format
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	107	source: string, The language of the source text, set to one of the language codes listed in
				108	Language Support. If the source language is not specified, the API will
				109	attempt to identify the source language automatically and return it within
				110	the response.
				111	model: string, The `model` type requested for this translation. Valid values are
				112	listed in public documentation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	x__xgafv: string, V1 error format.
				114	Allowed values
				115	1 - v1 error format
				116	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	117
				118	Returns:
				119	An object of the form:
				120
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	121	{ # The main language translation response message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"translations": [ # Translations contains list of translation results of given text
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	123	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	124	"model": "A String", # The `model` type used for this translation. Valid values are
				125	# listed in public documentation. Can be different from requested `model`.
				126	# Present only if specific model type was explicitly requested.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	127	"translatedText": "A String", # Text translated into the target language.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	128	"detectedSourceLanguage": "A String", # The source language of the initial request, detected automatically, if
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	129	# no source language was passed within the initial request. If the
				130	# source language was passed, auto-detection of the language will not
				131	# occur and this field will be empty.
				132	},
				133	],
				134	}</pre>
				135	</div>
				136
				137	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	138	<code class="details" id="translate">translate(body=None, x__xgafv=None)</code>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	139	<pre>Translates input text, returning translated text.
				140
				141	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	142	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	143	The object takes the form of:
				144
				145	{ # The main translation request message for the Cloud Translation API.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	146	"format": "A String", # The format of the source text, in either HTML (default) or plain-text. A
				147	# value of "html" indicates HTML and a value of "text" indicates plain-text.
				148	"model": "A String", # The `model` type requested for this translation. Valid values are
				149	# listed in public documentation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	"q": [ # The input text to translate. Repeat this parameter to perform translation
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	151	# operations on multiple text inputs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	"A String",
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	153	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"source": "A String", # The language of the source text, set to one of the language codes listed in
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	155	# Language Support. If the source language is not specified, the API will
				156	# attempt to identify the source language automatically and return it within
				157	# the response.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	158	"target": "A String", # The language to use for translation of the input text, set to one of the
				159	# language codes listed in Language Support.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	160	}
				161
				162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
				166
				167	Returns:
				168	An object of the form:
				169
				170	{ # The main language translation response message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	"translations": [ # Translations contains list of translation results of given text
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	172	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	173	"model": "A String", # The `model` type used for this translation. Valid values are
				174	# listed in public documentation. Can be different from requested `model`.
				175	# Present only if specific model type was explicitly requested.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	176	"translatedText": "A String", # Text translated into the target language.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	"detectedSourceLanguage": "A String", # The source language of the initial request, detected automatically, if
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	178	# no source language was passed within the initial request. If the
				179	# source language was passed, auto-detection of the language will not
				180	# occur and this field will be empty.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	181	},
				182	],
				183	}</pre>
				184	</div>
				185
				186	</body></html>