chore(wa-v2): update comments

Author: apaparazzi0329

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

@@ -119,23 +119,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -135,23 +135,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -112,23 +112,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -86,23 +86,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -104,23 +104,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -138,23 +138,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -119,23 +119,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -101,23 +101,9 @@ public Builder newBuilder() {
   /**
    * Gets the assistantId.
    *
-   * <p>The assistant ID or the environment ID of the environment where the assistant is deployed.
-   * Set the value for this ID depending on the type of request:
-   *
-   * <p>- For message, session, and log requests, specify the environment ID of the environment
-   * where the assistant is deployed.
-   *
-   * <p>- For all other requests, specify the assistant ID of the assistant.
-   *
-   * <p>To get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open
-   * the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section
-   * and click **View Details**.
-   *
-   * <p>**Note:** If you are using the classic Watson Assistant experience, always use the assistant
-   * ID.
-   *
-   * <p>To find the **assistant ID** in the user interface, open the **Assistant settings** and
-   * click **API Details**.
+   * <p>Unique identifier of the assistant. To get the **assistant ID** in the watsonx Assistant
+   * interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API
+   * details** section and click **View Details**.
    *
    * @return the assistantId
    */

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

@@ -103,6 +103,8 @@ public GenerativeAITaskConfidenceScores getConfidenceScores() {
   /**
    * Gets the originalResponse.
    *
+   * <p>The original response returned by the generative ai.
+   *
    * @return the originalResponse
    */
   public String getOriginalResponse() {
@@ -112,6 +114,9 @@ public String getOriginalResponse() {
   /**
    * Gets the inferredQuery.
    *
+   * <p>Generated from the input text after auto-correction. If this field is not present, the input
+   * text was used as the query to the generative ai.
+   *
    * @return the inferredQuery
    */
   public String getInferredQuery() {

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

@@ -39,6 +39,8 @@ protected GenerativeAITaskConfidenceScores() {}
   /**
    * Gets the preGen.
    *
+   * <p>The confidence score based on user query and search results.
+   *
    * @return the preGen
    */
   public Double getPreGen() {
@@ -48,6 +50,10 @@ public Double getPreGen() {
   /**
    * Gets the preGenThreshold.
    *
+   * <p>The pre_gen confidence score threshold. If the pre_gen score is below this threshold, it
+   * shows an “I don't know” response instead of the generated response. Shown in the conversational
+   * search skill UI as the “Retrieval Confidence threshold”.
+   *
    * @return the preGenThreshold
    */
   public Double getPreGenThreshold() {
@@ -57,6 +63,8 @@ public Double getPreGenThreshold() {
   /**
    * Gets the postGen.
    *
+   * <p>The confidence score based on user query, search results, and the generated response.
+   *
    * @return the postGen
    */
   public Double getPostGen() {
@@ -66,6 +74,10 @@ public Double getPostGen() {
   /**
    * Gets the postGenThreshold.
    *
+   * <p>The post_gen confidence score threshold. If the post_gen score is below this threshold, it
+   * shows an “I don't know” response instead of the generated response. Shown in the conversational
+   * search skill UI as the “Response Confidence threshold”.
+   *
    * @return the postGenThreshold
    */
   public Double getPostGenThreshold() {