blob: fbdafcebeaa82dfbabc909ebae63e9cef395687b [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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
75<h1><a href="translate_v3.html">Cloud Translation API</a> . <a href="translate_v3.projects.html">projects</a> . <a href="translate_v3.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="translate_v3.projects.locations.glossaries.html">glossaries()</a></code>
79</p>
80<p class="firstline">Returns the glossaries Resource.</p>
81
82<p class="toc_element">
83 <code><a href="translate_v3.projects.locations.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#batchTranslateText">batchTranslateText(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070089<p class="firstline">Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.</p>
90<p class="toc_element">
91 <code><a href="#close">close()</a></code></p>
92<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070093<p class="toc_element">
94 <code><a href="#detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</a></code></p>
95<p class="firstline">Detects the language of text within a request.</p>
96<p class="toc_element">
97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
98<p class="firstline">Gets information about a location.</p>
99<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800100 <code><a href="#getSupportedLanguages">getSupportedLanguages(parent, displayLanguageCode=None, model=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700101<p class="firstline">Returns a list of supported languages for translation.</p>
102<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800103 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700104<p class="firstline">Lists information about the supported locations for this service.</p>
105<p class="toc_element">
106 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
107<p class="firstline">Retrieves the next page of results.</p>
108<p class="toc_element">
109 <code><a href="#translateText">translateText(parent, body=None, x__xgafv=None)</a></code></p>
110<p class="firstline">Translates input text and returns translated text.</p>
111<h3>Method Details</h3>
112<div class="method">
113 <code class="details" id="batchTranslateText">batchTranslateText(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 <pre>Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it&#x27;s all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117 parent: string, Required. Location to make a call. Must refer to a caller&#x27;s project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 body: object, The request body.
119 The object takes the form of:
120
121{ # The batch translation request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &quot;glossaries&quot;: { # Optional. Glossaries to be applied for translation. It&#x27;s keyed by target language code.
123 &quot;a_key&quot;: { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
124 &quot;glossary&quot;: &quot;A String&quot;, # Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`
125 &quot;ignoreCase&quot;: True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
126 },
127 },
yoshi-code-bot69706592021-03-03 03:54:02 -0800128 &quot;inputConfigs&quot;: [ # Required. Input configurations. The total number of files matched should be &lt;= 100. The total content size should be &lt;= 100M Unicode codepoints. The files must use UTF-8 encoding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800129 { # Input configuration for BatchTranslateText request.
130 &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location for the source input. This can be a single file (for example, `gs://translation-test/input.tsv`) or a wildcard (for example, `gs://translation-test/*`). If a file extension is `.tsv`, it can contain either one or two columns. The first column (optional) is the id of the text request. If the first column is missing, we use the row number (0-based) from the input file as the ID in the output file. The second column is the actual text to be translated. We recommend each row be &lt;= 10K Unicode codepoints, otherwise an error might be returned. Note that the input tsv must be RFC 4180 compliant. You could use https://github.com/Clever/csvlint to check potential formatting errors in your tsv file. csvlint --delimiter=&#x27;\t&#x27; your_input_file.tsv The other supported file extensions are `.txt` or `.html`, which is treated as a single large chunk of text.
131 &quot;inputUri&quot;: &quot;A String&quot;, # Required. Source data URI. For example, `gs://my_bucket/my_object`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800132 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;mimeType&quot;: &quot;A String&quot;, # Optional. Can be &quot;text/plain&quot; or &quot;text/html&quot;. For `.tsv`, &quot;text/html&quot; is used if mime_type is missing. For `.html`, this field must be &quot;text/html&quot; or empty. For `.txt`, this field must be &quot;text/plain&quot; or empty.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800134 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 ],
136 &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.
137 &quot;a_key&quot;: &quot;A String&quot;,
138 },
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700139 &quot;models&quot;: { # Optional. The models to use for translation. Map&#x27;s key is target language code. Map&#x27;s value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;a_key&quot;: &quot;A String&quot;,
141 },
142 &quot;outputConfig&quot;: { # Output configuration for BatchTranslateText request. # Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don&#x27;t generate output for duplicate inputs.
143 &quot;gcsDestination&quot;: { # The Google Cloud Storage location for the output content. # Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are &#x27;\n&#x27; instead of &#x27;\r\n&#x27;. We don&#x27;t provide any way to change record delimiters. While the input files are being processed, we write/update an index file &#x27;index.csv&#x27; under &#x27;output_uri_prefix&#x27; (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) The format of translations_file (for target language code &#x27;trg&#x27;) is: gs://translation_test/a_b_c_&#x27;trg&#x27;_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it&#x27;s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_&#x27;trg&#x27;_glossary_translations.[extension] The format of errors file (for target language code &#x27;trg&#x27;) is: gs://translation_test/a_b_c_&#x27;trg&#x27;_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it&#x27;s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_&#x27;trg&#x27;_glossary_errors.[extension]
144 &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. The bucket used in &#x27;output_uri_prefix&#x27; must exist and there must be no files under &#x27;output_uri_prefix&#x27;. &#x27;output_uri_prefix&#x27; must end with &quot;/&quot; and start with &quot;gs://&quot;. One &#x27;output_uri_prefix&#x27; can only be used by one batch translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is returned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700145 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 },
147 &quot;sourceLanguageCode&quot;: &quot;A String&quot;, # Required. Source language code.
148 &quot;targetLanguageCodes&quot;: [ # Required. Specify up to 10 language codes here.
149 &quot;A String&quot;,
150 ],
151}
Bu Sun Kim65020912020-05-20 12:08:20 -0700152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700161 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
163 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
164 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
165 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
166 {
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169 ],
170 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
171 },
172 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
176 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178 },
179}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700180</div>
181
182<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700183 <code class="details" id="close">close()</code>
184 <pre>Close httplib2 connections.</pre>
185</div>
186
187<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700188 <code class="details" id="detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</code>
189 <pre>Detects the language of text within a request.
190
191Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 parent: string, Required. Project or location to make a call. Must refer to a caller&#x27;s project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 body: object, The request body.
194 The object takes the form of:
195
196{ # The request message for language detection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800197 &quot;content&quot;: &quot;A String&quot;, # The content of the input stored as a string.
198 &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.
199 &quot;a_key&quot;: &quot;A String&quot;,
200 },
201 &quot;mimeType&quot;: &quot;A String&quot;, # Optional. The format of the source text, for example, &quot;text/html&quot;, &quot;text/plain&quot;. If left blank, the MIME type defaults to &quot;text/html&quot;.
202 &quot;model&quot;: &quot;A String&quot;, # Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used.
203}
Bu Sun Kim65020912020-05-20 12:08:20 -0700204
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 { # The response message for language detection.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800214 &quot;languages&quot;: [ # The most probable language detected by the Translation API. For each request, the Translation API will always return only one result.
215 { # The response message for language detection.
216 &quot;confidence&quot;: 3.14, # The confidence of the detection result for this language.
217 &quot;languageCode&quot;: &quot;A String&quot;, # The BCP-47 language code of source content in the request, detected automatically.
218 },
219 ],
220}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700221</div>
222
223<div class="method">
224 <code class="details" id="get">get(name, x__xgafv=None)</code>
225 <pre>Gets information about a location.
226
227Args:
228 name: string, Resource name for the location. (required)
229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # A resource that represents Google Cloud Platform location.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
239 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
240 &quot;a_key&quot;: &quot;A String&quot;,
241 },
242 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
243 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
245 },
246 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
247}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700248</div>
249
250<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800251 <code class="details" id="getSupportedLanguages">getSupportedLanguages(parent, displayLanguageCode=None, model=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700252 <pre>Returns a list of supported languages for translation.
253
254Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700255 parent: string, Required. Project or location to make a call. Must refer to a caller&#x27;s project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800256 displayLanguageCode: string, Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700257 model: string, Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.
Bu Sun Kim65020912020-05-20 12:08:20 -0700258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # The response message for discovering supported languages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 &quot;languages&quot;: [ # A list of supported language responses. This list contains an entry for each language the Translation API supports.
268 { # A single supported language response corresponds to information related to one supported language.
269 &quot;displayName&quot;: &quot;A String&quot;, # Human readable name of the language localized in the display language specified in the request.
270 &quot;languageCode&quot;: &quot;A String&quot;, # Supported language code, generally consisting of its ISO 639-1 identifier, for example, &#x27;en&#x27;, &#x27;ja&#x27;. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, &#x27;zh-TW&#x27; and &#x27;zh-CN&#x27;)
271 &quot;supportSource&quot;: True or False, # Can be used as source language.
272 &quot;supportTarget&quot;: True or False, # Can be used as target language.
273 },
274 ],
275}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700276</div>
277
278<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800279 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700280 <pre>Lists information about the supported locations for this service.
281
282Args:
283 name: string, The resource that owns the locations collection, if applicable. (required)
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700284 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400285 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700286 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700287 x__xgafv: string, V1 error format.
288 Allowed values
289 1 - v1 error format
290 2 - v2 error format
291
292Returns:
293 An object of the form:
294
295 { # The response message for Locations.ListLocations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800296 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
297 { # A resource that represents Google Cloud Platform location.
298 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
299 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
300 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700301 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
303 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
304 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
305 },
306 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
307 },
308 ],
309 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
310}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700311</div>
312
313<div class="method">
314 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
315 <pre>Retrieves the next page of results.
316
317Args:
318 previous_request: The request for the previous page. (required)
319 previous_response: The response from the request for the previous page. (required)
320
321Returns:
322 A request object that you can call &#x27;execute()&#x27; on to request the next
323 page. Returns None if there are no more items in the collection.
324 </pre>
325</div>
326
327<div class="method">
328 <code class="details" id="translateText">translateText(parent, body=None, x__xgafv=None)</code>
329 <pre>Translates input text and returns translated text.
330
331Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700332 parent: string, Required. Project or location to make a call. Must refer to a caller&#x27;s project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700333 body: object, The request body.
334 The object takes the form of:
335
336{ # The request message for synchronous translation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800337 &quot;contents&quot;: [ # Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.
338 &quot;A String&quot;,
339 ],
340 &quot;glossaryConfig&quot;: { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
341 &quot;glossary&quot;: &quot;A String&quot;, # Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`
342 &quot;ignoreCase&quot;: True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
343 },
344 &quot;labels&quot;: { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/advanced/labels for more information.
345 &quot;a_key&quot;: &quot;A String&quot;,
346 },
347 &quot;mimeType&quot;: &quot;A String&quot;, # Optional. The format of the source text, for example, &quot;text/html&quot;, &quot;text/plain&quot;. If left blank, the MIME type defaults to &quot;text/html&quot;.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700348 &quot;model&quot;: &quot;A String&quot;, # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800349 &quot;sourceLanguageCode&quot;: &quot;A String&quot;, # Optional. The BCP-47 language code of the input text if known, for example, &quot;en-US&quot; or &quot;sr-Latn&quot;. Supported language codes are listed in Language Support. If the source language isn&#x27;t specified, the API attempts to identify the source language automatically and returns the source language within the response.
350 &quot;targetLanguageCode&quot;: &quot;A String&quot;, # Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support.
351}
Bu Sun Kim65020912020-05-20 12:08:20 -0700352
353 x__xgafv: string, V1 error format.
354 Allowed values
355 1 - v1 error format
356 2 - v2 error format
357
358Returns:
359 An object of the form:
360
361 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800362 &quot;glossaryTranslations&quot;: [ # Text translation responses if a glossary is provided in the request. This can be the same as `translations` if no terms apply. This field has the same length as `contents`.
363 { # A single translation response.
364 &quot;detectedLanguageCode&quot;: &quot;A String&quot;, # The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.
365 &quot;glossaryConfig&quot;: { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # The `glossary_config` used for this translation.
366 &quot;glossary&quot;: &quot;A String&quot;, # Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`
367 &quot;ignoreCase&quot;: True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800368 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;model&quot;: &quot;A String&quot;, # Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700370 &quot;translatedText&quot;: &quot;A String&quot;, # Text translated into the target language. If an error occurs during translation, this field might be excluded from the response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800371 },
372 ],
373 &quot;translations&quot;: [ # Text translation responses with no glossary applied. This field has the same length as `contents`.
374 { # A single translation response.
375 &quot;detectedLanguageCode&quot;: &quot;A String&quot;, # The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.
376 &quot;glossaryConfig&quot;: { # Configures which glossary should be used for a specific target language, and defines options for applying that glossary. # The `glossary_config` used for this translation.
377 &quot;glossary&quot;: &quot;A String&quot;, # Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`
378 &quot;ignoreCase&quot;: True or False, # Optional. Indicates match is case-insensitive. Default value is false if missing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700379 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800380 &quot;model&quot;: &quot;A String&quot;, # Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700381 &quot;translatedText&quot;: &quot;A String&quot;, # Text translated into the target language. If an error occurs during translation, this field might be excluded from the response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800382 },
383 ],
384}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700385</div>
386
387</body></html>