refactor(assistantv2): update model names

watson-developer-cloud · Mar 16, 2023 · f28958b · f28958b
1 parent 005122b
commit f28958b
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 37 deletions.
diff --git a/assistant/v1.ts b/assistant/v1.ts
@@ -648,8 +648,8 @@ class AssistantV1 extends BaseService {
    * content of the new workspace.
    *
    * A successful call to this method only initiates asynchronous creation of the workspace. The new workspace is not
-   * available until processing completes. To check the status of the asynchronous operation, use the **Export workspace
-   * asynchronously** method.
+   * available until processing completes. To check the status of the asynchronous operation, use the **Get information
+   * about a workspace** method.
    *
    * @param {Object} [params] - The parameters to send to the service.
    * @param {string} [params.name] - The name of the workspace. This string cannot contain carriage return, newline, or
@@ -736,8 +736,8 @@ class AssistantV1 extends BaseService {
    * the content of the updated workspace.
    *
    * A successful call to this method only initiates an asynchronous update of the workspace. The updated workspace is
-   * not available until processing completes. To check the status of the asynchronous operation, use the **Export
-   * workspace asynchronously** method.
+   * not available until processing completes. To check the status of the asynchronous operation, use the **Get
+   * information about a workspace** method.
    *
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.workspaceId - Unique identifier of the workspace.
@@ -6135,10 +6135,9 @@ namespace AssistantV1 {
     /** The current status of the workspace:
      *   - **Available**: The workspace is available and ready to process messages.
      *   - **Failed**: An asynchronous operation has failed. See the **status_errors** property for more information
-     *  about the cause of the failure. Returned only by the **Export workspace asynchronously** method.
+     *  about the cause of the failure.
      *   - **Non Existent**: The workspace does not exist.
-     *   - **Processing**: An asynchronous operation has not yet completed. Returned only by the **Export workspace
-     *  asynchronously** method.
+     *   - **Processing**: An asynchronous operation has not yet completed.
      *   - **Training**: The workspace is training based on new data such as intents or examples.
      */
     status?: string;

diff --git a/assistant/v2.ts b/assistant/v2.ts
@@ -104,11 +104,11 @@ class AssistantV2 extends BaseService {
    * @param {string} [params.description] - The description of the assistant. This string cannot contain carriage
    * return, newline, or tab characters.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-   * @returns {Promise<AssistantV2.Response<AssistantV2.Assistant>>}
+   * @returns {Promise<AssistantV2.Response<AssistantV2.AssistantData>>}
    */
   public createAssistant(
     params?: AssistantV2.CreateAssistantParams
-  ): Promise<AssistantV2.Response<AssistantV2.Assistant>> {
+  ): Promise<AssistantV2.Response<AssistantV2.AssistantData>> {
     const _params = { ...params };
     const _requiredParams = [];
     const _validParams = ['language', 'name', 'description', 'headers'];
@@ -2521,8 +2521,18 @@ namespace AssistantV2 {
     message?: string;
   }
 
-  /** Assistant. */
-  export interface Assistant {
+  /** AssistantCollection. */
+  export interface AssistantCollection {
+    /** An array of objects describing the assistants associated with the instance. */
+    assistants: AssistantData[];
+    /** The pagination data for the returned objects. For more information about using pagination, see
+     *  [Pagination](#pagination).
+     */
+    pagination: Pagination;
+  }
+
+  /** AssistantData. */
+  export interface AssistantData {
     /** The unique identifier of the assistant. */
     assistant_id?: string;
     /** The name of the assistant. This string cannot contain carriage return, newline, or tab characters. */
@@ -2537,16 +2547,6 @@ namespace AssistantV2 {
     assistant_environments?: EnvironmentReference[];
   }
 
-  /** AssistantCollection. */
-  export interface AssistantCollection {
-    /** An array of objects describing the assistants associated with the instance. */
-    assistants: Assistant[];
-    /** The pagination data for the returned objects. For more information about using pagination, see
-     *  [Pagination](#pagination).
-     */
-    pagination: Pagination;
-  }
-
   /** AssistantSkill. */
   export interface AssistantSkill {
     /** The skill ID of the skill. */

diff --git a/natural-language-understanding/v1.ts b/natural-language-understanding/v1.ts
@@ -38,6 +38,15 @@ import { getSdkHeaders } from '../lib/common';
  * models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
  * with Watson Knowledge Studio to detect custom entities and relations in Natural Language Understanding.
  *
+ * IBM is sunsetting Watson Natural Language Understanding Custom Sentiment (BETA). From **June 1, 2023** onward, you
+ * will no longer be able to use the Custom Sentiment feature.<br /><br />To ensure we continue providing our clients
+ * with robust and powerful text classification capabilities, IBM recently announced the general availability of a new
+ * [single-label text classification
+ * capability](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-classifications).
+ * This new feature includes extended language support and training data customizations suited for building a custom
+ * sentiment classifier.<br /><br />If you would like more information or further guidance, please contact IBM Cloud
+ * Support.{: deprecated}
+ *
  * API Version: 1.0
  * See: https://cloud.ibm.com/docs/natural-language-understanding
  */

diff --git a/speech-to-text/v1-generated.ts b/speech-to-text/v1-generated.ts
@@ -1700,11 +1700,17 @@ class SpeechToTextV1 extends BaseService {
    * means that the custom model is trained and ready to use. The service cannot accept subsequent training requests or
    * requests to add new resources until the existing request completes.
    *
+   * For custom models that are based on improved base language models, training also performs an automatic upgrade to a
+   * newer version of the base model. You do not need to use the [Upgrade a custom language
+   * model](#upgradelanguagemodel) method to perform the upgrade.
+   *
    * **See also:**
-   * * [Train the custom language
-   * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language)
    * * [Language support for
    * customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support)
+   * * [Train the custom language
+   * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language)
+   * * [Upgrading custom language models that are based on improved next-generation
+   * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language-ng)
    *
    * ### Training failures
    *
@@ -1882,11 +1888,17 @@ class SpeechToTextV1 extends BaseService {
    * resumes the status that it had prior to upgrade. The service cannot accept subsequent requests for the model until
    * the upgrade completes.
    *
+   * For custom models that are based on improved base language models, the [Train a custom language
+   * model](#trainlanguagemodel) method also performs an automatic upgrade to a newer version of the base model. You do
+   * not need to use the upgrade method.
+   *
    * **See also:**
+   * * [Language support for
+   * customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support)
    * * [Upgrading a custom language
    * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language)
-   * * [Language support for
-   * customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support).
+   * * [Upgrading custom language models that are based on improved next-generation
+   * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language-ng).
    *
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.customizationId - The customization ID (GUID) of the custom language model that is to be

diff --git a/text-to-speech/v1-generated.ts b/text-to-speech/v1-generated.ts
@@ -53,8 +53,8 @@ import { getSdkHeaders } from '../lib/common';
  *
  * Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing
  * users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural
- * voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022 service
- * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+ * voices or expressive neural voices are deprecated.*<br/><br/> For more information, see the [1 March 2023 service
+ * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
  * the release notes for {{site.data.keyword.texttospeechshort}} for {{site.data.keyword.cloud_notm}}.{: deprecated}
  *
  * API Version: 1.0.0
@@ -108,9 +108,9 @@ class TextToSpeechV1 extends BaseService {
    *
    * **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
    * to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
-   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
+   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
    * service
-   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
    * the release notes.
    *
    * **See also:** [Listing all
@@ -170,9 +170,9 @@ class TextToSpeechV1 extends BaseService {
    *
    * **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
    * to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
-   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
+   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
    * service
-   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
    * the release notes.
    *
    * @param {Object} params - The parameters to send to the service.
@@ -248,9 +248,9 @@ class TextToSpeechV1 extends BaseService {
    *
    * **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
    * to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
-   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
+   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
    * service
-   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
    * the release notes.
    *
    * ### Audio formats (accept types)
@@ -425,9 +425,9 @@ class TextToSpeechV1 extends BaseService {
    *
    * **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
    * to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
-   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
+   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
    * service
-   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
    * the release notes.
    *
    * **See also:** [Querying a word from a
@@ -515,9 +515,9 @@ class TextToSpeechV1 extends BaseService {
    *
    * **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
    * to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
-   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
+   * enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
    * service
-   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
+   * update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
    * the release notes.
    *
    * @param {Object} params - The parameters to send to the service.