| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 | |
| 75 | <h1><a href="translate_v3.html">Cloud Translation API</a> . <a href="translate_v3.projects.html">projects</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="translate_v3.projects.locations.html">locations()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the locations Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Detects the language of text within a request.</p> |
| 85 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 86 | <code><a href="#getSupportedLanguages">getSupportedLanguages(parent, model=None, displayLanguageCode=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <p class="firstline">Returns a list of supported languages for translation.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#translateText">translateText(parent, body=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Translates input text and returns translated text.</p> |
| 91 | <h3>Method Details</h3> |
| 92 | <div class="method"> |
| 93 | <code class="details" id="detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</code> |
| 94 | <pre>Detects the language of text within a request. |
| 95 | |
| 96 | Args: |
| 97 | parent: string, Required. Project or location to make a call. Must refer to a caller's |
| 98 | project. |
| 99 | |
| 100 | Format: `projects/{project-number-or-id}/locations/{location-id}` or |
| 101 | `projects/{project-number-or-id}`. |
| 102 | |
| 103 | For global calls, use `projects/{project-number-or-id}/locations/global` or |
| 104 | `projects/{project-number-or-id}`. |
| 105 | |
| 106 | Only models within the same region (has same location-id) can be used. |
| 107 | Otherwise an INVALID_ARGUMENT (400) error is returned. (required) |
| 108 | body: object, The request body. |
| 109 | The object takes the form of: |
| 110 | |
| 111 | { # The request message for language detection. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | "labels": { # Optional. The labels with user-defined metadata for the request. |
| 113 | # |
| 114 | # Label keys and values can be no longer than 63 characters |
| 115 | # (Unicode codepoints), can only contain lowercase letters, numeric |
| 116 | # characters, underscores and dashes. International characters are allowed. |
| 117 | # Label values are optional. Label keys must start with a letter. |
| 118 | # |
| 119 | # See https://cloud.google.com/translate/docs/advanced/labels for more |
| 120 | # information. |
| 121 | "a_key": "A String", |
| 122 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 123 | "content": "A String", # The content of the input stored as a string. |
| 124 | "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", |
| 125 | # "text/plain". If left blank, the MIME type defaults to "text/html". |
| 126 | "model": "A String", # Optional. The language detection model to be used. |
| 127 | # |
| 128 | # Format: |
| 129 | # `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` |
| 130 | # |
| 131 | # Only one language detection model is currently supported: |
| 132 | # `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. |
| 133 | # |
| 134 | # If not specified, the default model is used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | x__xgafv: string, V1 error format. |
| 138 | Allowed values |
| 139 | 1 - v1 error format |
| 140 | 2 - v2 error format |
| 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| 145 | { # The response message for language detection. |
| 146 | "languages": [ # A list of detected languages sorted by detection confidence in descending |
| 147 | # order. The most probable language first. |
| 148 | { # The response message for language detection. |
| 149 | "confidence": 3.14, # The confidence of the detection result for this language. |
| 150 | "languageCode": "A String", # The BCP-47 language code of source content in the request, detected |
| 151 | # automatically. |
| 152 | }, |
| 153 | ], |
| 154 | }</pre> |
| 155 | </div> |
| 156 | |
| 157 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 158 | <code class="details" id="getSupportedLanguages">getSupportedLanguages(parent, model=None, displayLanguageCode=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 159 | <pre>Returns a list of supported languages for translation. |
| 160 | |
| 161 | Args: |
| 162 | parent: string, Required. Project or location to make a call. Must refer to a caller's |
| 163 | project. |
| 164 | |
| 165 | Format: `projects/{project-number-or-id}` or |
| 166 | `projects/{project-number-or-id}/locations/{location-id}`. |
| 167 | |
| 168 | For global calls, use `projects/{project-number-or-id}/locations/global` or |
| 169 | `projects/{project-number-or-id}`. |
| 170 | |
| 171 | Non-global location is required for AutoML models. |
| 172 | |
| 173 | Only models within the same region (have same location-id) can be used, |
| 174 | otherwise an INVALID_ARGUMENT (400) error is returned. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | model: string, Optional. Get supported languages of this model. |
| 176 | |
| 177 | The format depends on model type: |
| 178 | |
| 179 | - AutoML Translation models: |
| 180 | `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` |
| 181 | |
| 182 | - General (built-in) models: |
| 183 | `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, |
| 184 | `projects/{project-number-or-id}/locations/{location-id}/models/general/base` |
| 185 | |
| 186 | |
| 187 | Returns languages supported by the specified model. |
| 188 | If missing, we get supported languages of Google general base (PBMT) model. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 189 | displayLanguageCode: string, Optional. The language to use to return localized, human readable names |
| 190 | of supported languages. If missing, then display names are not returned |
| 191 | in a response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | x__xgafv: string, V1 error format. |
| 193 | Allowed values |
| 194 | 1 - v1 error format |
| 195 | 2 - v2 error format |
| 196 | |
| 197 | Returns: |
| 198 | An object of the form: |
| 199 | |
| 200 | { # The response message for discovering supported languages. |
| 201 | "languages": [ # A list of supported language responses. This list contains an entry |
| 202 | # for each language the Translation API supports. |
| 203 | { # A single supported language response corresponds to information related |
| 204 | # to one supported language. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 205 | "displayName": "A String", # Human readable name of the language localized in the display language |
| 206 | # specified in the request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | "languageCode": "A String", # Supported language code, generally consisting of its ISO 639-1 |
| 208 | # identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes |
| 209 | # including language and region identifiers are returned (for example, |
| 210 | # 'zh-TW' and 'zh-CN') |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 211 | "supportSource": True or False, # Can be used as source language. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 212 | "supportTarget": True or False, # Can be used as target language. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | }, |
| 214 | ], |
| 215 | }</pre> |
| 216 | </div> |
| 217 | |
| 218 | <div class="method"> |
| 219 | <code class="details" id="translateText">translateText(parent, body=None, x__xgafv=None)</code> |
| 220 | <pre>Translates input text and returns translated text. |
| 221 | |
| 222 | Args: |
| 223 | parent: string, Required. Project or location to make a call. Must refer to a caller's |
| 224 | project. |
| 225 | |
| 226 | Format: `projects/{project-number-or-id}` or |
| 227 | `projects/{project-number-or-id}/locations/{location-id}`. |
| 228 | |
| 229 | For global calls, use `projects/{project-number-or-id}/locations/global` or |
| 230 | `projects/{project-number-or-id}`. |
| 231 | |
| 232 | Non-global location is required for requests using AutoML models or |
| 233 | custom glossaries. |
| 234 | |
| 235 | Models and glossaries must be within the same region (have same |
| 236 | location-id), otherwise an INVALID_ARGUMENT (400) error is returned. (required) |
| 237 | body: object, The request body. |
| 238 | The object takes the form of: |
| 239 | |
| 240 | { # The request message for synchronous translation. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 241 | "labels": { # Optional. The labels with user-defined metadata for the request. |
| 242 | # |
| 243 | # Label keys and values can be no longer than 63 characters |
| 244 | # (Unicode codepoints), can only contain lowercase letters, numeric |
| 245 | # characters, underscores and dashes. International characters are allowed. |
| 246 | # Label values are optional. Label keys must start with a letter. |
| 247 | # |
| 248 | # See https://cloud.google.com/translate/docs/advanced/labels for more |
| 249 | # information. |
| 250 | "a_key": "A String", |
| 251 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | "sourceLanguageCode": "A String", # Optional. The BCP-47 language code of the input text if |
| 253 | # known, for example, "en-US" or "sr-Latn". Supported language codes are |
| 254 | # listed in Language Support. If the source language isn't specified, the API |
| 255 | # attempts to identify the source language automatically and returns the |
| 256 | # source language within the response. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 257 | "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", |
| 258 | # "text/plain". If left blank, the MIME type defaults to "text/html". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 259 | "model": "A String", # Optional. The `model` type requested for this translation. |
| 260 | # |
| 261 | # The format depends on model type: |
| 262 | # |
| 263 | # - AutoML Translation models: |
| 264 | # `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` |
| 265 | # |
| 266 | # - General (built-in) models: |
| 267 | # `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, |
| 268 | # `projects/{project-number-or-id}/locations/{location-id}/models/general/base` |
| 269 | # |
| 270 | # |
| 271 | # For global (non-regionalized) requests, use `location-id` `global`. |
| 272 | # For example, |
| 273 | # `projects/{project-number-or-id}/locations/global/models/general/nmt`. |
| 274 | # |
| 275 | # If missing, the system decides which google base model to use. |
| 276 | "contents": [ # Required. The content of the input in string format. |
| 277 | # We recommend the total content be less than 30k codepoints. |
| 278 | # Use BatchTranslateText for larger text. |
| 279 | "A String", |
| 280 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 281 | "targetLanguageCode": "A String", # Required. The BCP-47 language code to use for translation of the input |
| 282 | # text, set to one of the language codes listed in Language Support. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "glossaryConfig": { # Configures which glossary should be used for a specific target language, # Optional. Glossary to be applied. The glossary must be |
| 284 | # within the same region (have the same location-id) as the model, otherwise |
| 285 | # an INVALID_ARGUMENT (400) error is returned. |
| 286 | # and defines options for applying that glossary. |
| 287 | "glossary": "A String", # Required. The `glossary` to be applied for this translation. |
| 288 | # |
| 289 | # The format depends on glossary: |
| 290 | # |
| 291 | # - User provided custom glossary: |
| 292 | # `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` |
| 293 | "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. |
| 294 | # Default value is false if missing. |
| 295 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 296 | } |
| 297 | |
| 298 | x__xgafv: string, V1 error format. |
| 299 | Allowed values |
| 300 | 1 - v1 error format |
| 301 | 2 - v2 error format |
| 302 | |
| 303 | Returns: |
| 304 | An object of the form: |
| 305 | |
| 306 | { |
| 307 | "glossaryTranslations": [ # Text translation responses if a glossary is provided in the request. |
| 308 | # This can be the same as |
| 309 | # `translations` if no terms apply. |
| 310 | # This field has the same length as |
| 311 | # `contents`. |
| 312 | { # A single translation response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 313 | "glossaryConfig": { # Configures which glossary should be used for a specific target language, # The `glossary_config` used for this translation. |
| 314 | # and defines options for applying that glossary. |
| 315 | "glossary": "A String", # Required. The `glossary` to be applied for this translation. |
| 316 | # |
| 317 | # The format depends on glossary: |
| 318 | # |
| 319 | # - User provided custom glossary: |
| 320 | # `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` |
| 321 | "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. |
| 322 | # Default value is false if missing. |
| 323 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 324 | "detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected |
| 325 | # automatically, if no source language was passed within the initial |
| 326 | # request. If the source language was passed, auto-detection of the language |
| 327 | # does not occur and this field is empty. |
| 328 | "model": "A String", # Only present when `model` is present in the request. |
| 329 | # `model` here is normalized to have project number. |
| 330 | # |
| 331 | # For example: |
| 332 | # If the `model` requested in TranslationTextRequest is |
| 333 | # `projects/{project-id}/locations/{location-id}/models/general/nmt` then |
| 334 | # `model` here would be normalized to |
| 335 | # `projects/{project-number}/locations/{location-id}/models/general/nmt`. |
| 336 | "translatedText": "A String", # Text translated into the target language. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | }, |
| 338 | ], |
| 339 | "translations": [ # Text translation responses with no glossary applied. |
| 340 | # This field has the same length as |
| 341 | # `contents`. |
| 342 | { # A single translation response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "glossaryConfig": { # Configures which glossary should be used for a specific target language, # The `glossary_config` used for this translation. |
| 344 | # and defines options for applying that glossary. |
| 345 | "glossary": "A String", # Required. The `glossary` to be applied for this translation. |
| 346 | # |
| 347 | # The format depends on glossary: |
| 348 | # |
| 349 | # - User provided custom glossary: |
| 350 | # `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` |
| 351 | "ignoreCase": True or False, # Optional. Indicates match is case-insensitive. |
| 352 | # Default value is false if missing. |
| 353 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 354 | "detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected |
| 355 | # automatically, if no source language was passed within the initial |
| 356 | # request. If the source language was passed, auto-detection of the language |
| 357 | # does not occur and this field is empty. |
| 358 | "model": "A String", # Only present when `model` is present in the request. |
| 359 | # `model` here is normalized to have project number. |
| 360 | # |
| 361 | # For example: |
| 362 | # If the `model` requested in TranslationTextRequest is |
| 363 | # `projects/{project-id}/locations/{location-id}/models/general/nmt` then |
| 364 | # `model` here would be normalized to |
| 365 | # `projects/{project-number}/locations/{location-id}/models/general/nmt`. |
| 366 | "translatedText": "A String", # Text translated into the target language. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | }, |
| 368 | ], |
| 369 | }</pre> |
| 370 | </div> |
| 371 | |
| 372 | </body></html> |