Skip to content

Commit 15dc09c

Browse files
refactor(assistantv2): update model names
1 parent 96e2108 commit 15dc09c

File tree

5 files changed

+57
-37
lines changed

5 files changed

+57
-37
lines changed

assistant/v1.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -648,8 +648,8 @@ class AssistantV1 extends BaseService {
648648
* content of the new workspace.
649649
*
650650
* A successful call to this method only initiates asynchronous creation of the workspace. The new workspace is not
651-
* available until processing completes. To check the status of the asynchronous operation, use the **Export workspace
652-
* asynchronously** method.
651+
* available until processing completes. To check the status of the asynchronous operation, use the **Get information
652+
* about a workspace** method.
653653
*
654654
* @param {Object} [params] - The parameters to send to the service.
655655
* @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 {
736736
* the content of the updated workspace.
737737
*
738738
* A successful call to this method only initiates an asynchronous update of the workspace. The updated workspace is
739-
* not available until processing completes. To check the status of the asynchronous operation, use the **Export
740-
* workspace asynchronously** method.
739+
* not available until processing completes. To check the status of the asynchronous operation, use the **Get
740+
* information about a workspace** method.
741741
*
742742
* @param {Object} params - The parameters to send to the service.
743743
* @param {string} params.workspaceId - Unique identifier of the workspace.
@@ -6135,10 +6135,9 @@ namespace AssistantV1 {
61356135
/** The current status of the workspace:
61366136
* - **Available**: The workspace is available and ready to process messages.
61376137
* - **Failed**: An asynchronous operation has failed. See the **status_errors** property for more information
6138-
* about the cause of the failure. Returned only by the **Export workspace asynchronously** method.
6138+
* about the cause of the failure.
61396139
* - **Non Existent**: The workspace does not exist.
6140-
* - **Processing**: An asynchronous operation has not yet completed. Returned only by the **Export workspace
6141-
* asynchronously** method.
6140+
* - **Processing**: An asynchronous operation has not yet completed.
61426141
* - **Training**: The workspace is training based on new data such as intents or examples.
61436142
*/
61446143
status?: string;

assistant/v2.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,11 @@ class AssistantV2 extends BaseService {
104104
* @param {string} [params.description] - The description of the assistant. This string cannot contain carriage
105105
* return, newline, or tab characters.
106106
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
107-
* @returns {Promise<AssistantV2.Response<AssistantV2.Assistant>>}
107+
* @returns {Promise<AssistantV2.Response<AssistantV2.AssistantData>>}
108108
*/
109109
public createAssistant(
110110
params?: AssistantV2.CreateAssistantParams
111-
): Promise<AssistantV2.Response<AssistantV2.Assistant>> {
111+
): Promise<AssistantV2.Response<AssistantV2.AssistantData>> {
112112
const _params = { ...params };
113113
const _requiredParams = [];
114114
const _validParams = ['language', 'name', 'description', 'headers'];
@@ -2521,8 +2521,18 @@ namespace AssistantV2 {
25212521
message?: string;
25222522
}
25232523

2524-
/** Assistant. */
2525-
export interface Assistant {
2524+
/** AssistantCollection. */
2525+
export interface AssistantCollection {
2526+
/** An array of objects describing the assistants associated with the instance. */
2527+
assistants: AssistantData[];
2528+
/** The pagination data for the returned objects. For more information about using pagination, see
2529+
* [Pagination](#pagination).
2530+
*/
2531+
pagination: Pagination;
2532+
}
2533+
2534+
/** AssistantData. */
2535+
export interface AssistantData {
25262536
/** The unique identifier of the assistant. */
25272537
assistant_id?: string;
25282538
/** The name of the assistant. This string cannot contain carriage return, newline, or tab characters. */
@@ -2537,16 +2547,6 @@ namespace AssistantV2 {
25372547
assistant_environments?: EnvironmentReference[];
25382548
}
25392549

2540-
/** AssistantCollection. */
2541-
export interface AssistantCollection {
2542-
/** An array of objects describing the assistants associated with the instance. */
2543-
assistants: Assistant[];
2544-
/** The pagination data for the returned objects. For more information about using pagination, see
2545-
* [Pagination](#pagination).
2546-
*/
2547-
pagination: Pagination;
2548-
}
2549-
25502550
/** AssistantSkill. */
25512551
export interface AssistantSkill {
25522552
/** The skill ID of the skill. */

natural-language-understanding/v1.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,15 @@ import { getSdkHeaders } from '../lib/common';
3838
* models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
3939
* with Watson Knowledge Studio to detect custom entities and relations in Natural Language Understanding.
4040
*
41+
* IBM is sunsetting Watson Natural Language Understanding Custom Sentiment (BETA). From **June 1, 2023** onward, you
42+
* will no longer be able to use the Custom Sentiment feature.<br /><br />To ensure we continue providing our clients
43+
* with robust and powerful text classification capabilities, IBM recently announced the general availability of a new
44+
* [single-label text classification
45+
* capability](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-classifications).
46+
* This new feature includes extended language support and training data customizations suited for building a custom
47+
* sentiment classifier.<br /><br />If you would like more information or further guidance, please contact IBM Cloud
48+
* Support.{: deprecated}
49+
*
4150
* API Version: 1.0
4251
* See: https://cloud.ibm.com/docs/natural-language-understanding
4352
*/

speech-to-text/v1-generated.ts

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1700,11 +1700,17 @@ class SpeechToTextV1 extends BaseService {
17001700
* means that the custom model is trained and ready to use. The service cannot accept subsequent training requests or
17011701
* requests to add new resources until the existing request completes.
17021702
*
1703+
* For custom models that are based on improved base language models, training also performs an automatic upgrade to a
1704+
* newer version of the base model. You do not need to use the [Upgrade a custom language
1705+
* model](#upgradelanguagemodel) method to perform the upgrade.
1706+
*
17031707
* **See also:**
1704-
* * [Train the custom language
1705-
* model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language)
17061708
* * [Language support for
17071709
* customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support)
1710+
* * [Train the custom language
1711+
* model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language)
1712+
* * [Upgrading custom language models that are based on improved next-generation
1713+
* models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language-ng)
17081714
*
17091715
* ### Training failures
17101716
*
@@ -1882,11 +1888,17 @@ class SpeechToTextV1 extends BaseService {
18821888
* resumes the status that it had prior to upgrade. The service cannot accept subsequent requests for the model until
18831889
* the upgrade completes.
18841890
*
1891+
* For custom models that are based on improved base language models, the [Train a custom language
1892+
* model](#trainlanguagemodel) method also performs an automatic upgrade to a newer version of the base model. You do
1893+
* not need to use the upgrade method.
1894+
*
18851895
* **See also:**
1896+
* * [Language support for
1897+
* customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support)
18861898
* * [Upgrading a custom language
18871899
* model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language)
1888-
* * [Language support for
1889-
* customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support).
1900+
* * [Upgrading custom language models that are based on improved next-generation
1901+
* models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language-ng).
18901902
*
18911903
* @param {Object} params - The parameters to send to the service.
18921904
* @param {string} params.customizationId - The customization ID (GUID) of the custom language model that is to be

text-to-speech/v1-generated.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ import { getSdkHeaders } from '../lib/common';
5353
*
5454
* Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available to existing
5555
* users until 31 March 2023, when they will be removed from the service and the documentation. *No enhanced neural
56-
* voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022 service
57-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
56+
* voices or expressive neural voices are deprecated.*<br/><br/> For more information, see the [1 March 2023 service
57+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
5858
* the release notes for {{site.data.keyword.texttospeechshort}} for {{site.data.keyword.cloud_notm}}.{: deprecated}
5959
*
6060
* API Version: 1.0.0
@@ -108,9 +108,9 @@ class TextToSpeechV1 extends BaseService {
108108
*
109109
* **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
110110
* to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
111-
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
111+
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
112112
* service
113-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
113+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
114114
* the release notes.
115115
*
116116
* **See also:** [Listing all
@@ -170,9 +170,9 @@ class TextToSpeechV1 extends BaseService {
170170
*
171171
* **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
172172
* to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
173-
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
173+
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
174174
* service
175-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
175+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
176176
* the release notes.
177177
*
178178
* @param {Object} params - The parameters to send to the service.
@@ -248,9 +248,9 @@ class TextToSpeechV1 extends BaseService {
248248
*
249249
* **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
250250
* to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
251-
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
251+
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
252252
* service
253-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
253+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
254254
* the release notes.
255255
*
256256
* ### Audio formats (accept types)
@@ -425,9 +425,9 @@ class TextToSpeechV1 extends BaseService {
425425
*
426426
* **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
427427
* to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
428-
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
428+
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
429429
* service
430-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
430+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
431431
* the release notes.
432432
*
433433
* **See also:** [Querying a word from a
@@ -515,9 +515,9 @@ class TextToSpeechV1 extends BaseService {
515515
*
516516
* **Note:** Effective **31 March 2022**, all *neural voices* are deprecated. The deprecated voices remain available
517517
* to existing users until 31 March 2023, when they will be removed from the service and the documentation. *No
518-
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [31 March 2022
518+
* enhanced neural voices or expressive neural voices are deprecated.* For more information, see the [1 March 2023
519519
* service
520-
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-31march2022) in
520+
* update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#text-to-speech-1march2023) in
521521
* the release notes.
522522
*
523523
* @param {Object} params - The parameters to send to the service.

0 commit comments

Comments
 (0)