chore: mostly comment changes and an added resource test file

Author: apaparazzi0329

assistant/v2.ts

@@ -395,8 +395,7 @@ class AssistantV2 extends BaseService {
    *
    * List the events from the log of an assistant.
    *
-   * If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is
-   * specified, the limit is 120 requests per minute. For more information, see **Rate limiting**.
+   * This method is available only with Premium plans.
    *
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.assistantId - Unique identifier of the assistant. To find the assistant ID in the Watson

language-translator/v3.ts

@@ -20,8 +20,8 @@ import { Authenticator, BaseService, getAuthenticatorFromEnvironment, getMissing
 import { getSdkHeaders } from '../lib/common';
 
 /**
- * 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
+ * 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.
  */
@@ -128,16 +128,20 @@ class LanguageTranslatorV3 extends BaseService {
   /**
    * Translate.
    *
-   * Translates the input text from the source language to the target language. A target language or translation model
-   * ID is required. The service attempts to detect the language of the source text if it is not specified.
+   * Translates the input text from the source language to the target language. Specify a model ID that indicates the
+   * source and target languages, or specify the source and target languages individually. You can omit the source
+   * language to have the service attempt to detect the language from the input text. If you omit the source language,
+   * the request must contain sufficient input text for the service to identify the source language.
    *
    * @param {Object} params - The parameters to send to the service.
-   * @param {string[]} params.text - Input text in UTF-8 encoding. Multiple entries will result in multiple translations
-   * in the response.
-   * @param {string} [params.modelId] - The model to use for translation. For example, `en-de` selects the IBM provided
-   * base model for English to German translation. A model ID overrides the source and target parameters and is required
-   * if you use a custom model. If no model ID is specified, you must specify a target language.
-   * @param {string} [params.source] - Language code that specifies the language of the source document.
+   * @param {string[]} params.text - Input text in UTF-8 encoding. Multiple entries result in multiple translations in
+   * the response.
+   * @param {string} [params.modelId] - The model to use for translation. For example, `en-de` selects the IBM-provided
+   * base model for English-to-German translation. A model ID overrides the `source` and `target` parameters and is
+   * required if you use a custom model. If no model ID is specified, you must specify at least a target language.
+   * @param {string} [params.source] - Language code that specifies the language of the input text. If omitted, the
+   * service derives the source language from the input text. The input must contain sufficient text for the service to
+   * identify the language reliably.
    * @param {string} [params.target] - Language code that specifies the target language for translation. Required if
    * model ID is not specified.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -325,10 +329,10 @@ class LanguageTranslatorV3 extends BaseService {
    * @param {Object} [params] - The parameters to send to the service.
    * @param {string} [params.source] - Specify a language code to filter results by source language.
    * @param {string} [params.target] - Specify a language code to filter results by target language.
-   * @param {boolean} [params._default] - If the default parameter isn't specified, the service will return all models
-   * (default and non-default) for each language pair. To return only default models, set this to `true`. To return only
-   * non-default models, set this to `false`. There is exactly one default model per language pair, the IBM provided
-   * base model.
+   * @param {boolean} [params._default] - If the `default` parameter isn't specified, the service returns all models
+   * (default and non-default) for each language pair. To return only default models, set this parameter to `true`. To
+   * return only non-default models, set this parameter to `false`. There is exactly one default model, the IBM-provided
+   * base model, per language pair.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
    * @param {Function} [callback] - The callback that handles the response
    * @returns {Promise<LanguageTranslatorV3.Response<LanguageTranslatorV3.TranslationModels>>}
@@ -600,7 +604,7 @@ class LanguageTranslatorV3 extends BaseService {
    * Get model details.
    *
    * Gets information about a translation model, including training status for custom models. Use this API call to poll
-   * the status of your customization request. A successfully completed training will have a status of `available`.
+   * the status of your customization request. A successfully completed training has a status of `available`.
    *
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.modelId - Model ID of the model to get.
@@ -726,11 +730,12 @@ class LanguageTranslatorV3 extends BaseService {
    * Maximum file size: **20 MB**.
    * @param {string} params.filename - The filename for file.
    * @param {string} [params.fileContentType] - The content type of file.
-   * @param {string} [params.modelId] - The model to use for translation. For example, `en-de` selects the IBM provided
-   * base model for English to German translation. A model ID overrides the source and target parameters and is required
-   * if you use a custom model. If no model ID is specified, you must specify a target language.
+   * @param {string} [params.modelId] - The model to use for translation. For example, `en-de` selects the IBM-provided
+   * base model for English-to-German translation. A model ID overrides the `source` and `target` parameters and is
+   * required if you use a custom model. If no model ID is specified, you must specify at least a target language.
    * @param {string} [params.source] - Language code that specifies the language of the source document. If omitted, the
-   * service derives the source language from the input text.
+   * service derives the source language from the input text. The input must contain sufficient text for the service to
+   * identify the language reliably.
    * @param {string} [params.target] - Language code that specifies the target language for translation. Required if
    * model ID is not specified.
    * @param {string} [params.documentId] - To use a previously submitted document as the source for a new translation,
@@ -1036,14 +1041,17 @@ namespace LanguageTranslatorV3 {
 
   /** Parameters for the `translate` operation. */
   export interface TranslateParams {
-    /** Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. */
+    /** Input text in UTF-8 encoding. Multiple entries result in multiple translations in the response. */
     text: string[];
-    /** The model to use for translation. For example, `en-de` selects the IBM provided base model for English to
-     *  German translation. A model ID overrides the source and target parameters and is required if you use a custom
-     *  model. If no model ID is specified, you must specify a target language.
+    /** The model to use for translation. For example, `en-de` selects the IBM-provided base model for
+     *  English-to-German translation. A model ID overrides the `source` and `target` parameters and is required if you
+     *  use a custom model. If no model ID is specified, you must specify at least a target language.
      */
     modelId?: string;
-    /** Language code that specifies the language of the source document. */
+    /** Language code that specifies the language of the input text. If omitted, the service derives the source
+     *  language from the input text. The input must contain sufficient text for the service to identify the language
+     *  reliably.
+     */
     source?: string;
     /** Language code that specifies the target language for translation. Required if model ID is not specified. */
     target?: string;
@@ -1068,9 +1076,10 @@ namespace LanguageTranslatorV3 {
     source?: string;
     /** Specify a language code to filter results by target language. */
     target?: string;
-    /** If the default parameter isn't specified, the service will return all models (default and non-default) for
-     *  each language pair. To return only default models, set this to `true`. To return only non-default models, set
-     *  this to `false`. There is exactly one default model per language pair, the IBM provided base model.
+    /** If the `default` parameter isn't specified, the service returns all models (default and non-default) for
+     *  each language pair. To return only default models, set this parameter to `true`. To return only non-default
+     *  models, set this parameter to `false`. There is exactly one default model, the IBM-provided base model, per
+     *  language pair.
      */
     _default?: boolean;
     headers?: OutgoingHttpHeaders;
@@ -1146,13 +1155,14 @@ namespace LanguageTranslatorV3 {
     filename: string;
     /** The content type of file. */
     fileContentType?: TranslateDocumentConstants.FileContentType | string;
-    /** The model to use for translation. For example, `en-de` selects the IBM provided base model for English to
-     *  German translation. A model ID overrides the source and target parameters and is required if you use a custom
-     *  model. If no model ID is specified, you must specify a target language.
+    /** The model to use for translation. For example, `en-de` selects the IBM-provided base model for
+     *  English-to-German translation. A model ID overrides the `source` and `target` parameters and is required if you
+     *  use a custom model. If no model ID is specified, you must specify at least a target language.
      */
     modelId?: string;
     /** Language code that specifies the language of the source document. If omitted, the service derives the source
-     *  language from the input text.
+     *  language from the input text. The input must contain sufficient text for the service to identify the language
+     *  reliably.
      */
     source?: string;
     /** Language code that specifies the target language for translation. Required if model ID is not specified. */

natural-language-understanding/v1.ts

@@ -89,7 +89,7 @@ class NaturalLanguageUnderstandingV1 extends BaseService {
    * - Relations
    * - Semantic roles
    * - Sentiment
-   * - Syntax (Experimental).
+   * - Syntax.
    *
    * If a language for the input text is not specified with the `language` parameter, the service [automatically detects
    * the

speech-to-text/v1-generated.ts

@@ -360,9 +360,8 @@ class SpeechToTextV1 extends BaseService {
    * `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify
    * `false` for the parameter.
    *
-   * **Note:** Applies to US English, German, Japanese, Korean, and Spanish (both broadband and narrowband models) and
-   * UK English (narrowband model) transcription only. To determine whether a language model supports speaker labels,
-   * you can also use the **Get a model** method and check that the attribute `speaker_labels` is set to `true`.
+   * **Note:** Applies to US English, Australian English, German, Japanese, Korean, and Spanish (both broadband and
+   * narrowband models) and UK English (narrowband model) transcription only.
    *
    * See [Speaker labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
    * @param {string} [params.customizationId] - **Deprecated.** Use the `language_customization_id` parameter to specify
@@ -881,9 +880,8 @@ class SpeechToTextV1 extends BaseService {
    * `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify
    * `false` for the parameter.
    *
-   * **Note:** Applies to US English, German, Japanese, Korean, and Spanish (both broadband and narrowband models) and
-   * UK English (narrowband model) transcription only. To determine whether a language model supports speaker labels,
-   * you can also use the **Get a model** method and check that the attribute `speaker_labels` is set to `true`.
+   * **Note:** Applies to US English, Australian English, German, Japanese, Korean, and Spanish (both broadband and
+   * narrowband models) and UK English (narrowband model) transcription only.
    *
    * See [Speaker labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
    * @param {string} [params.customizationId] - **Deprecated.** Use the `language_customization_id` parameter to specify
@@ -4168,6 +4166,8 @@ namespace SpeechToTextV1 {
       AR_AR_BROADBANDMODEL = 'ar-AR_BroadbandModel',
       DE_DE_BROADBANDMODEL = 'de-DE_BroadbandModel',
       DE_DE_NARROWBANDMODEL = 'de-DE_NarrowbandModel',
+      EN_AU_BROADBANDMODEL = 'en-AU_BroadbandModel',
+      EN_AU_NARROWBANDMODEL = 'en-AU_NarrowbandModel',
       EN_GB_BROADBANDMODEL = 'en-GB_BroadbandModel',
       EN_GB_NARROWBANDMODEL = 'en-GB_NarrowbandModel',
       EN_US_BROADBANDMODEL = 'en-US_BroadbandModel',
@@ -4318,10 +4318,8 @@ namespace SpeechToTextV1 {
      *  multi-person exchange. By default, the service returns no speaker labels. Setting `speaker_labels` to `true`
      *  forces the `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter.
      *
-     *  **Note:** Applies to US English, German, Japanese, Korean, and Spanish (both broadband and narrowband models)
-     *  and UK English (narrowband model) transcription only. To determine whether a language model supports speaker
-     *  labels, you can also use the **Get a model** method and check that the attribute `speaker_labels` is set to
-     *  `true`.
+     *  **Note:** Applies to US English, Australian English, German, Japanese, Korean, and Spanish (both broadband and
+     *  narrowband models) and UK English (narrowband model) transcription only.
      *
      *  See [Speaker labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
      */
@@ -4438,6 +4436,8 @@ namespace SpeechToTextV1 {
       AR_AR_BROADBANDMODEL = 'ar-AR_BroadbandModel',
       DE_DE_BROADBANDMODEL = 'de-DE_BroadbandModel',
       DE_DE_NARROWBANDMODEL = 'de-DE_NarrowbandModel',
+      EN_AU_BROADBANDMODEL = 'en-AU_BroadbandModel',
+      EN_AU_NARROWBANDMODEL = 'en-AU_NarrowbandModel',
       EN_GB_BROADBANDMODEL = 'en-GB_BroadbandModel',
       EN_GB_NARROWBANDMODEL = 'en-GB_NarrowbandModel',
       EN_US_BROADBANDMODEL = 'en-US_BroadbandModel',
@@ -4647,10 +4647,8 @@ namespace SpeechToTextV1 {
      *  multi-person exchange. By default, the service returns no speaker labels. Setting `speaker_labels` to `true`
      *  forces the `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter.
      *
-     *  **Note:** Applies to US English, German, Japanese, Korean, and Spanish (both broadband and narrowband models)
-     *  and UK English (narrowband model) transcription only. To determine whether a language model supports speaker
-     *  labels, you can also use the **Get a model** method and check that the attribute `speaker_labels` is set to
-     *  `true`.
+     *  **Note:** Applies to US English, Australian English, German, Japanese, Korean, and Spanish (both broadband and
+     *  narrowband models) and UK English (narrowband model) transcription only.
      *
      *  See [Speaker labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#speaker_labels).
      */
@@ -4790,6 +4788,8 @@ namespace SpeechToTextV1 {
       AR_AR_BROADBANDMODEL = 'ar-AR_BroadbandModel',
       DE_DE_BROADBANDMODEL = 'de-DE_BroadbandModel',
       DE_DE_NARROWBANDMODEL = 'de-DE_NarrowbandModel',
+      EN_AU_BROADBANDMODEL = 'en-AU_BroadbandModel',
+      EN_AU_NARROWBANDMODEL = 'en-AU_NarrowbandModel',
       EN_GB_BROADBANDMODEL = 'en-GB_BroadbandModel',
       EN_GB_NARROWBANDMODEL = 'en-GB_NarrowbandModel',
       EN_US_BROADBANDMODEL = 'en-US_BroadbandModel',
@@ -6274,7 +6274,12 @@ namespace SpeechToTextV1 {
      *  language model.
      */
     custom_language_model: boolean;
-    /** Indicates whether the `speaker_labels` parameter can be used with the language model. */
+    /** Indicates whether the `speaker_labels` parameter can be used with the language model.
+     *
+     *  **Note:** The field returns `true` for all models. However, speaker labels are supported only for US English,
+     *  Australian English, German, Japanese, Korean, and Spanish (both broadband and narrowband models) and UK English
+     *  (narrowband model only). Speaker labels are not supported for any other models.
+     */
     speaker_labels: boolean;
   }
 

test/resources/TestEnrichments.csv

@@ -0,0 +1,3 @@
+engine,gasket,carburetor,piston,valves
+racing,stock,open,indy,drag
+flag,checkered,green,caution,yellow,red

test/unit/visual-recognition.v3.test.js

@@ -29,7 +29,7 @@ const {
 
 const service = {
   authenticator: new NoAuthAuthenticator(),
-  url: 'https://gateway.watsonplatform.net/visual-recognition/api/visual-recognition/api',
+  url: 'https://api.us-south.visual-recognition.watson.cloud.ibm.com',
   version: '2018-10-18',
 };
 

test/unit/visual-recognition.v4.test.js

@@ -28,7 +28,7 @@ const {
 
 const service = {
   authenticator: new NoAuthAuthenticator(),
-  url: 'https://gateway.watsonplatform.net/visual-recognition/api/visual-recognition/api',
+  url: 'https://api.us-south.visual-recognition.watson.cloud.ibm.com',
   version: '2018-10-18',
 };
 

visual-recognition/v3.ts

@@ -27,7 +27,7 @@ import { getSdkHeaders } from '../lib/common';
 
 class VisualRecognitionV3 extends BaseService {
 
-  static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/visual-recognition/api';
+  static DEFAULT_SERVICE_URL: string = 'https://api.us-south.visual-recognition.watson.cloud.ibm.com';
   static DEFAULT_SERVICE_NAME: string = 'watson_vision_combined';
 
   /**
@@ -40,7 +40,7 @@ class VisualRecognitionV3 extends BaseService {
    * programmatically specify the current date at runtime, in case the API has been updated since your application's
    * release. Instead, specify a version date that is compatible with your application, and don't change it until your
    * application is ready for a later version.
-   * @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/visual-recognition/api'). The base url may differ between IBM Cloud regions.
+   * @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net'). The base url may differ between IBM Cloud regions.
    * @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
    * @param {string} [options.serviceName] - The name of the service to configure
    * @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set