Merge pull request #1074 from watson-developer-cloud/release-7.3.0

Release 7.3.0

Author: lpatino10

.travis.yml

@@ -49,12 +49,10 @@ script:
 - "./gradlew docs > /dev/null"
 after_success:
 - bash <(curl -s https://codecov.io/bash)
-before_deploy:
-- pip install --user travis-wait-improved
 deploy:
 - provider: script
   skip_cleanup: true
-  script: travis-wait-improved --timeout=30m ./gradlew bintrayUpload
+  script: travis_wait 30 ./gradlew bintrayUpload
   on:
     tags: true
     jdk: openjdk7

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

@@ -160,6 +160,10 @@ public Assistant(String versionDate, AuthenticatorConfig authenticatorConfig) {
    *
    * Send user input to a workspace and receive a response.
    *
+   * **Note:** For most applications, there are significant advantages to using the v2 runtime API instead. These
+   * advantages include ease of deployment, automatic state management, versioning, and search capabilities. For more
+   * information, see the [documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-api-overview).
+   *
    * There is no rate limit for this operation.
    *
    * @param messageOptions the {@link MessageOptions} containing the options for the call

assistant/src/main/java/com/ibm/watson/assistant/v1/model/RuntimeEntity.java

@@ -85,7 +85,7 @@ public void setLocation(final List<Long> location) {
   /**
    * Gets the value.
    *
-   * The term in the input text that was recognized as an entity value.
+   * The entity value that was recognized in the user input.
    *
    * @return the value
    */
@@ -105,7 +105,7 @@ public void setValue(final String value) {
   /**
    * Gets the confidence.
    *
-   * A decimal percentage that represents Watson's confidence in the entity.
+   * A decimal percentage that represents Watson's confidence in the recognized entity.
    *
    * @return the confidence
    */

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

@@ -72,6 +72,8 @@ public interface Preference {
   private String messageToHumanAgent;
   private String topic;
   private List<DialogSuggestion> suggestions;
+  private String header;
+  private List<SearchResult> results;
 
   /**
    * Builder.
@@ -89,6 +91,8 @@ public static class Builder {
     private String messageToHumanAgent;
     private String topic;
     private List<DialogSuggestion> suggestions;
+    private String header;
+    private List<SearchResult> results;
 
     private Builder(DialogRuntimeResponseGeneric dialogRuntimeResponseGeneric) {
       this.responseType = dialogRuntimeResponseGeneric.responseType;
@@ -103,6 +107,8 @@ private Builder(DialogRuntimeResponseGeneric dialogRuntimeResponseGeneric) {
       this.messageToHumanAgent = dialogRuntimeResponseGeneric.messageToHumanAgent;
       this.topic = dialogRuntimeResponseGeneric.topic;
       this.suggestions = dialogRuntimeResponseGeneric.suggestions;
+      this.header = dialogRuntimeResponseGeneric.header;
+      this.results = dialogRuntimeResponseGeneric.results;
     }
 
     /**
@@ -159,6 +165,21 @@ public Builder addSuggestions(DialogSuggestion suggestions) {
       return this;
     }
 
+    /**
+     * Adds an results to results.
+     *
+     * @param results the new results
+     * @return the DialogRuntimeResponseGeneric builder
+     */
+    public Builder addResults(SearchResult results) {
+      Validator.notNull(results, "results cannot be null");
+      if (this.results == null) {
+        this.results = new ArrayList<SearchResult>();
+      }
+      this.results.add(results);
+      return this;
+    }
+
     /**
      * Set the responseType.
      *
@@ -292,6 +313,29 @@ public Builder suggestions(List<DialogSuggestion> suggestions) {
       this.suggestions = suggestions;
       return this;
     }
+
+    /**
+     * Set the header.
+     *
+     * @param header the header
+     * @return the DialogRuntimeResponseGeneric builder
+     */
+    public Builder header(String header) {
+      this.header = header;
+      return this;
+    }
+
+    /**
+     * Set the results.
+     * Existing results will be replaced.
+     *
+     * @param results the results
+     * @return the DialogRuntimeResponseGeneric builder
+     */
+    public Builder results(List<SearchResult> results) {
+      this.results = results;
+      return this;
+    }
   }
 
   private DialogRuntimeResponseGeneric(Builder builder) {
@@ -308,6 +352,8 @@ private DialogRuntimeResponseGeneric(Builder builder) {
     messageToHumanAgent = builder.messageToHumanAgent;
     topic = builder.topic;
     suggestions = builder.suggestions;
+    header = builder.header;
+    results = builder.results;
   }
 
   /**
@@ -457,4 +503,26 @@ public String getTopic() {
   public List<DialogSuggestion> getSuggestions() {
     return suggestions;
   }
+
+  /**
+   * Gets the header.
+   *
+   * The title or introductory text to show before the response. This text is defined in the search skill configuration.
+   *
+   * @return the header
+   */
+  public String getHeader() {
+    return header;
+  }
+
+  /**
+   * Gets the results.
+   *
+   * An array of objects containing search results.
+   *
+   * @return the results
+   */
+  public List<SearchResult> getResults() {
+    return results;
+  }
 }

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

@@ -18,7 +18,7 @@
 import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * A term from the request that was identified as an entity.
+ * The entity value that was recognized in the user input.
  */
 public class RuntimeEntity extends GenericModel {
 
@@ -66,7 +66,7 @@ public String getValue() {
   /**
    * Gets the confidence.
    *
-   * A decimal percentage that represents Watson's confidence in the entity.
+   * A decimal percentage that represents Watson's confidence in the recognized entity.
    *
    * @return the confidence
    */

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

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2018 IBM Corp. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package com.ibm.watson.assistant.v2.model;
+
+import com.google.gson.annotations.SerializedName;
+import com.ibm.cloud.sdk.core.service.model.GenericModel;
+
+/**
+ * SearchResult.
+ */
+public class SearchResult extends GenericModel {
+
+  private String id;
+  @SerializedName("result_metadata")
+  private SearchResultMetadata resultMetadata;
+  private String body;
+  private String title;
+  private String url;
+  private SearchResultHighlight highlight;
+
+  /**
+   * Gets the id.
+   *
+   * The unique identifier of the document in the Discovery service collection.
+   *
+   * This property is included in responses from search skills, which are a beta feature available only to Plus or
+   * Premium plan users.
+   *
+   * @return the id
+   */
+  public String getId() {
+    return id;
+  }
+
+  /**
+   * Gets the resultMetadata.
+   *
+   * An object containing search result metadata from the Discovery service.
+   *
+   * @return the resultMetadata
+   */
+  public SearchResultMetadata getResultMetadata() {
+    return resultMetadata;
+  }
+
+  /**
+   * Gets the body.
+   *
+   * A description of the search result. This is taken from an abstract, summary, or highlight field in the Discovery
+   * service response, as specified in the search skill configuration.
+   *
+   * @return the body
+   */
+  public String getBody() {
+    return body;
+  }
+
+  /**
+   * Gets the title.
+   *
+   * The title of the search result. This is taken from a title or name field in the Discovery service response, as
+   * specified in the search skill configuration.
+   *
+   * @return the title
+   */
+  public String getTitle() {
+    return title;
+  }
+
+  /**
+   * Gets the url.
+   *
+   * The URL of the original data object in its native data source.
+   *
+   * @return the url
+   */
+  public String getUrl() {
+    return url;
+  }
+
+  /**
+   * Gets the highlight.
+   *
+   * An object containing segments of text from search results with query-matching text highlighted using HTML <em>
+   * tags.
+   *
+   * @return the highlight
+   */
+  public SearchResultHighlight getHighlight() {
+    return highlight;
+  }
+}

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

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2018 IBM Corp. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package com.ibm.watson.assistant.v2.model;
+
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.reflect.TypeToken;
+import com.ibm.cloud.sdk.core.service.model.DynamicModel;
+
+/**
+ * An object containing segments of text from search results with query-matching text highlighted using HTML <em> tags.
+ */
+public class SearchResultHighlight extends DynamicModel<List<String>> {
+  @SerializedName("body")
+  private List<String> body;
+  @SerializedName("title")
+  private List<String> title;
+  @SerializedName("url")
+  private List<String> url;
+
+  public SearchResultHighlight() {
+    super(new TypeToken<List<String>>() {
+    });
+  }
+
+  /**
+   * Gets the body.
+   *
+   * An array of strings containing segments taken from body text in the search results, with query-matching substrings
+   * highlighted.
+   *
+   * @return the body
+   */
+  public List<String> getBody() {
+    return this.body;
+  }
+
+  /**
+   * Gets the title.
+   *
+   * An array of strings containing segments taken from title text in the search results, with query-matching substrings
+   * highlighted.
+   *
+   * @return the title
+   */
+  public List<String> getTitle() {
+    return this.title;
+  }
+
+  /**
+   * Gets the url.
+   *
+   * An array of strings containing segments taken from URLs in the search results, with query-matching substrings
+   * highlighted.
+   *
+   * @return the url
+   */
+  public List<String> getUrl() {
+    return this.url;
+  }
+}