Skip to content

Commit b1ade2f

Browse files
chore: comment and formatting changes
1 parent 925d5d9 commit b1ade2f

32 files changed

+455
-272
lines changed

assistant/src/main/java/com/ibm/watson/assistant/v2/Assistant.java

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2019, 2024.
2+
* (C) Copyright IBM Corp. 2019, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -12,7 +12,7 @@
1212
*/
1313

1414
/*
15-
* IBM OpenAPI SDK Code Generator Version: 3.97.0-0e90eab1-20241120-170029
15+
* IBM OpenAPI SDK Code Generator Version: 3.105.0-3c13b041-20250605-193116
1616
*/
1717

1818
package com.ibm.watson.assistant.v2;
@@ -110,7 +110,7 @@ public class Assistant extends BaseService {
110110
* the client instance.
111111
*
112112
* @param version Release date of the API version you want to use. Specify dates in YYYY-MM-DD
113-
* format. The current version is `2023-06-15`.
113+
* format. The current version is `2024-08-25`.
114114
*/
115115
public Assistant(String version) {
116116
this(
@@ -124,7 +124,7 @@ public Assistant(String version) {
124124
* authenticator are used to configure the client instance.
125125
*
126126
* @param version Release date of the API version you want to use. Specify dates in YYYY-MM-DD
127-
* format. The current version is `2023-06-15`.
127+
* format. The current version is `2024-08-25`.
128128
* @param authenticator the {@link Authenticator} instance to be configured for this client
129129
*/
130130
public Assistant(String version, Authenticator authenticator) {
@@ -136,7 +136,7 @@ public Assistant(String version, Authenticator authenticator) {
136136
* configure the client instance.
137137
*
138138
* @param version Release date of the API version you want to use. Specify dates in YYYY-MM-DD
139-
* format. The current version is `2023-06-15`.
139+
* format. The current version is `2024-08-25`.
140140
* @param serviceName the service name to be used when configuring the client instance
141141
*/
142142
public Assistant(String version, String serviceName) {
@@ -148,7 +148,7 @@ public Assistant(String version, String serviceName) {
148148
* are used to configure the client instance.
149149
*
150150
* @param version Release date of the API version you want to use. Specify dates in YYYY-MM-DD
151-
* format. The current version is `2023-06-15`.
151+
* format. The current version is `2024-08-25`.
152152
* @param serviceName the service name to be used when configuring the client instance
153153
* @param authenticator the {@link Authenticator} instance to be configured for this client
154154
*/
@@ -163,7 +163,7 @@ public Assistant(String version, String serviceName, Authenticator authenticator
163163
* Gets the version.
164164
*
165165
* <p>Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The
166-
* current version is `2023-06-15`.
166+
* current version is `2024-08-25`.
167167
*
168168
* @return the version
169169
*/
@@ -1516,8 +1516,9 @@ public ServiceCall<Skill> updateSkill(UpdateSkillOptions updateSkillOptions) {
15161516
* Export skills.
15171517
*
15181518
* <p>Asynchronously export the action skill and dialog skill (if enabled) for the assistant. Use
1519-
* this method to save all skill data so that you can import it to a different assistant using the
1520-
* **Import skills** method.
1519+
* this method to save all skill data from the draft environment so that you can import it to a
1520+
* different assistant using the **Import skills** method. Use `assistant_id` instead of
1521+
* `environment_id` to call this endpoint.
15211522
*
15221523
* <p>A successful call to this method only initiates an asynchronous export. The exported JSON
15231524
* data is not available until processing completes.
@@ -1562,6 +1563,8 @@ public ServiceCall<SkillsExport> exportSkills(ExportSkillsOptions exportSkillsOp
15621563
* Import skills.
15631564
*
15641565
* <p>Asynchronously import skills into an existing assistant from a previously exported file.
1566+
* This method only imports assistants into a draft environment. Use `assistant_id` instead of
1567+
* `environment_id` to call this endpoint.
15651568
*
15661569
* <p>The request body for this method should contain the response data that was received from a
15671570
* previous call to the **Export skills** method, without modification.

assistant/src/main/java/com/ibm/watson/assistant/v2/model/BulkClassifyOptions.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2020, 2024.
2+
* (C) Copyright IBM Corp. 2020, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -120,8 +120,10 @@ public Builder newBuilder() {
120120
/**
121121
* Gets the skillId.
122122
*
123-
* <p>Unique identifier of the skill. To find the skill ID in the watsonx Assistant user
124-
* interface, open the skill settings and click **API Details**.
123+
* <p>Unique identifier of the skill. To find the action or dialog skill ID in the watsonx
124+
* Assistant user interface, open the skill settings and click **API Details**. To find the search
125+
* skill ID, use the Get environment API to retrieve the skill references for an environment and
126+
* it will include the search skill info, if available.
125127
*
126128
* @return the skillId
127129
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/CreateReleaseExportOptions.java

Lines changed: 15 additions & 9 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. 2024, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -119,17 +119,23 @@ public Builder newBuilder() {
119119
/**
120120
* Gets the assistantId.
121121
*
122-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
123-
* depending on the type of request: - For message, session, and log requests, specify the
124-
* environment ID of the environment where the assistant is deployed. - For all other requests,
125-
* specify the assistant ID of the assistant.
122+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
123+
* Set the value for this ID depending on the type of request:
126124
*
127-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
128-
* assistant settings and scroll to the **Environments** section.
125+
* <p>- For message, session, and log requests, specify the environment ID of the environment
126+
* where the assistant is deployed.
127+
*
128+
* <p>- For all other requests, specify the assistant ID of the assistant.
129+
*
130+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
131+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
132+
* and click **View Details**.
129133
*
130134
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
131-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
132-
* Details.
135+
* ID.
136+
*
137+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
138+
* click **API Details**.
133139
*
134140
* @return the assistantId
135141
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/CreateReleaseImportOptions.java

Lines changed: 15 additions & 9 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. 2024, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -135,17 +135,23 @@ public Builder newBuilder() {
135135
/**
136136
* Gets the assistantId.
137137
*
138-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
139-
* depending on the type of request: - For message, session, and log requests, specify the
140-
* environment ID of the environment where the assistant is deployed. - For all other requests,
141-
* specify the assistant ID of the assistant.
138+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
139+
* Set the value for this ID depending on the type of request:
142140
*
143-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
144-
* assistant settings and scroll to the **Environments** section.
141+
* <p>- For message, session, and log requests, specify the environment ID of the environment
142+
* where the assistant is deployed.
143+
*
144+
* <p>- For all other requests, specify the assistant ID of the assistant.
145+
*
146+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
147+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
148+
* and click **View Details**.
145149
*
146150
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
147-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
148-
* Details.
151+
* ID.
152+
*
153+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
154+
* click **API Details**.
149155
*
150156
* @return the assistantId
151157
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/CreateReleaseOptions.java

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2023, 2024.
2+
* (C) Copyright IBM Corp. 2023, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -112,17 +112,23 @@ public Builder newBuilder() {
112112
/**
113113
* Gets the assistantId.
114114
*
115-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
116-
* depending on the type of request: - For message, session, and log requests, specify the
117-
* environment ID of the environment where the assistant is deployed. - For all other requests,
118-
* specify the assistant ID of the assistant.
115+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
116+
* Set the value for this ID depending on the type of request:
119117
*
120-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
121-
* assistant settings and scroll to the **Environments** section.
118+
* <p>- For message, session, and log requests, specify the environment ID of the environment
119+
* where the assistant is deployed.
120+
*
121+
* <p>- For all other requests, specify the assistant ID of the assistant.
122+
*
123+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
124+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
125+
* and click **View Details**.
122126
*
123127
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
124-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
125-
* Details.
128+
* ID.
129+
*
130+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
131+
* click **API Details**.
126132
*
127133
* @return the assistantId
128134
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/CreateSessionOptions.java

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2018, 2024.
2+
* (C) Copyright IBM Corp. 2018, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -101,17 +101,23 @@ public Builder newBuilder() {
101101
/**
102102
* Gets the assistantId.
103103
*
104-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
105-
* depending on the type of request: - For message, session, and log requests, specify the
106-
* environment ID of the environment where the assistant is deployed. - For all other requests,
107-
* specify the assistant ID of the assistant.
104+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
105+
* Set the value for this ID depending on the type of request:
108106
*
109-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
110-
* assistant settings and scroll to the **Environments** section.
107+
* <p>- For message, session, and log requests, specify the environment ID of the environment
108+
* where the assistant is deployed.
109+
*
110+
* <p>- For all other requests, specify the assistant ID of the assistant.
111+
*
112+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
113+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
114+
* and click **View Details**.
111115
*
112116
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
113-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
114-
* Details.
117+
* ID.
118+
*
119+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
120+
* click **API Details**.
115121
*
116122
* @return the assistantId
117123
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/DeleteAssistantOptions.java

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2023, 2024.
2+
* (C) Copyright IBM Corp. 2023, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -86,17 +86,23 @@ public Builder newBuilder() {
8686
/**
8787
* Gets the assistantId.
8888
*
89-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
90-
* depending on the type of request: - For message, session, and log requests, specify the
91-
* environment ID of the environment where the assistant is deployed. - For all other requests,
92-
* specify the assistant ID of the assistant.
89+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
90+
* Set the value for this ID depending on the type of request:
9391
*
94-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
95-
* assistant settings and scroll to the **Environments** section.
92+
* <p>- For message, session, and log requests, specify the environment ID of the environment
93+
* where the assistant is deployed.
94+
*
95+
* <p>- For all other requests, specify the assistant ID of the assistant.
96+
*
97+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
98+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
99+
* and click **View Details**.
96100
*
97101
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
98-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
99-
* Details.
102+
* ID.
103+
*
104+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
105+
* click **API Details**.
100106
*
101107
* @return the assistantId
102108
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/DeleteReleaseOptions.java

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2023, 2024.
2+
* (C) Copyright IBM Corp. 2023, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -104,17 +104,23 @@ public Builder newBuilder() {
104104
/**
105105
* Gets the assistantId.
106106
*
107-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
108-
* depending on the type of request: - For message, session, and log requests, specify the
109-
* environment ID of the environment where the assistant is deployed. - For all other requests,
110-
* specify the assistant ID of the assistant.
107+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
108+
* Set the value for this ID depending on the type of request:
111109
*
112-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
113-
* assistant settings and scroll to the **Environments** section.
110+
* <p>- For message, session, and log requests, specify the environment ID of the environment
111+
* where the assistant is deployed.
112+
*
113+
* <p>- For all other requests, specify the assistant ID of the assistant.
114+
*
115+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
116+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
117+
* and click **View Details**.
114118
*
115119
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
116-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
117-
* Details.
120+
* ID.
121+
*
122+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
123+
* click **API Details**.
118124
*
119125
* @return the assistantId
120126
*/

assistant/src/main/java/com/ibm/watson/assistant/v2/model/DeleteSessionOptions.java

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* (C) Copyright IBM Corp. 2018, 2024.
2+
* (C) Copyright IBM Corp. 2018, 2025.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
55
* the License. You may obtain a copy of the License at
@@ -104,17 +104,23 @@ public Builder newBuilder() {
104104
/**
105105
* Gets the assistantId.
106106
*
107-
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed,
108-
* depending on the type of request: - For message, session, and log requests, specify the
109-
* environment ID of the environment where the assistant is deployed. - For all other requests,
110-
* specify the assistant ID of the assistant.
107+
* <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
108+
* Set the value for this ID depending on the type of request:
111109
*
112-
* <p>To find the environment ID or assistant ID in the watsonx Assistant user interface, open the
113-
* assistant settings and scroll to the **Environments** section.
110+
* <p>- For message, session, and log requests, specify the environment ID of the environment
111+
* where the assistant is deployed.
112+
*
113+
* <p>- For all other requests, specify the assistant ID of the assistant.
114+
*
115+
* <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
116+
* the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
117+
* and click **View Details**.
114118
*
115119
* <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
116-
* ID. To find the assistant ID in the user interface, open the assistant settings and click API
117-
* Details.
120+
* ID.
121+
*
122+
* <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
123+
* click **API Details**.
118124
*
119125
* @return the assistantId
120126
*/

0 commit comments

Comments
 (0)