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