Skip to content

Commit 16420fc

Browse files
committed
fix: regenerate with correct version
regenerate with sdk-2021-09-03
1 parent 29b9b4e commit 16420fc

File tree

11 files changed

+619
-442
lines changed

11 files changed

+619
-442
lines changed

assistant/v1.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3426,8 +3426,8 @@ class AssistantV1 extends BaseService {
34263426
* @param {Object} params - The parameters to send to the service.
34273427
* @param {string} params.filter - A cacheable parameter that limits the results to those matching the specified
34283428
* filter. You must specify a filter query that includes a value for `language`, as well as a value for
3429-
* `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. For more
3430-
* information, see the
3429+
* `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. These required
3430+
* filters must be specified using the exact match (`::`) operator. For more information, see the
34313431
* [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
34323432
* @param {string} [params.sort] - How to sort the returned log events. You can sort by **request_timestamp**. To
34333433
* reverse the sort order, prefix the parameter value with a minus sign (`-`).
@@ -4732,7 +4732,8 @@ namespace AssistantV1 {
47324732
export interface ListAllLogsParams {
47334733
/** A cacheable parameter that limits the results to those matching the specified filter. You must specify a
47344734
* filter query that includes a value for `language`, as well as a value for `request.context.system.assistant_id`,
4735-
* `workspace_id`, or `request.context.metadata.deployment`. For more information, see the
4735+
* `workspace_id`, or `request.context.metadata.deployment`. These required filters must be specified using the
4736+
* exact match (`::`) operator. For more information, see the
47364737
* [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).
47374738
*/
47384739
filter: string;
@@ -5775,8 +5776,8 @@ namespace AssistantV1 {
57755776
none_of_the_above_prompt?: string;
57765777
/** Whether the disambiguation feature is enabled for the workspace. */
57775778
enabled?: boolean;
5778-
/** The sensitivity of the disambiguation feature to intent detection conflicts. Set to **high** if you want the
5779-
* disambiguation feature to be triggered more often. This can be useful for testing or demonstration purposes.
5779+
/** The sensitivity of the disambiguation feature to intent detection uncertainty. Higher sensitivity means that
5780+
* the disambiguation feature is triggered more often and includes more choices.
57805781
*/
57815782
sensitivity?: string;
57825783
/** Whether the order in which disambiguation suggestions are presented should be randomized (but still
@@ -5857,6 +5858,8 @@ namespace AssistantV1 {
58575858
description?: string;
58585859
/** An array of objects specifying channels for which the response is intended. */
58595860
channels?: ResponseGenericChannel[];
5861+
/** Descriptive text that can be used for screen readers or other situations where the image cannot be seen. */
5862+
alt_text?: string;
58605863
}
58615864

58625865
/** DialogNodeOutputGenericDialogNodeOutputResponseTypeOption. */
@@ -6014,6 +6017,8 @@ namespace AssistantV1 {
60146017
* response is intended for a built-in integration and should not be handled by an API client.
60156018
*/
60166019
channels?: ResponseGenericChannel[];
6020+
/** Descriptive text that can be used for screen readers or other situations where the image cannot be seen. */
6021+
alt_text?: string;
60176022
}
60186023

60196024
/** RuntimeResponseGenericRuntimeResponseTypeOption. */

assistant/v2.ts

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1026,12 +1026,27 @@ namespace AssistantV2 {
10261026
* This can be useful for simulating past or future times for testing purposes, or when analyzing documents such as
10271027
* news articles.
10281028
*
1029-
* This value must be a UTC time value formatted according to ISO 8601 (for example, `2019-06-26T12:00:00Z` for
1030-
* noon on 26 June 2019.
1029+
* This value must be a UTC time value formatted according to ISO 8601 (for example, `2021-06-26T12:00:00Z` for
1030+
* noon UTC on 26 June 2021).
10311031
*
10321032
* This property is included only if the new system entities are enabled for the skill.
10331033
*/
10341034
reference_time?: string;
1035+
/** The time at which the session started. With the stateful `message` method, the start time is always present,
1036+
* and is set by the service based on the time the session was created. With the stateless `message` method, the
1037+
* start time is set by the service in the response to the first message, and should be returned as part of the
1038+
* context with each subsequent message in the session.
1039+
*
1040+
* This value is a UTC time value formatted according to ISO 8601 (for example, `2021-06-26T12:00:00Z` for noon UTC
1041+
* on 26 June 2021).
1042+
*/
1043+
session_start_time?: string;
1044+
/** An encoded string that represents the configuration state of the assistant at the beginning of the
1045+
* conversation. If you are using the stateless `message` method, save this value and then send it in the context
1046+
* of the subsequent message request to avoid disruptions if there are configuration changes during the
1047+
* conversation (such as a change to a skill the assistant uses).
1048+
*/
1049+
state?: string;
10351050
}
10361051

10371052
/** Contains information specific to a particular skill used by the Assistant. The property name must be the same as the name of the skill (for example, `main skill`). */
@@ -1620,6 +1635,8 @@ namespace AssistantV2 {
16201635
* response is intended for a built-in integration and should not be handled by an API client.
16211636
*/
16221637
channels?: ResponseGenericChannel[];
1638+
/** Descriptive text that can be used for screen readers or other situations where the image cannot be seen. */
1639+
alt_text?: string;
16231640
}
16241641

16251642
/** RuntimeResponseGenericRuntimeResponseTypeOption. */

compare-comply/v1.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class CompareComplyV1 extends BaseService {
6868
constructor(options: UserOptions) {
6969
console.warn(`On 30 November 2021, Compare and Comply will no longer be available.
7070
For more information, see https://github.com/watson-developer-cloud/node-sdk#compare-and-comply-deprecation`);
71-
71+
7272
options = options || {};
7373

7474
const requiredParams = ['version'];

discovery/v2.ts

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -877,8 +877,8 @@ class DiscoveryV2 extends BaseService {
877877
* * The user must provide document content, metadata, or both. If the request is missing both document content and
878878
* metadata, it is rejected.
879879
*
880-
* * The user can set the **Content-Type** parameter on the **file** part to indicate the media type of the
881-
* document. If the **Content-Type** parameter is missing or is one of the generic media types (for example,
880+
* * You can set the **Content-Type** parameter on the **file** part to indicate the media type of the document. If
881+
* the **Content-Type** parameter is missing or is one of the generic media types (for example,
882882
* `application/octet-stream`), then the service attempts to automatically detect the document's media type.
883883
*
884884
* * The following field names are reserved and are filtered out if present after normalization: `id`, `score`,
@@ -891,11 +891,12 @@ class DiscoveryV2 extends BaseService {
891891
* If the document is uploaded to a collection that shares its data with another collection, the
892892
* **X-Watson-Discovery-Force** header must be set to `true`.
893893
*
894-
* **Note:** Documents can be added with a specific **document_id** by using the
895-
* **_/v2/projects/{project_id}/collections/{collection_id}/documents** method.
894+
* **Note:** You can assign an ID to a document that you add by appending the ID to the endpoint
895+
* (`/v2/projects/{project_id}/collections/{collection_id}/documents/{document_id}`). If a document already exists
896+
* with the specified ID, it is replaced.
896897
*
897-
* **Note:** This operation only works on collections created to accept direct file uploads. It cannot be used to
898-
* modify a collection that connects to an external source such as Microsoft SharePoint.
898+
* **Note:** This operation works with a file upload collection. It cannot be used to modify a collection that crawls
899+
* an external data source.
899900
*
900901
* @param {Object} params - The parameters to send to the service.
901902
* @param {string} params.projectId - The ID of the project. This information can be found from the *Integrate and
@@ -1538,11 +1539,11 @@ class DiscoveryV2 extends BaseService {
15381539
/**
15391540
* Analyze a Document.
15401541
*
1541-
* Process a document using the specified collection's settings and return it for realtime use.
1542+
* Process a document and return it for realtime use. Supports JSON files only.
15421543
*
1543-
* **Note:** Documents processed using this method are not added to the specified collection.
1544+
* The document is processed according to the collection's configuration settings but is not stored in the collection.
15441545
*
1545-
* **Note:** This method is only supported on IBM Cloud Pak for Data instances of Discovery.
1546+
* **Note:** This method is supported on installed instances of Discovery only.
15461547
*
15471548
* @param {Object} params - The parameters to send to the service.
15481549
* @param {string} params.projectId - The ID of the project. This information can be found from the *Integrate and
@@ -1629,7 +1630,8 @@ class DiscoveryV2 extends BaseService {
16291630
/**
16301631
* List Enrichments.
16311632
*
1632-
* List the enrichments available to this project.
1633+
* Lists the enrichments available to this project. The *Part of Speech* and *Sentiment of Phrases* enrichments might
1634+
* be listed, but are reserved for internal use only.
16331635
*
16341636
* @param {Object} params - The parameters to send to the service.
16351637
* @param {string} params.projectId - The ID of the project. This information can be found from the *Integrate and
@@ -2004,8 +2006,8 @@ class DiscoveryV2 extends BaseService {
20042006
* The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a *Custom*
20052007
* project.
20062008
*
2007-
* The `content_mining` and `content_intelligence` types are available with Premium and Cloud Pak for Data deployments
2008-
* only.
2009+
* The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments and
2010+
* installed deployments only.
20092011
* @param {DefaultQueryParams} [params.defaultQueryParameters] - Default query parameters for this project.
20102012
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
20112013
* @returns {Promise<DiscoveryV2.Response<DiscoveryV2.ProjectDetails>>}
@@ -2814,8 +2816,8 @@ namespace DiscoveryV2 {
28142816
* The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a
28152817
* *Custom* project.
28162818
*
2817-
* The `content_mining` and `content_intelligence` types are available with Premium and Cloud Pak for Data
2818-
* deployments only.
2819+
* The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments and
2820+
* installed deployments only.
28192821
*/
28202822
type: CreateProjectConstants.Type | string;
28212823
/** Default query parameters for this project. */
@@ -2825,7 +2827,7 @@ namespace DiscoveryV2 {
28252827

28262828
/** Constants for the `createProject` operation. */
28272829
export namespace CreateProjectConstants {
2828-
/** The type of project. The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a *Custom* project. The `content_mining` and `content_intelligence` types are available with Premium and Cloud Pak for Data deployments only. */
2830+
/** The type of project. The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a *Custom* project. The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments and installed deployments only. */
28292831
export enum Type {
28302832
DOCUMENT_RETRIEVAL = 'document_retrieval',
28312833
CONVERSATIONAL_SEARCH = 'conversational_search',
@@ -2913,7 +2915,11 @@ namespace DiscoveryV2 {
29132915
export interface CollectionEnrichment {
29142916
/** The unique identifier of this enrichment. */
29152917
enrichment_id?: string;
2916-
/** An array of field names that the enrichment is applied to. */
2918+
/** An array of field names that the enrichment is applied to.
2919+
*
2920+
* If you apply an enrichment to a field from a JSON file, the data is converted to an array automatically, even if
2921+
* the field contains a single value.
2922+
*/
29172923
fields?: string[];
29182924
}
29192925

@@ -3187,8 +3193,8 @@ namespace DiscoveryV2 {
31873193
* The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a
31883194
* *Custom* project.
31893195
*
3190-
* The `content_mining` and `content_intelligence` types are available with Premium and Cloud Pak for Data
3191-
* deployments only.
3196+
* The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments and
3197+
* installed deployments only.
31923198
*/
31933199
type?: string;
31943200
/** Relevancy training status information for this project. */
@@ -3210,8 +3216,8 @@ namespace DiscoveryV2 {
32103216
* The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a
32113217
* *Custom* project.
32123218
*
3213-
* The `content_mining` and `content_intelligence` types are available with Premium and Cloud Pak for Data
3214-
* deployments only.
3219+
* The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments and
3220+
* installed deployments only.
32153221
*/
32163222
type?: string;
32173223
/** Relevancy training status information for this project. */
@@ -3317,8 +3323,7 @@ namespace DiscoveryV2 {
33173323
* is set to `false`, then the passage search results are reordered in decreasing order of the highest confidence
33183324
* answer for each document and passage.
33193325
*
3320-
* The **find_answers** parameter is **beta** functionality available only on managed instances and should not be
3321-
* used in a production environment. This parameter is not available on installed instances of Discovery.
3326+
* The **find_answers** parameter is available only on managed instances of Discovery.
33223327
*/
33233328
find_answers?: boolean;
33243329
/** The number of `answer` objects to return per passage if the **find_answers** parmeter is specified as
@@ -3811,7 +3816,7 @@ namespace DiscoveryV2 {
38113816
export interface QueryHistogramAggregation extends QueryAggregation {
38123817
/** The numeric field name used to create the histogram. */
38133818
field: string;
3814-
/** The size of the sections the results are split into. */
3819+
/** The size of the sections that the results are split into. */
38153820
interval: number;
38163821
/** Identifier specified in the query request of this aggregation. */
38173822
name?: string;

natural-language-classifier/v1.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,16 @@ import {
3030
import { getSdkHeaders } from '../lib/common';
3131

3232
/**
33-
* IBM Watson&trade; Natural Language Classifier uses machine learning algorithms to return the top matching predefined
34-
* classes for short text input. You create and train a classifier to connect predefined classes to example texts so
35-
* that the service can apply those classes to new inputs.
33+
* On 9 August 2021, IBM announced the deprecation of IBM Watson&trade; Natural Language Classifier. As of 9 September
34+
* 2021, you cannot create new instances. However, existing instances are supported until 8 August 2022. The service
35+
* will no longer be available on 8 August 2022.<br/><br/>As an alternative, consider migrating to IBM Watson Natural
36+
* Language Understanding. For more information, see [Migrating to Natural Language
37+
* Understanding](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-migrating).
38+
* {: deprecated}
39+
*
40+
* Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes for short
41+
* text input. You create and train a classifier to connect predefined classes to example texts so that the service can
42+
* apply those classes to new inputs.
3643
*
3744
* API Version: 1.0
3845
* See: https://cloud.ibm.com/docs/natural-language-classifier

natural-language-understanding/v1.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,11 +1038,11 @@ class NaturalLanguageUnderstandingV1 extends BaseService {
10381038
*
10391039
* @param {Object} [params] - The parameters to send to the service.
10401040
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
1041-
* @returns {Promise<NaturalLanguageUnderstandingV1.Response<NaturalLanguageUnderstandingV1.ListClassificationsModelsResponse>>}
1041+
* @returns {Promise<NaturalLanguageUnderstandingV1.Response<NaturalLanguageUnderstandingV1.ClassificationsModelList>>}
10421042
*/
10431043
public listClassificationsModels(
10441044
params?: NaturalLanguageUnderstandingV1.ListClassificationsModelsParams
1045-
): Promise<NaturalLanguageUnderstandingV1.Response<NaturalLanguageUnderstandingV1.ListClassificationsModelsResponse>> {
1045+
): Promise<NaturalLanguageUnderstandingV1.Response<NaturalLanguageUnderstandingV1.ClassificationsModelList>> {
10461046
const _params = { ...params };
10471047

10481048
const query = {
@@ -2031,11 +2031,6 @@ namespace NaturalLanguageUnderstandingV1 {
20312031
sentiment?: FeatureSentimentResults;
20322032
}
20332033

2034-
/** ListClassificationsModelsResponse. */
2035-
export interface ListClassificationsModelsResponse {
2036-
models?: ClassificationsModelList[];
2037-
}
2038-
20392034
/** Custom models that are available for entities and relations. */
20402035
export interface ListModelsResults {
20412036
/** An array of available models. */

0 commit comments

Comments
 (0)