Blame - docs/dyn/translate_v3beta1.projects.locations.html - platform/external/python/google-api-python-client

<h1><a href="translate_v3beta1.html">Cloud Translation API</a> . <a href="translate_v3beta1.projects.html">projects</a> . <a href="translate_v3beta1.projects.locations.html">locations</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="translate_v3beta1.projects.locations.glossaries.html">glossaries()</a></code>

79

</p>

80

<p class="firstline">Returns the glossaries Resource.</p>

81

82

83

<code><a href="translate_v3beta1.projects.locations.operations.html">operations()</a></code>

84

</p>

85

<p class="firstline">Returns the operations Resource.</p>

86

87

88

<code><a href="#batchTranslateText">batchTranslateText(parent, body=None, x__xgafv=None)</a></code></p>

89

<p class="firstline">Translates a large volume of text in asynchronous batch mode.</p>

90

91

<code><a href="#detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</a></code></p>

92

<p class="firstline">Detects the language of text within a request.</p>

93

94

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

95

<p class="firstline">Gets information about a location.</p>

96

97

<code><a href="#getSupportedLanguages">getSupportedLanguages(parent, displayLanguageCode=None, model=None, x__xgafv=None)</a></code></p>

98

<p class="firstline">Returns a list of supported languages for translation.</p>

99

100

<code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>

101

<p class="firstline">Lists information about the supported locations for this service.</p>

102

103

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

104

<p class="firstline">Retrieves the next page of results.</p>

105

106

<code><a href="#translateText">translateText(parent, body=None, x__xgafv=None)</a></code></p>

107

<p class="firstline">Translates input text and returns translated text.</p>

108

<h3>Method Details</h3>

109

110

<code class="details" id="batchTranslateText">batchTranslateText(parent, body=None, x__xgafv=None)</code>

111

<pre>Translates a large volume of text in asynchronous batch mode.

112

This function provides real-time output as the inputs are being processed.

113

If caller cancels a request, the partial results (for an input file, it's

114

all or nothing) may still be available on the specified output location.

115

116

This call returns immediately and you can

117

use google.longrunning.Operation.name to poll the status of the call.

118

119

Args:

120

parent: string, Required. Location to make a call. Must refer to a caller's project.

121

122

Format: `projects/{project-number-or-id}/locations/{location-id}`.

123

124

The `global` location is not supported for batch translation.

125

126

Only AutoML Translation models or glossaries within the same region (have

127

the same location-id) can be used, otherwise an INVALID_ARGUMENT (400)

128

error is returned. (required)

129

body: object, The request body.

130

The object takes the form of:

131

132

