Skip to content

Commit 4d7e5da

Browse files
apaparazzi0329apaparazzi0329
committed
refactor(assistantv1, discov1): comment changes
1 parent dc21a35 commit 4d7e5da

File tree

4 files changed

+771
-732
lines changed

4 files changed

+771
-732
lines changed

‎assistant/v1.ts‎

Lines changed: 74 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2022.
2+
* (C) Copyright IBM Corp. 2018, 2023.
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.
@@ -15,7 +15,7 @@
1515
*/
1616

1717
/**
18-
* IBM OpenAPI SDK Code Generator Version: 3.53.0-9710cac3-20220713-193508
18+
* IBM OpenAPI SDK Code Generator Version: 3.64.1-cee95189-20230124-211647
1919
*/
2020

2121
import * as extend from 'extend';
@@ -592,11 +592,11 @@ class AssistantV1 extends BaseService {
592592
* @param {Object} params - The parameters to send to the service.
593593
* @param {string} params.workspaceId - Unique identifier of the workspace.
594594
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
595-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
595+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
596596
*/
597597
public deleteWorkspace(
598598
params: AssistantV1.DeleteWorkspaceParams
599-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
599+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
600600
const _params = { ...params };
601601
const _requiredParams = ['workspaceId'];
602602
const _validParams = ['workspaceId', 'headers'];
@@ -1221,11 +1221,11 @@ class AssistantV1 extends BaseService {
12211221
* @param {string} params.workspaceId - Unique identifier of the workspace.
12221222
* @param {string} params.intent - The intent name.
12231223
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
1224-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
1224+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
12251225
*/
12261226
public deleteIntent(
12271227
params: AssistantV1.DeleteIntentParams
1228-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
1228+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
12291229
const _params = { ...params };
12301230
const _requiredParams = ['workspaceId', 'intent'];
12311231
const _validParams = ['workspaceId', 'intent', 'headers'];
@@ -1577,11 +1577,11 @@ class AssistantV1 extends BaseService {
15771577
* @param {string} params.intent - The intent name.
15781578
* @param {string} params.text - The text of the user input example.
15791579
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
1580-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
1580+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
15811581
*/
15821582
public deleteExample(
15831583
params: AssistantV1.DeleteExampleParams
1584-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
1584+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
15851585
const _params = { ...params };
15861586
const _requiredParams = ['workspaceId', 'intent', 'text'];
15871587
const _validParams = ['workspaceId', 'intent', 'text', 'headers'];
@@ -1918,11 +1918,11 @@ class AssistantV1 extends BaseService {
19181918
* @param {string} params.workspaceId - Unique identifier of the workspace.
19191919
* @param {string} params.text - The text of a user input counterexample (for example, `What are you wearing?`).
19201920
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
1921-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
1921+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
19221922
*/
19231923
public deleteCounterexample(
19241924
params: AssistantV1.DeleteCounterexampleParams
1925-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
1925+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
19261926
const _params = { ...params };
19271927
const _requiredParams = ['workspaceId', 'text'];
19281928
const _validParams = ['workspaceId', 'text', 'headers'];
@@ -2296,11 +2296,11 @@ class AssistantV1 extends BaseService {
22962296
* @param {string} params.workspaceId - Unique identifier of the workspace.
22972297
* @param {string} params.entity - The name of the entity.
22982298
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
2299-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
2299+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
23002300
*/
23012301
public deleteEntity(
23022302
params: AssistantV1.DeleteEntityParams
2303-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
2303+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
23042304
const _params = { ...params };
23052305
const _requiredParams = ['workspaceId', 'entity'];
23062306
const _validParams = ['workspaceId', 'entity', 'headers'];
@@ -2765,11 +2765,11 @@ class AssistantV1 extends BaseService {
27652765
* @param {string} params.entity - The name of the entity.
27662766
* @param {string} params.value - The text of the entity value.
27672767
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
2768-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
2768+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
27692769
*/
27702770
public deleteValue(
27712771
params: AssistantV1.DeleteValueParams
2772-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
2772+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
27732773
const _params = { ...params };
27742774
const _requiredParams = ['workspaceId', 'entity', 'value'];
27752775
const _validParams = ['workspaceId', 'entity', 'value', 'headers'];
@@ -3126,11 +3126,11 @@ class AssistantV1 extends BaseService {
31263126
* @param {string} params.value - The text of the entity value.
31273127
* @param {string} params.synonym - The text of the synonym.
31283128
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
3129-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
3129+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
31303130
*/
31313131
public deleteSynonym(
31323132
params: AssistantV1.DeleteSynonymParams
3133-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
3133+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
31343134
const _params = { ...params };
31353135
const _requiredParams = ['workspaceId', 'entity', 'value', 'synonym'];
31363136
const _validParams = ['workspaceId', 'entity', 'value', 'synonym', 'headers'];
@@ -3574,11 +3574,11 @@ class AssistantV1 extends BaseService {
35743574
* @param {string} params.workspaceId - Unique identifier of the workspace.
35753575
* @param {string} params.dialogNode - The dialog node ID (for example, `node_1_1479323581900`).
35763576
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
3577-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
3577+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
35783578
*/
35793579
public deleteDialogNode(
35803580
params: AssistantV1.DeleteDialogNodeParams
3581-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
3581+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
35823582
const _params = { ...params };
35833583
const _requiredParams = ['workspaceId', 'dialogNode'];
35843584
const _validParams = ['workspaceId', 'dialogNode', 'headers'];
@@ -3790,11 +3790,11 @@ class AssistantV1 extends BaseService {
37903790
* @param {Object} params - The parameters to send to the service.
37913791
* @param {string} params.customerId - The customer ID for which all data is to be deleted.
37923792
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
3793-
* @returns {Promise<AssistantV1.Response<AssistantV1.Empty>>}
3793+
* @returns {Promise<AssistantV1.Response<AssistantV1.EmptyObject>>}
37943794
*/
37953795
public deleteUserData(
37963796
params: AssistantV1.DeleteUserDataParams
3797-
): Promise<AssistantV1.Response<AssistantV1.Empty>> {
3797+
): Promise<AssistantV1.Response<AssistantV1.EmptyObject>> {
37983798
const _params = { ...params };
37993799
const _requiredParams = ['customerId'];
38003800
const _validParams = ['customerId', 'headers'];
@@ -3861,7 +3861,7 @@ namespace AssistantV1 {
38613861
export type Callback<T> = (error: any, response?: Response<T>) => void;
38623862

38633863
/** The body of a service request that returns no response data. */
3864-
export interface Empty {}
3864+
export interface EmptyObject {}
38653865

38663866
/** A standard JS object, defined to avoid the limitations of `Object` and `object` */
38673867
export interface JsonObject {
@@ -5197,7 +5197,9 @@ namespace AssistantV1 {
51975197

51985198
/** State information for the conversation. To maintain state, include the context from the previous response. */
51995199
export interface Context {
5200-
/** The unique identifier of the conversation. */
5200+
/** The unique identifier of the conversation. The conversation ID cannot contain any of the following
5201+
* characters: `+` `=` `&&` `||` `>` `<` `!` `(` `)` `{` `}` `[` `]` `^` `"` `~` `*` `?` `:` `\` `/`.
5202+
*/
52015203
conversation_id?: string;
52025204
/** For internal use only. */
52035205
system?: JsonObject;
@@ -5224,7 +5226,9 @@ namespace AssistantV1 {
52245226
export interface CounterexampleCollection {
52255227
/** An array of objects describing the examples marked as irrelevant input. */
52265228
counterexamples: Counterexample[];
5227-
/** The pagination data for the returned objects. */
5229+
/** The pagination data for the returned objects. For more information about using pagination, see
5230+
* [Pagination](#pagination).
5231+
*/
52285232
pagination: Pagination;
52295233
}
52305234

@@ -5382,7 +5386,9 @@ namespace AssistantV1 {
53825386
export interface DialogNodeCollection {
53835387
/** An array of objects describing the dialog nodes defined for the workspace. */
53845388
dialog_nodes: DialogNode[];
5385-
/** The pagination data for the returned objects. */
5389+
/** The pagination data for the returned objects. For more information about using pagination, see
5390+
* [Pagination](#pagination).
5391+
*/
53865392
pagination: Pagination;
53875393
}
53885394

@@ -5508,6 +5514,9 @@ namespace AssistantV1 {
55085514
label: string;
55095515
/** An object defining the message input, intents, and entities to be sent to the Watson Assistant service if
55105516
* the user selects the corresponding disambiguation option.
5517+
*
5518+
* **Note:** These properties must be included in the request body of the next message sent to the assistant. Do
5519+
* not modify or remove any of the included properties.
55115520
*/
55125521
value: DialogSuggestionValue;
55135522
/** The dialog output that will be returned from the Watson Assistant service if the user selects the
@@ -5520,7 +5529,7 @@ namespace AssistantV1 {
55205529
dialog_node?: string;
55215530
}
55225531

5523-
/** An object defining the message input, intents, and entities to be sent to the Watson Assistant service if the user selects the corresponding disambiguation option. */
5532+
/** An object defining the message input, intents, and entities to be sent to the Watson Assistant service if the user selects the corresponding disambiguation option. **Note:** These properties must be included in the request body of the next message sent to the assistant. Do not modify or remove any of the included properties. */
55245533
export interface DialogSuggestionValue {
55255534
/** An input object that includes the input text. */
55265535
input?: MessageInput;
@@ -5556,7 +5565,9 @@ namespace AssistantV1 {
55565565
export interface EntityCollection {
55575566
/** An array of objects describing the entities defined for the workspace. */
55585567
entities: Entity[];
5559-
/** The pagination data for the returned objects. */
5568+
/** The pagination data for the returned objects. For more information about using pagination, see
5569+
* [Pagination](#pagination).
5570+
*/
55605571
pagination: Pagination;
55615572
}
55625573

@@ -5576,7 +5587,9 @@ namespace AssistantV1 {
55765587
export interface EntityMentionCollection {
55775588
/** An array of objects describing the entity mentions defined for an entity. */
55785589
examples: EntityMention[];
5579-
/** The pagination data for the returned objects. */
5590+
/** The pagination data for the returned objects. For more information about using pagination, see
5591+
* [Pagination](#pagination).
5592+
*/
55805593
pagination: Pagination;
55815594
}
55825595

@@ -5599,7 +5612,9 @@ namespace AssistantV1 {
55995612
export interface ExampleCollection {
56005613
/** An array of objects describing the examples defined for the intent. */
56015614
examples: Example[];
5602-
/** The pagination data for the returned objects. */
5615+
/** The pagination data for the returned objects. For more information about using pagination, see
5616+
* [Pagination](#pagination).
5617+
*/
56035618
pagination: Pagination;
56045619
}
56055620

@@ -5624,7 +5639,9 @@ namespace AssistantV1 {
56245639
export interface IntentCollection {
56255640
/** An array of objects describing the intents defined for the workspace. */
56265641
intents: Intent[];
5627-
/** The pagination data for the returned objects. */
5642+
/** The pagination data for the returned objects. For more information about using pagination, see
5643+
* [Pagination](#pagination).
5644+
*/
56285645
pagination: Pagination;
56295646
}
56305647

@@ -5650,7 +5667,9 @@ namespace AssistantV1 {
56505667
export interface LogCollection {
56515668
/** An array of objects describing log events. */
56525669
logs: Log[];
5653-
/** The pagination data for the returned objects. */
5670+
/** The pagination data for the returned objects. For more information about using pagination, see
5671+
* [Pagination](#pagination).
5672+
*/
56545673
pagination: LogPagination;
56555674
}
56565675

@@ -5674,7 +5693,7 @@ namespace AssistantV1 {
56745693
dialog_node?: string;
56755694
}
56765695

5677-
/** The pagination data for the returned objects. */
5696+
/** The pagination data for the returned objects. For more information about using pagination, see [Pagination](#pagination). */
56785697
export interface LogPagination {
56795698
/** The URL that will return the next page of results, if any. */
56805699
next_url?: string;
@@ -5824,7 +5843,7 @@ namespace AssistantV1 {
58245843
[propName: string]: any;
58255844
}
58265845

5827-
/** The pagination data for the returned objects. */
5846+
/** The pagination data for the returned objects. For more information about using pagination, see [Pagination](#pagination). */
58285847
export interface Pagination {
58295848
/** The URL that will return the same page of results. */
58305849
refresh_url: string;
@@ -5844,7 +5863,10 @@ namespace AssistantV1 {
58445863

58455864
/** ResponseGenericChannel. */
58465865
export interface ResponseGenericChannel {
5847-
/** A channel for which the response is intended. */
5866+
/** A channel for which the response is intended.
5867+
*
5868+
* **Note:** On IBM Cloud Pak for Data, only `chat` is supported.
5869+
*/
58485870
channel?: string;
58495871
}
58505872

@@ -6021,7 +6043,9 @@ namespace AssistantV1 {
60216043
export interface SynonymCollection {
60226044
/** An array of synonyms. */
60236045
synonyms: Synonym[];
6024-
/** The pagination data for the returned objects. */
6046+
/** The pagination data for the returned objects. For more information about using pagination, see
6047+
* [Pagination](#pagination).
6048+
*/
60256049
pagination: Pagination;
60266050
}
60276051

@@ -6058,7 +6082,9 @@ namespace AssistantV1 {
60586082
export interface ValueCollection {
60596083
/** An array of entity values. */
60606084
values: Value[];
6061-
/** The pagination data for the returned objects. */
6085+
/** The pagination data for the returned objects. For more information about using pagination, see
6086+
* [Pagination](#pagination).
6087+
*/
60626088
pagination: Pagination;
60636089
}
60646090

@@ -6134,7 +6160,9 @@ namespace AssistantV1 {
61346160
export interface WorkspaceCollection {
61356161
/** An array of objects describing the workspaces associated with the service instance. */
61366162
workspaces: Workspace[];
6137-
/** The pagination data for the returned objects. */
6163+
/** The pagination data for the returned objects. For more information about using pagination, see
6164+
* [Pagination](#pagination).
6165+
*/
61386166
pagination: Pagination;
61396167
}
61406168

@@ -6200,10 +6228,13 @@ namespace AssistantV1 {
62006228

62016229
/** Workspace settings related to the version of the training algorithms currently used by the skill. */
62026230
export interface WorkspaceSystemSettingsNlp {
6203-
/** The policy the skill follows for selecting the algorithm version to use:
6231+
/** The policy the skill follows for selecting the algorithm version to use. For more information, see the
6232+
* [documentation](/docs/watson-assistant?topic=watson-assistant-algorithm-version).
6233+
*
6234+
* On IBM Cloud, you can specify `latest`, `previous`, or `beta`.
62046235
*
6205-
* - `baseline`: the latest mature version
6206-
* - `beta`: the latest beta version.
6236+
* On IBM Cloud Pak for Data, you can specify either `beta` or the date of the version you want to use, in
6237+
* `YYYY-MM-DD` format.
62076238
*/
62086239
model?: string;
62096240
}
@@ -6254,6 +6285,8 @@ namespace AssistantV1 {
62546285
export interface DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer extends DialogNodeOutputGeneric {
62556286
/** The type of response returned by the dialog node. The specified response type must be supported by the
62566287
* client application or channel.
6288+
*
6289+
* **Note:** The `channel_transfer` response type is not supported on IBM Cloud Pak for Data.
62576290
*/
62586291
response_type: string;
62596292
/** The message to display to the user when initiating a channel transfer. */
@@ -6465,6 +6498,8 @@ namespace AssistantV1 {
64656498
export interface RuntimeResponseGenericRuntimeResponseTypeChannelTransfer extends RuntimeResponseGeneric {
64666499
/** The type of response returned by the dialog node. The specified response type must be supported by the
64676500
* client application or channel.
6501+
*
6502+
* **Note:** The `channel_transfer` response type is not supported on IBM Cloud Pak for Data.
64686503
*/
64696504
response_type: string;
64706505
/** The message to display to the user when initiating a channel transfer. */

0 commit comments

Comments
 (0)