Skip to content

Commit e7989cf

Browse files
committed
refactor(language-translator): v4 changes
1 parent 1c20e07 commit e7989cf

File tree

3 files changed

+75
-245
lines changed

3 files changed

+75
-245
lines changed

language-translator/v3.ts

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@
1616

1717
import { AxiosResponse } from 'axios';
1818
import * as extend from 'extend';
19-
import { BaseService, FileObject, getMissingParams } from 'ibm-cloud-sdk-core';
19+
import { BaseService, getMissingParams } from 'ibm-cloud-sdk-core';
2020
import { getSdkHeaders } from '../lib/common';
21+
import { FileObject } from 'ibm-cloud-sdk-core';
2122

2223
/**
2324
* IBM Watson™ Language Translator translates text from one language to another. The service offers multiple IBM provided translation models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.
@@ -74,7 +75,7 @@ class LanguageTranslatorV3 extends BaseService {
7475
* @param {string} [params.target] - Translation target language code.
7576
* @param {Object} [params.headers] - Custom request headers
7677
* @param {Function} [callback] - The callback that handles the response.
77-
* @returns {NodeJS.ReadableStream|void}
78+
* @returns {Promise<any>|void}
7879
*/
7980
public translate(params: LanguageTranslatorV3.TranslateParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.TranslationResult>): Promise<any> | void {
8081
const _params = extend({}, params);
@@ -102,12 +103,11 @@ class LanguageTranslatorV3 extends BaseService {
102103
};
103104

104105
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'translate');
105-
106+
106107
const parameters = {
107108
options: {
108109
url: '/v3/translate',
109110
method: 'POST',
110-
json: true,
111111
body,
112112
},
113113
defaultOptions: extend(true, {}, this._options, {
@@ -134,7 +134,7 @@ class LanguageTranslatorV3 extends BaseService {
134134
* @param {string} params.text - Input text in UTF-8 format.
135135
* @param {Object} [params.headers] - Custom request headers
136136
* @param {Function} [callback] - The callback that handles the response.
137-
* @returns {NodeJS.ReadableStream|void}
137+
* @returns {Promise<any>|void}
138138
*/
139139
public identify(params: LanguageTranslatorV3.IdentifyParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.IdentifiedLanguages>): Promise<any> | void {
140140
const _params = extend({}, params);
@@ -156,12 +156,11 @@ class LanguageTranslatorV3 extends BaseService {
156156
const body = _params.text;
157157

158158
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'identify');
159-
159+
160160
const parameters = {
161161
options: {
162162
url: '/v3/identify',
163163
method: 'POST',
164-
json: false,
165164
body,
166165
},
167166
defaultOptions: extend(true, {}, this._options, {
@@ -184,7 +183,7 @@ class LanguageTranslatorV3 extends BaseService {
184183
* @param {Object} [params] - The parameters to send to the service.
185184
* @param {Object} [params.headers] - Custom request headers
186185
* @param {Function} [callback] - The callback that handles the response.
187-
* @returns {NodeJS.ReadableStream|void}
186+
* @returns {Promise<any>|void}
188187
*/
189188
public listIdentifiableLanguages(params?: LanguageTranslatorV3.ListIdentifiableLanguagesParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.IdentifiableLanguages>): Promise<any> | void {
190189
const _params = (typeof params === 'function' && !callback) ? {} : extend({}, params);
@@ -199,7 +198,7 @@ class LanguageTranslatorV3 extends BaseService {
199198
}
200199

201200
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'listIdentifiableLanguages');
202-
201+
203202
const parameters = {
204203
options: {
205204
url: '/v3/identifiable_languages',
@@ -240,8 +239,6 @@ class LanguageTranslatorV3 extends BaseService {
240239
* available models, use the `List models` method. Usually all IBM provided models are customizable. In addition, all
241240
* your models that have been created via parallel corpus customization, can be further customized with a forced
242241
* glossary.
243-
* @param {string} [params.name] - An optional model name that you can use to identify the model. Valid characters are
244-
* letters, numbers, dashes, underscores, spaces and apostrophes. The maximum length is 32 characters.
245242
* @param {NodeJS.ReadableStream|FileObject|Buffer} [params.forced_glossary] - A TMX file with your customizations.
246243
* The customizations in the file completely overwrite the domain translaton data, including high frequency or high
247244
* confidence phrase translations. You can upload only one glossary with a file size less than 10 MB per call. A
@@ -250,11 +247,11 @@ class LanguageTranslatorV3 extends BaseService {
250247
* source and target language. You can upload multiple parallel_corpus files in one request. All uploaded
251248
* parallel_corpus files combined, your parallel corpus must contain at least 5,000 parallel sentences to train
252249
* successfully.
253-
* @param {string} [params.forced_glossary_filename] - The filename for forced_glossary.
254-
* @param {string} [params.parallel_corpus_filename] - The filename for parallel_corpus.
250+
* @param {string} [params.name] - An optional model name that you can use to identify the model. Valid characters are
251+
* letters, numbers, dashes, underscores, spaces and apostrophes. The maximum length is 32 characters.
255252
* @param {Object} [params.headers] - Custom request headers
256253
* @param {Function} [callback] - The callback that handles the response.
257-
* @returns {NodeJS.ReadableStream|void}
254+
* @returns {Promise<any>|void}
258255
*/
259256
public createModel(params: LanguageTranslatorV3.CreateModelParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.TranslationModel>): Promise<any> | void {
260257
const _params = extend({}, params);
@@ -273,16 +270,13 @@ class LanguageTranslatorV3 extends BaseService {
273270
if (missingParams) {
274271
return _callback(missingParams);
275272
}
276-
277273
const formData = {
278274
'forced_glossary': {
279275
data: _params.forced_glossary,
280-
filename: _params.forced_glossary_filename,
281276
contentType: 'application/octet-stream'
282277
},
283278
'parallel_corpus': {
284279
data: _params.parallel_corpus,
285-
filename: _params.parallel_corpus_filename,
286280
contentType: 'application/octet-stream'
287281
}
288282
};
@@ -293,7 +287,7 @@ class LanguageTranslatorV3 extends BaseService {
293287
};
294288

295289
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'createModel');
296-
290+
297291
const parameters = {
298292
options: {
299293
url: '/v3/models',
@@ -321,7 +315,7 @@ class LanguageTranslatorV3 extends BaseService {
321315
* @param {string} params.model_id - Model ID of the model to delete.
322316
* @param {Object} [params.headers] - Custom request headers
323317
* @param {Function} [callback] - The callback that handles the response.
324-
* @returns {NodeJS.ReadableStream|void}
318+
* @returns {Promise<any>|void}
325319
*/
326320
public deleteModel(params: LanguageTranslatorV3.DeleteModelParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.DeleteModelResult>): Promise<any> | void {
327321
const _params = extend({}, params);
@@ -346,7 +340,7 @@ class LanguageTranslatorV3 extends BaseService {
346340
};
347341

348342
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'deleteModel');
349-
343+
350344
const parameters = {
351345
options: {
352346
url: '/v3/models/{model_id}',
@@ -373,7 +367,7 @@ class LanguageTranslatorV3 extends BaseService {
373367
* @param {string} params.model_id - Model ID of the model to get.
374368
* @param {Object} [params.headers] - Custom request headers
375369
* @param {Function} [callback] - The callback that handles the response.
376-
* @returns {NodeJS.ReadableStream|void}
370+
* @returns {Promise<any>|void}
377371
*/
378372
public getModel(params: LanguageTranslatorV3.GetModelParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.TranslationModel>): Promise<any> | void {
379373
const _params = extend({}, params);
@@ -398,7 +392,7 @@ class LanguageTranslatorV3 extends BaseService {
398392
};
399393

400394
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'getModel');
401-
395+
402396
const parameters = {
403397
options: {
404398
url: '/v3/models/{model_id}',
@@ -429,7 +423,7 @@ class LanguageTranslatorV3 extends BaseService {
429423
* provided base model.
430424
* @param {Object} [params.headers] - Custom request headers
431425
* @param {Function} [callback] - The callback that handles the response.
432-
* @returns {NodeJS.ReadableStream|void}
426+
* @returns {Promise<any>|void}
433427
*/
434428
public listModels(params?: LanguageTranslatorV3.ListModelsParams, callback?: LanguageTranslatorV3.Callback<LanguageTranslatorV3.TranslationModels>): Promise<any> | void {
435429
const _params = (typeof params === 'function' && !callback) ? {} : extend({}, params);
@@ -450,7 +444,7 @@ class LanguageTranslatorV3 extends BaseService {
450444
};
451445

452446
const sdkHeaders = getSdkHeaders('language_translator', 'v3', 'listModels');
453-
447+
454448
const parameters = {
455449
options: {
456450
url: '/v3/models',
@@ -533,16 +527,12 @@ namespace LanguageTranslatorV3 {
533527
export interface CreateModelParams {
534528
/** The model ID of the model to use as the base for customization. To see available models, use the `List models` method. Usually all IBM provided models are customizable. In addition, all your models that have been created via parallel corpus customization, can be further customized with a forced glossary. */
535529
base_model_id: string;
536-
/** An optional model name that you can use to identify the model. Valid characters are letters, numbers, dashes, underscores, spaces and apostrophes. The maximum length is 32 characters. */
537-
name?: string;
538530
/** A TMX file with your customizations. The customizations in the file completely overwrite the domain translaton data, including high frequency or high confidence phrase translations. You can upload only one glossary with a file size less than 10 MB per call. A forced glossary should contain single words or short phrases. */
539531
forced_glossary?: NodeJS.ReadableStream|FileObject|Buffer;
540532
/** A TMX file with parallel sentences for source and target language. You can upload multiple parallel_corpus files in one request. All uploaded parallel_corpus files combined, your parallel corpus must contain at least 5,000 parallel sentences to train successfully. */
541533
parallel_corpus?: NodeJS.ReadableStream|FileObject|Buffer;
542-
/** The filename for forced_glossary. */
543-
forced_glossary_filename?: string;
544-
/** The filename for parallel_corpus. */
545-
parallel_corpus_filename?: string;
534+
/** An optional model name that you can use to identify the model. Valid characters are letters, numbers, dashes, underscores, spaces and apostrophes. The maximum length is 32 characters. */
535+
name?: string;
546536
headers?: Object;
547537
return_response?: boolean;
548538
}

test/integration/language_translator.v3.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const TWENTY_SECONDS = 20000;
1010
describe('language_translator_integration', function() {
1111
jest.setTimeout(TWENTY_SECONDS * 2);
1212

13-
auth.language_translator.v3.version = '2018-05-01';
13+
auth.language_translator.v3.version = '2019-03-27';
1414
const language_translator = new LanguageTranslatorV3(auth.language_translator.v3);
1515

1616
it('listModels()', function(done) {

0 commit comments

Comments
 (0)