{ # The batch translation request.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

133

"sourceLanguageCode": "A String", # Required. Source language code.

134

"outputConfig": { # Output configuration for BatchTranslateText request. # Required. Output configuration.

135

# If 2 input configs match to the same file (that is, same input path),

136

# we don't generate output for duplicate inputs.

137

"gcsDestination": { # The Google Cloud Storage location for the output content. # Google Cloud Storage destination for output content.

138

# For every single input file (for example, gs://a/b/c.[extension]), we

139

# generate at most 2 * n output files. (n is the # of target_language_codes

140

# in the BatchTranslateTextRequest).

141

#

142

# Output files (tsv) generated are compliant with RFC 4180 except that

143

# record delimiters are '\n' instead of '\r\n'. We don't provide any way to

144

# change record delimiters.

145

#

146

# While the input files are being processed, we write/update an index file

147

# 'index.csv' under 'output_uri_prefix' (for example,

148

# gs://translation-test/index.csv) The index file is generated/updated as

149

# new files are being translated. The format is:

150

#

151

# input_file,target_language_code,translations_file,errors_file,

152

# glossary_translations_file,glossary_errors_file

153

#

154

# input_file is one file we matched using gcs_source.input_uri.

155

# target_language_code is provided in the request.

156

# translations_file contains the translations. (details provided below)

157

# errors_file contains the errors during processing of the file. (details

158

# below). Both translations_file and errors_file could be empty

159

# strings if we have no content to output.

160

# glossary_translations_file and glossary_errors_file are always empty

161

# strings if the input_file is tsv. They could also be empty if we have no

162

# content to output.

163

#

164

# Once a row is present in index.csv, the input/output matching never

165

# changes. Callers should also expect all the content in input_file are

166

# processed and ready to be consumed (that is, no partial output file is

167

# written).

168

#

169

# The format of translations_file (for target language code 'trg') is:

170

# gs://translation_test/a_b_c_'trg'_translations.[extension]

171

#

172

# If the input file extension is tsv, the output has the following

173

# columns:

174

# Column 1: ID of the request provided in the input, if it's not

175

# provided in the input, then the input row number is used (0-based).

176

# Column 2: source sentence.

177

# Column 3: translation without applying a glossary. Empty string if there

178

# is an error.

179

# Column 4 (only present if a glossary is provided in the request):

180

# translation after applying the glossary. Empty string if there is an

181

# error applying the glossary. Could be same string as column 3 if there is

182

# no glossary applied.

183

#

184

# If input file extension is a txt or html, the translation is directly

185

# written to the output file. If glossary is requested, a separate

186

# glossary_translations_file has format of

187

# gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]

188

#

189

# The format of errors file (for target language code 'trg') is:

190

# gs://translation_test/a_b_c_'trg'_errors.[extension]

191

#

192

# If the input file extension is tsv, errors_file contains the following:

193

# Column 1: ID of the request provided in the input, if it's not

194

# provided in the input, then the input row number is used (0-based).

195

# Column 2: source sentence.

196

# Column 3: Error detail for the translation. Could be empty.

197

# Column 4 (only present if a glossary is provided in the request):

198

# Error when applying the glossary.

199

#

200

# If the input file extension is txt or html, glossary_error_file will be

201

# generated that contains error details. glossary_error_file has format of

202

# gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]

203

"outputUriPrefix": "A String", # Required. There must be no files under 'output_uri_prefix'.

204

# 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an

205

# INVALID_ARGUMENT (400) error is returned.

206

},

207

},

208

"inputConfigs": [ # Required. Input configurations.

209

# The total number of files matched should be <= 1000.

210

# The total content size should be <= 100M Unicode codepoints.

211

# The files must use UTF-8 encoding.

212

{ # Input configuration for BatchTranslateText request.

213

"gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location for the source input.

214

# This can be a single file (for example,

215

# `gs://translation-test/input.tsv`) or a wildcard (for example,

216

# `gs://translation-test/*`). If a file extension is `.tsv`, it can

217

# contain either one or two columns. The first column (optional) is the id

218

# of the text request. If the first column is missing, we use the row

219

# number (0-based) from the input file as the ID in the output file. The

220

# second column is the actual text to be

221

# translated. We recommend each row be <= 10K Unicode codepoints,

222

# otherwise an error might be returned.

223

# Note that the input tsv must be RFC 4180 compliant.

224

#

225

# You could use https://github.com/Clever/csvlint to check potential

226

# formatting errors in your tsv file.

227

# csvlint --delimiter='\t' your_input_file.tsv

228

#

229

# The other supported file extensions are `.txt` or `.html`, which is

230

# treated as a single large chunk of text.

231

"inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`.

232

},

233

"mimeType": "A String", # Optional. Can be "text/plain" or "text/html".

234

# For `.tsv`, "text/html" is used if mime_type is missing.

235

# For `.html`, this field must be "text/html" or empty.

236

# For `.txt`, this field must be "text/plain" or empty.

237

},

238

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

239

"glossaries": { # Optional. Glossaries to be applied for translation.

240

# It's keyed by target language code.

241

"a_key": { # Configures which glossary should be used for a specific target language,

242

# and defines options for applying that glossary.

243

"glossary": "A String", # Required. Specifies the glossary used for this translation. Use

244

# this format: projects/*/locations/*/glossaries/*

245

"ignoreCase": True or False, # Optional. Indicates match is case-insensitive.

246

# Default value is false if missing.

247

},

248

},

249

"models": { # Optional. The models to use for translation. Map's key is target language

250

# code. Map's value is model name. Value can be a built-in general model,

251

# or an AutoML Translation model.

252

#

253

# The value format depends on model type:

254

#

255

# - AutoML Translation models:

256

# `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

257

#

258

# - General (built-in) models:

259

# `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,

260

# `projects/{project-number-or-id}/locations/{location-id}/models/general/base`

261

#

262

#

263

# If the map is empty or a specific model is

264

# not requested for a language pair, then default google model (nmt) is used.

265

"a_key": "A String",

266

},

267

"labels": { # Optional. The labels with user-defined metadata for the request.

268

#

269

# Label keys and values can be no longer than 63 characters

270

# (Unicode codepoints), can only contain lowercase letters, numeric

271

# characters, underscores and dashes. International characters are allowed.

272

# Label values are optional. Label keys must start with a letter.

273

#

274

# See https://cloud.google.com/translate/docs/labels for more information.

275

"a_key": "A String",

276

},

277

"targetLanguageCodes": [ # Required. Specify up to 10 language codes here.

278

"A String",

279

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

280

}

281

282

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

289

290

{ # This resource represents a long-running operation that is the result of a

291

# network API call.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

292

"done": True or False, # If the value is `false`, it means the operation is still in progress.

293

# If `true`, the operation is completed, and either `error` or `response` is

294

# available.

295

"response": { # The normal response of the operation in case of success. If the original

296

# method returns no data on success, such as `Delete`, the response is

297

# `google.protobuf.Empty`. If the original method is standard

298

# `Get`/`Create`/`Update`, the response should be the resource. For other

299

# methods, the response should have the type `XxxResponse`, where `Xxx`

300

# is the original method name. For example, if the original method name

301

# is `TakeSnapshot()`, the inferred response type is

302

# `TakeSnapshotResponse`.

303

"a_key": "", # Properties of the object. Contains field @type with type URL.

304

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

305

"name": "A String", # The server-assigned name, which is only unique within the same service that

306

# originally returns it. If you use the default HTTP mapping, the

307

# `name` should be a resource name ending with `operations/{unique_id}`.

308

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

309

# different programming environments, including REST APIs and RPC APIs. It is

310

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

311

# three pieces of data: error code, error message, and error details.

312

#

313

# You can find out more about this error model and how to work with it in the

314

# [API Design Guide](https://cloud.google.com/apis/design/errors).

315

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

316

"message": "A String", # A developer-facing error message, which should be in English. Any

317

# user-facing error message should be localized and sent in the

318

# google.rpc.Status.details field, or localized by the client.

319

"details": [ # A list of messages that carry the error details. There is a common set of

320

# message types for APIs to use.

321

{

322

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"metadata": { # Service-specific metadata associated with the operation. It typically

327

# contains progress information and common metadata such as create time.

328

# Some services might not provide such metadata. Any method that returns a

329

# long-running operation should document the metadata type, if any.

330

"a_key": "", # Properties of the object. Contains field @type with type URL.

331

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="detectLanguage">detectLanguage(parent, body=None, x__xgafv=None)</code>

337

<pre>Detects the language of text within a request.

338

339

Args:

340

parent: string, Required. Project or location to make a call. Must refer to a caller's

341

project.

342

343

Format: `projects/{project-number-or-id}/locations/{location-id}` or

344

`projects/{project-number-or-id}`.

345

346

For global calls, use `projects/{project-number-or-id}/locations/global` or

347

`projects/{project-number-or-id}`.

348

349

Only models within the same region (has same location-id) can be used.

350

Otherwise an INVALID_ARGUMENT (400) error is returned. (required)

351

body: object, The request body.

352

The object takes the form of:

353

354

{ # The request message for language detection.

355

"content": "A String", # The content of the input stored as a string.

356

"model": "A String", # Optional. The language detection model to be used.

357

#

358

# Format:

359

# `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`

360

#

361

# Only one language detection model is currently supported:

362

# `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`.

363

#

364

# If not specified, the default model is used.

365

"mimeType": "A String", # Optional. The format of the source text, for example, "text/html",

366

# "text/plain". If left blank, the MIME type defaults to "text/html".

367

"labels": { # Optional. The labels with user-defined metadata for the request.

368

#

369

# Label keys and values can be no longer than 63 characters

370

# (Unicode codepoints), can only contain lowercase letters, numeric

371

# characters, underscores and dashes. International characters are allowed.

372

# Label values are optional. Label keys must start with a letter.

373

#

374

# See https://cloud.google.com/translate/docs/labels for more information.

"a_key": "A String",

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

386

387

{ # The response message for language detection.

388

"languages": [ # A list of detected languages sorted by detection confidence in descending

389

# order. The most probable language first.

390

{ # The response message for language detection.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

391

"languageCode": "A String", # The BCP-47 language code of source content in the request, detected

392

# automatically.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

393

"confidence": 3.14, # The confidence of the detection result for this language.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

401

<pre>Gets information about a location.

402

403

Args:

404

name: string, Resource name for the location. (required)

405

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

412

413

{ # A resource that represents Google Cloud Platform location.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

414

"labels": { # Cross-service attributes for the location. For example

415

#

416

# {"cloud.googleapis.com/region": "us-east1"}

417

"a_key": "A String",

418

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

419

"name": "A String", # Resource name for the location, which may vary between implementations.

420

# For example: `"projects/example-project/locations/us-east1"`

421

"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.

422

"displayName": "A String", # The friendly name for this location, typically a nearby city name.

423

# For example, "Tokyo".

424

"metadata": { # Service-specific metadata. For example the available capacity at the given

425

# location.

426

"a_key": "", # Properties of the object. Contains field @type with type URL.

427

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getSupportedLanguages">getSupportedLanguages(parent, displayLanguageCode=None, model=None, x__xgafv=None)</code>

433

<pre>Returns a list of supported languages for translation.

434

435

Args:

436

parent: string, Required. Project or location to make a call. Must refer to a caller's

437

project.

438

439

Format: `projects/{project-number-or-id}` or

440

`projects/{project-number-or-id}/locations/{location-id}`.

441

442

For global calls, use `projects/{project-number-or-id}/locations/global` or

443

`projects/{project-number-or-id}`.

444

445

Non-global location is required for AutoML models.

446

447

Only models within the same region (have same location-id) can be used,

448

otherwise an INVALID_ARGUMENT (400) error is returned. (required)

449

displayLanguageCode: string, Optional. The language to use to return localized, human readable names

450

of supported languages. If missing, then display names are not returned

451

in a response.

452

model: string, Optional. Get supported languages of this model.

453

454

The format depends on model type:

455

456

- AutoML Translation models:

457

`projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

458

459

- General (built-in) models:

460

`projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,

461

`projects/{project-number-or-id}/locations/{location-id}/models/general/base`

462

463

464

Returns languages supported by the specified model.

465

If missing, we get supported languages of Google general base (PBMT) model.

466

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

473

474

{ # The response message for discovering supported languages.

475

"languages": [ # A list of supported language responses. This list contains an entry

476

# for each language the Translation API supports.

477

{ # A single supported language response corresponds to information related

478

# to one supported language.

479

"supportSource": True or False, # Can be used as source language.

480

"languageCode": "A String", # Supported language code, generally consisting of its ISO 639-1

481

# identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes

482

# including language and region identifiers are returned (for example,

483

# 'zh-TW' and 'zh-CN')

484

"supportTarget": True or False, # Can be used as target language.

485

"displayName": "A String", # Human readable name of the language localized in the display language

486

# specified in the request.

},

],

}</pre>

</div>

<code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>

494

<pre>Lists information about the supported locations for this service.

495

496

Args:

497

name: string, The resource that owns the locations collection, if applicable. (required)

498

pageToken: string, The standard list page token.

499

pageSize: integer, The standard list page size.

500

filter: string, The standard list filter.

501

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

508

509

{ # The response message for Locations.ListLocations.

510

"locations": [ # A list of locations that matches the specified filter in the request.

511

{ # A resource that represents Google Cloud Platform location.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

512

"labels": { # Cross-service attributes for the location. For example

513

#

514

# {"cloud.googleapis.com/region": "us-east1"}

515

"a_key": "A String",

516

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

517

"name": "A String", # Resource name for the location, which may vary between implementations.

518

# For example: `"projects/example-project/locations/us-east1"`

519

"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.

520

"displayName": "A String", # The friendly name for this location, typically a nearby city name.

521

# For example, "Tokyo".

522

"metadata": { # Service-specific metadata. For example the available capacity at the given

523

# location.

524

"a_key": "", # Properties of the object. Contains field @type with type URL.

525

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

526

},

527

],

528

"nextPageToken": "A String", # The standard List next-page token.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

534

<pre>Retrieves the next page of results.

535

536

Args:

537

previous_request: The request for the previous page. (required)

538

previous_response: The response from the request for the previous page. (required)

539

540

Returns:

541

A request object that you can call 'execute()' on to request the next

542

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="translateText">translateText(parent, body=None, x__xgafv=None)</code>

548

<pre>Translates input text and returns translated text.

549

550

Args:

551

parent: string, Required. Project or location to make a call. Must refer to a caller's

552

project.

553

554

Format: `projects/{project-number-or-id}` or

555

`projects/{project-number-or-id}/locations/{location-id}`.

556

557

For global calls, use `projects/{project-number-or-id}/locations/global` or

558

`projects/{project-number-or-id}`.

559

560

Non-global location is required for requests using AutoML models or

561

custom glossaries.

562

563

Models and glossaries must be within the same region (have same

564

location-id), otherwise an INVALID_ARGUMENT (400) error is returned. (required)

565

body: object, The request body.

566

The object takes the form of:

567

568

{ # The request message for synchronous translation.

569

"targetLanguageCode": "A String", # Required. The BCP-47 language code to use for translation of the input

570

# text, set to one of the language codes listed in Language Support.

571

"sourceLanguageCode": "A String", # Optional. The BCP-47 language code of the input text if

572

# known, for example, "en-US" or "sr-Latn". Supported language codes are

573

# listed in Language Support. If the source language isn't specified, the API

574

# attempts to identify the source language automatically and returns the

575

# source language within the response.

576

"model": "A String", # Optional. The `model` type requested for this translation.

577

#

578

# The format depends on model type:

579

#

580

# - AutoML Translation models:

581

# `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`

582

#

583

# - General (built-in) models:

584

# `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,

585

# `projects/{project-number-or-id}/locations/{location-id}/models/general/base`

586

#

587

#

588

# For global (non-regionalized) requests, use `location-id` `global`.

589

# For example,

590

# `projects/{project-number-or-id}/locations/global/models/general/nmt`.

591

#

592

# If missing, the system decides which google base model to use.

593

"contents": [ # Required. The content of the input in string format.

594

# We recommend the total content be less than 30k codepoints.

595

# Use BatchTranslateText for larger text.

596

"A String",

597

],

598

"mimeType": "A String", # Optional. The format of the source text, for example, "text/html",

599

# "text/plain". If left blank, the MIME type defaults to "text/html".

600

"glossaryConfig": { # Configures which glossary should be used for a specific target language, # Optional. Glossary to be applied. The glossary must be

601

# within the same region (have the same location-id) as the model, otherwise

602

# an INVALID_ARGUMENT (400) error is returned.

603

# and defines options for applying that glossary.

604

"glossary": "A String", # Required. Specifies the glossary used for this translation. Use

605

# this format: projects/*/locations/*/glossaries/*

606

"ignoreCase": True or False, # Optional. Indicates match is case-insensitive.

607

# Default value is false if missing.

608

},

609

"labels": { # Optional. The labels with user-defined metadata for the request.

610

#

611

# Label keys and values can be no longer than 63 characters

612

# (Unicode codepoints), can only contain lowercase letters, numeric

613

# characters, underscores and dashes. International characters are allowed.

614

# Label values are optional. Label keys must start with a letter.

615

#

616

# See https://cloud.google.com/translate/docs/labels for more information.

"a_key": "A String",

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

628

629

{

630

"glossaryTranslations": [ # Text translation responses if a glossary is provided in the request.

631

# This can be the same as

632

# `translations` if no terms apply.

633

# This field has the same length as

634

# `contents`.

635

{ # A single translation response.

636

"model": "A String", # Only present when `model` is present in the request.

637

# `model` here is normalized to have project number.

638

#

639

# For example:

640

# If the `model` requested in TranslationTextRequest is

641

# `projects/{project-id}/locations/{location-id}/models/general/nmt` then

642

# `model` here would be normalized to

643

# `projects/{project-number}/locations/{location-id}/models/general/nmt`.

644

"translatedText": "A String", # Text translated into the target language.

645

"detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected

646

# automatically, if no source language was passed within the initial

647

# request. If the source language was passed, auto-detection of the language

648

# does not occur and this field is empty.

649

"glossaryConfig": { # Configures which glossary should be used for a specific target language, # The `glossary_config` used for this translation.

650

# and defines options for applying that glossary.

651

"glossary": "A String", # Required. Specifies the glossary used for this translation. Use

652

# this format: projects/*/locations/*/glossaries/*

653

"ignoreCase": True or False, # Optional. Indicates match is case-insensitive.

654

# Default value is false if missing.

},

},

],

"translations": [ # Text translation responses with no glossary applied.

659

# This field has the same length as

660

# `contents`.

661

{ # A single translation response.

662

"model": "A String", # Only present when `model` is present in the request.

663

# `model` here is normalized to have project number.

664

#

665

# For example:

666

# If the `model` requested in TranslationTextRequest is

667

# `projects/{project-id}/locations/{location-id}/models/general/nmt` then

668

# `model` here would be normalized to

669

# `projects/{project-number}/locations/{location-id}/models/general/nmt`.

670

"translatedText": "A String", # Text translated into the target language.

671

"detectedLanguageCode": "A String", # The BCP-47 language code of source text in the initial request, detected

672

# automatically, if no source language was passed within the initial

673

# request. If the source language was passed, auto-detection of the language

674

# does not occur and this field is empty.

675

"glossaryConfig": { # Configures which glossary should be used for a specific target language, # The `glossary_config` used for this translation.

676

# and defines options for applying that glossary.

677

"glossary": "A String", # Required. Specifies the glossary used for this translation. Use

678

# this format: projects/*/locations/*/glossaries/*

679

"ignoreCase": True or False, # Optional. Indicates match is case-insensitive.

680

# Default value is false if missing.

},

},

],

}</pre>

</div>

</body></html>