Skip to content

Commit 6afcb0f

Browse files
apaparazzi0329apaparazzi0329
committed
chore: url and comment changes
1 parent bd58613 commit 6afcb0f

21 files changed

Lines changed: 147 additions & 210 deletions

File tree

‎assistant/v1.ts‎

Lines changed: 7 additions & 120 deletions
Large diffs are not rendered by default.

‎compare-comply/v1.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { getSdkHeaders } from '../lib/common';
2626

2727
class CompareComplyV1 extends BaseService {
2828

29-
static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/compare-comply/api';
29+
static DEFAULT_SERVICE_URL: string = 'https://api.us-south.compare-comply.watson.cloud.ibm.com';
3030
static DEFAULT_SERVICE_NAME: string = 'compare-comply';
3131

3232
/**
@@ -39,7 +39,7 @@ class CompareComplyV1 extends BaseService {
3939
* programmatically specify the current date at runtime, in case the API has been updated since your application's
4040
* release. Instead, specify a version date that is compatible with your application, and don't change it until your
4141
* application is ready for a later version.
42-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/compare-comply/api'). The base url may differ between IBM Cloud regions.
42+
* @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.
4343
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
4444
* @param {string} [options.serviceName] - The name of the service to configure
4545
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎discovery/v1.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { getSdkHeaders } from '../lib/common';
2828

2929
class DiscoveryV1 extends BaseService {
3030

31-
static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/discovery/api';
31+
static DEFAULT_SERVICE_URL: string = 'https://api.us-south.discovery.watson.cloud.ibm.com';
3232
static DEFAULT_SERVICE_NAME: string = 'discovery';
3333

3434
/**
@@ -41,7 +41,7 @@ class DiscoveryV1 extends BaseService {
4141
* programmatically specify the current date at runtime, in case the API has been updated since your application's
4242
* release. Instead, specify a version date that is compatible with your application, and don't change it until your
4343
* application is ready for a later version.
44-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/discovery/api'). The base url may differ between IBM Cloud regions.
44+
* @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.
4545
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
4646
* @param {string} [options.serviceName] - The name of the service to configure
4747
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎natural-language-classifier/v1.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ import { getSdkHeaders } from '../lib/common';
2727

2828
class NaturalLanguageClassifierV1 extends BaseService {
2929

30-
static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/natural-language-classifier/api';
30+
static DEFAULT_SERVICE_URL: string = 'https://api.us-south.natural-language-classifier.watson.cloud.ibm.com';
3131
static DEFAULT_SERVICE_NAME: string = 'natural_language_classifier';
3232

3333
/**
3434
* Construct a NaturalLanguageClassifierV1 object.
3535
*
3636
* @param {Object} options - Options for the service.
37-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/natural-language-classifier/api'). The base url may differ between IBM Cloud regions.
37+
* @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.
3838
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
3939
* @param {string} [options.serviceName] - The name of the service to configure
4040
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

‎natural-language-understanding/v1.ts‎

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import { getSdkHeaders } from '../lib/common';
3131

3232
class NaturalLanguageUnderstandingV1 extends BaseService {
3333

34-
static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/natural-language-understanding/api';
34+
static DEFAULT_SERVICE_URL: string = 'https://api.us-south.natural-language-understanding.watson.cloud.ibm.com';
3535
static DEFAULT_SERVICE_NAME: string = 'natural-language-understanding';
3636

3737
/**
@@ -44,7 +44,7 @@ class NaturalLanguageUnderstandingV1 extends BaseService {
4444
* programmatically specify the current date at runtime, in case the API has been updated since your application's
4545
* release. Instead, specify a version date that is compatible with your application, and don't change it until your
4646
* application is ready for a later version.
47-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/natural-language-understanding/api'). The base url may differ between IBM Cloud regions.
47+
* @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.
4848
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
4949
* @param {string} [options.serviceName] - The name of the service to configure
5050
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set
@@ -102,21 +102,19 @@ class NaturalLanguageUnderstandingV1 extends BaseService {
102102
* @param {string} [params.html] - The HTML file to analyze. One of the `text`, `html`, or `url` parameters is
103103
* required.
104104
* @param {string} [params.url] - The webpage to analyze. One of the `text`, `html`, or `url` parameters is required.
105-
* @param {boolean} [params.clean] - Set this to `false` to disable webpage cleaning. To learn more about webpage
106-
* cleaning, see the [Analyzing
107-
* webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages)
108-
* documentation.
105+
* @param {boolean} [params.clean] - Set this to `false` to disable webpage cleaning. For more information about
106+
* webpage cleaning, see [Analyzing
107+
* webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages).
109108
* @param {string} [params.xpath] - An [XPath
110109
* query](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages#xpath)
111110
* to perform on `html` or `url` input. Results of the query will be appended to the cleaned webpage text before it is
112111
* analyzed. To analyze only the results of the XPath query, set the `clean` parameter to `false`.
113112
* @param {boolean} [params.fallbackToRaw] - Whether to use raw HTML content if text cleaning fails.
114113
* @param {boolean} [params.returnAnalyzedText] - Whether or not to return the analyzed text.
115114
* @param {string} [params.language] - ISO 639-1 code that specifies the language of your text. This overrides
116-
* automatic language detection. Language support differs depending on the features you include in your analysis. See
117-
* [Language
118-
* support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support)
119-
* for more information.
115+
* automatic language detection. Language support differs depending on the features you include in your analysis. For
116+
* more information, see [Language
117+
* support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support).
120118
* @param {number} [params.limitTextCharacters] - Sets the maximum number of characters that are processed by the
121119
* service.
122120
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -342,9 +340,8 @@ namespace NaturalLanguageUnderstandingV1 {
342340
html?: string;
343341
/** The webpage to analyze. One of the `text`, `html`, or `url` parameters is required. */
344342
url?: string;
345-
/** Set this to `false` to disable webpage cleaning. To learn more about webpage cleaning, see the [Analyzing
346-
* webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages)
347-
* documentation.
343+
/** Set this to `false` to disable webpage cleaning. For more information about webpage cleaning, see [Analyzing
344+
* webpages](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-analyzing-webpages).
348345
*/
349346
clean?: boolean;
350347
/** An [XPath
@@ -358,9 +355,9 @@ namespace NaturalLanguageUnderstandingV1 {
358355
/** Whether or not to return the analyzed text. */
359356
returnAnalyzedText?: boolean;
360357
/** ISO 639-1 code that specifies the language of your text. This overrides automatic language detection.
361-
* Language support differs depending on the features you include in your analysis. See [Language
362-
* support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support)
363-
* for more information.
358+
* Language support differs depending on the features you include in your analysis. For more information, see
359+
* [Language
360+
* support](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-language-support).
364361
*/
365362
language?: string;
366363
/** Sets the maximum number of characters that are processed by the service. */
@@ -474,10 +471,9 @@ namespace NaturalLanguageUnderstandingV1 {
474471

475472
/** A categorization of the analyzed text. */
476473
export interface CategoriesResult {
477-
/** The path to the category through the 5-level taxonomy hierarchy. For the complete list of categories, see
478-
* the [Categories
479-
* hierarchy](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-categories#categories-hierarchy)
480-
* documentation.
474+
/** The path to the category through the 5-level taxonomy hierarchy. For more information about the categories,
475+
* see [Categories
476+
* hierarchy](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-categories#categories-hierarchy).
481477
*/
482478
label?: string;
483479
/** Confidence score for the category classification. Higher values indicate greater confidence. */
@@ -571,7 +567,7 @@ namespace NaturalLanguageUnderstandingV1 {
571567
sadness?: number;
572568
}
573569

574-
/** Identifies people, cities, organizations, and other entities in the content. 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. */
570+
/** 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. */
575571
export interface EntitiesOptions {
576572
/** Maximum number of entities to return. */
577573
limit?: number;
@@ -647,7 +643,8 @@ namespace NaturalLanguageUnderstandingV1 {
647643
* Supported languages: English.
648644
*/
649645
emotion?: EmotionOptions;
650-
/** Identifies people, cities, organizations, and other entities in the content. See [Entity types and
646+
/** Identifies people, cities, organizations, and other entities in the content. For more information, see
647+
* [Entity types and
651648
* subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types).
652649
*
653650
* Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish.
@@ -664,7 +661,7 @@ namespace NaturalLanguageUnderstandingV1 {
664661
*/
665662
metadata?: MetadataOptions;
666663
/** Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo`
667-
* relation might connect the entities "Nobel Prize" and "Albert Einstein". See [Relation
664+
* relation might connect the entities "Nobel Prize" and "Albert Einstein". For more information, see [Relation
668665
* types](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relations).
669666
*
670667
* Supported languages: Arabic, English, German, Japanese, Korean, Spanish. Chinese, Dutch, French, Italian, and
@@ -737,7 +734,7 @@ namespace NaturalLanguageUnderstandingV1 {
737734
status?: string;
738735
/** Unique model ID. */
739736
model_id?: string;
740-
/** ISO 639-1 code indicating the language of the model. */
737+
/** ISO 639-1 code that indicates the language of the model. */
741738
language?: string;
742739
/** Model description. */
743740
description?: string;
@@ -773,7 +770,7 @@ namespace NaturalLanguageUnderstandingV1 {
773770
type?: string;
774771
}
775772

776-
/** Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo` relation might connect the entities "Nobel Prize" and "Albert Einstein". See [Relation types](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relations). Supported languages: Arabic, English, German, Japanese, Korean, Spanish. Chinese, Dutch, French, Italian, and Portuguese custom models are also supported. */
773+
/** Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo` relation might connect the entities "Nobel Prize" and "Albert Einstein". For more information, see [Relation types](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relations). Supported languages: Arabic, English, German, Japanese, Korean, Spanish. Chinese, Dutch, French, Italian, and Portuguese custom models are also supported. */
777774
export interface RelationsOptions {
778775
/** Enter a [custom
779776
* model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing)
@@ -931,7 +928,7 @@ namespace NaturalLanguageUnderstandingV1 {
931928
export interface TokenResult {
932929
/** The token as it appears in the analyzed text. */
933930
text?: string;
934-
/** The part of speech of the token. For descriptions of the values, see [Universal Dependencies POS
931+
/** The part of speech of the token. For more information about the values, see [Universal Dependencies POS
935932
* tags](https://universaldependencies.org/u/pos/).
936933
*/
937934
part_of_speech?: string;

‎personality-insights/v3.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import { getSdkHeaders } from '../lib/common';
3939

4040
class PersonalityInsightsV3 extends BaseService {
4141

42-
static DEFAULT_SERVICE_URL: string = 'https://gateway.watsonplatform.net/personality-insights/api';
42+
static DEFAULT_SERVICE_URL: string = 'https://api.us-south.personality-insights.watson.cloud.ibm.com';
4343
static DEFAULT_SERVICE_NAME: string = 'personality_insights';
4444

4545
/**
@@ -52,7 +52,7 @@ class PersonalityInsightsV3 extends BaseService {
5252
* programmatically specify the current date at runtime, in case the API has been updated since your application's
5353
* release. Instead, specify a version date that is compatible with your application, and don't change it until your
5454
* application is ready for a later version.
55-
* @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/personality-insights/api'). The base url may differ between IBM Cloud regions.
55+
* @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.
5656
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
5757
* @param {string} [options.serviceName] - The name of the service to configure
5858
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service. Defaults to environment if not set

0 commit comments

Comments
 (0)