Skip to content

Commit 68a7501

Browse files
chore(wa,dis,lt,nlu,tts): small changes
1 parent 762c6bf commit 68a7501

13 files changed

Lines changed: 286 additions & 349 deletions

File tree

assistant/v1.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3462,6 +3462,8 @@ class AssistantV1 extends BaseService {
34623462
* filter. For more information, see the
34633463
* [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
34643464
* @param {number} [params.pageLimit] - The number of records to return in each page of results.
3465+
*
3466+
* **Note:** If the API is not returning your data, try lowering the page_limit value.
34653467
* @param {string} [params.cursor] - A token identifying the page of results to retrieve.
34663468
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
34673469
* @returns {Promise<AssistantV1.Response<AssistantV1.LogCollection>>}
@@ -4904,7 +4906,10 @@ namespace AssistantV1 {
49044906
* see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
49054907
*/
49064908
filter?: string;
4907-
/** The number of records to return in each page of results. */
4909+
/** The number of records to return in each page of results.
4910+
*
4911+
* **Note:** If the API is not returning your data, try lowering the page_limit value.
4912+
*/
49084913
pageLimit?: number;
49094914
/** A token identifying the page of results to retrieve. */
49104915
cursor?: string;
@@ -5800,7 +5805,7 @@ namespace AssistantV1 {
58005805
location?: number[];
58015806
/** The entity value that was recognized in the user input. */
58025807
value: string;
5803-
/** A decimal percentage that represents Watson's confidence in the recognized entity. */
5808+
/** A decimal percentage that represents confidence in the recognized entity. */
58045809
confidence?: number;
58055810
/** The recognized capture groups for the entity, as defined by the entity pattern. */
58065811
groups?: CaptureGroup[];
@@ -5828,7 +5833,7 @@ namespace AssistantV1 {
58285833
export interface RuntimeEntityAlternative {
58295834
/** The entity value that was recognized in the user input. */
58305835
value?: string;
5831-
/** A decimal percentage that represents Watson's confidence in the recognized entity. */
5836+
/** A decimal percentage that represents confidence in the recognized entity. */
58325837
confidence?: number;
58335838
}
58345839

@@ -5961,8 +5966,8 @@ namespace AssistantV1 {
59615966
export interface RuntimeIntent {
59625967
/** The name of the recognized intent. */
59635968
intent: string;
5964-
/** A decimal percentage that represents Watson's confidence in the intent. If you are specifying an intent as
5965-
* part of a request, but you do not have a calculated confidence value, specify `1`.
5969+
/** A decimal percentage that represents confidence in the intent. If you are specifying an intent as part of a
5970+
* request, but you do not have a calculated confidence value, specify `1`.
59665971
*/
59675972
confidence?: number;
59685973
}

discovery/v1.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2024.
2+
* (C) Copyright IBM Corp. 2018, 2024.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -6709,9 +6709,9 @@ namespace DiscoveryV1 {
67096709
selector_tags?: string[];
67106710
/** Defines the annotated smart document understanding fields that the document is split on. The content of the
67116711
* annotated field that the segmentation splits at is used as the **title** field for that segmented result. For
6712-
* example, if the field `sub-title` is specified, when a document is uploaded each time the smart documement
6712+
* example, if the field `sub-title` is specified, when a document is uploaded each time the smart document
67136713
* understanding conversion encounters a field of type `sub-title` the document is split at that point and the
6714-
* content of the field used as the title of the remaining content. Thnis split is performed for all instances of
6714+
* content of the field used as the title of the remaining content. This split is performed for all instances of
67156715
* the listed fields in the uploaded document. Only valid if used with a collection that has **enabled** set to
67166716
* `true` in the **smart_document_understanding** object.
67176717
*/

language-translator/v3.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2024.
2+
* (C) Copyright IBM Corp. 2018, 2024.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,6 +30,12 @@ import {
3030
import { getSdkHeaders } from '../lib/common';
3131

3232
/**
33+
* IBM&reg; is announcing the deprecation of the Watson&reg; Language Translator service for IBM Cloud&reg; in all
34+
* regions. As of 10 June 2023, the Language Translator tile will be removed from the IBM Cloud Platform for new
35+
* customers; only existing customers will be able to access the product. As of 10 June 2024, the service will reach its
36+
* End of Support date. As of 10 December 2024, the service will be withdrawn entirely and will no longer be available
37+
* to any customers.{: deprecated}
38+
*
3339
* IBM Watson&trade; Language Translator translates text from one language to another. The service offers multiple
3440
* IBM-provided translation models that you can customize based on your unique terminology and language. Use Language
3541
* Translator to take news from across the globe and present it in your language, communicate with your customers in

natural-language-understanding/v1.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2024.
2+
* (C) Copyright IBM Corp. 2017, 2024.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -38,7 +38,7 @@ 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
41+
* IBM is sunsetting Watson Natural Language Understanding Custom Sentiment (BETA). From **June 3, 2023** onward, you
4242
* will no longer be able to use the Custom Sentiment feature.<br /><br />To ensure we continue providing our clients
4343
* with robust and powerful text classification capabilities, IBM recently announced the general availability of a new
4444
* [single-label text classification
@@ -1516,7 +1516,7 @@ namespace NaturalLanguageUnderstandingV1 {
15161516
sadness?: number;
15171517
}
15181518

1519-
/** Identifies people, cities, organizations, and other entities in the content. For more information, see [Entity types and subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types). Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported only through custom models. */
1519+
/** Identifies people, cities, organizations, and other entities in the content. For more information, see [Entity types and subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-type-systems). Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported only through custom models. */
15201520
export interface EntitiesOptions {
15211521
/** Maximum number of entities to return. */
15221522
limit?: number;
@@ -1596,7 +1596,7 @@ namespace NaturalLanguageUnderstandingV1 {
15961596
emotion?: EmotionOptions;
15971597
/** Identifies people, cities, organizations, and other entities in the content. For more information, see
15981598
* [Entity types and
1599-
* subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types).
1599+
* subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-type-systems).
16001600
*
16011601
* Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish.
16021602
* Arabic, Chinese, and Dutch are supported only through custom models.

0 commit comments

Comments
 (0)