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