feat(discov2): new EnrichmentOptions parameters

Author: apaparazzi0329

discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateEnrichment.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2020, 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * 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
@@ -43,6 +43,14 @@ public class CreateEnrichment extends GenericModel {
    *
    * <p>* `watson_knowledge_studio_model`: Creates an enrichment from a Watson Knowledge Studio
    * machine learning model that is defined in a ZIP file.
+   *
+   * <p>* `webhook`: Connects to an external enrichment application by using a webhook. The feature
+   * is available from IBM Cloud-managed instances only. The external enrichment feature is beta
+   * functionality. Beta features are not supported by the SDKs.
+   *
+   * <p>* `sentence_classifier`: Use sentence classifier to classify sentences in your documents.
+   * This feature is available in IBM Cloud-managed instances only. The sentence classifier feature
+   * is beta functionality. Beta features are not supported by the SDKs.
    */
   public interface Type {
     /** classifier. */
@@ -57,6 +65,10 @@ public interface Type {
     String RULE_BASED = "rule_based";
     /** watson_knowledge_studio_model. */
     String WATSON_KNOWLEDGE_STUDIO_MODEL = "watson_knowledge_studio_model";
+    /** webhook. */
+    String WEBHOOK = "webhook";
+    /** sentence_classifier. */
+    String SENTENCE_CLASSIFIER = "sentence_classifier";
   }
 
   protected String name;
@@ -209,6 +221,14 @@ public String description() {
    * <p>* `watson_knowledge_studio_model`: Creates an enrichment from a Watson Knowledge Studio
    * machine learning model that is defined in a ZIP file.
    *
+   * <p>* `webhook`: Connects to an external enrichment application by using a webhook. The feature
+   * is available from IBM Cloud-managed instances only. The external enrichment feature is beta
+   * functionality. Beta features are not supported by the SDKs.
+   *
+   * <p>* `sentence_classifier`: Use sentence classifier to classify sentences in your documents.
+   * This feature is available in IBM Cloud-managed instances only. The sentence classifier feature
+   * is beta functionality. Beta features are not supported by the SDKs.
+   *
    * @return the type
    */
   public String type() {

discovery/src/main/java/com/ibm/watson/discovery/v2/model/Enrichment.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2020, 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * 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
@@ -38,6 +38,10 @@ public interface Type {
     String WATSON_KNOWLEDGE_STUDIO_MODEL = "watson_knowledge_studio_model";
     /** classifier. */
     String CLASSIFIER = "classifier";
+    /** webhook. */
+    String WEBHOOK = "webhook";
+    /** sentence_classifier. */
+    String SENTENCE_CLASSIFIER = "sentence_classifier";
   }
 
   @SerializedName("enrichment_id")

discovery/src/main/java/com/ibm/watson/discovery/v2/model/EnrichmentOptions.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2020, 2023.
+ * (C) Copyright IBM Corp. 2024.
  *
  * 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
@@ -46,6 +46,14 @@ public class EnrichmentOptions extends GenericModel {
   @SerializedName("top_k")
   protected Long topK;
 
+  protected String url;
+  protected String version;
+  protected String secret;
+  protected WebhookHeader headers;
+
+  @SerializedName("location_encoding")
+  protected String locationEncoding;
+
   /** Builder. */
   public static class Builder {
     private List<String> languages;
@@ -56,6 +64,11 @@ public static class Builder {
     private String modelId;
     private Double confidenceThreshold;
     private Long topK;
+    private String url;
+    private String version;
+    private String secret;
+    private WebhookHeader headers;
+    private String locationEncoding;
 
     /**
      * Instantiates a new Builder from an existing EnrichmentOptions instance.
@@ -71,6 +84,11 @@ private Builder(EnrichmentOptions enrichmentOptions) {
       this.modelId = enrichmentOptions.modelId;
       this.confidenceThreshold = enrichmentOptions.confidenceThreshold;
       this.topK = enrichmentOptions.topK;
+      this.url = enrichmentOptions.url;
+      this.version = enrichmentOptions.version;
+      this.secret = enrichmentOptions.secret;
+      this.headers = enrichmentOptions.headers;
+      this.locationEncoding = enrichmentOptions.locationEncoding;
     }
 
     /** Instantiates a new builder. */
@@ -86,9 +104,9 @@ public EnrichmentOptions build() {
     }
 
     /**
-     * Adds an languages to languages.
+     * Adds a new element to languages.
      *
-     * @param languages the new languages
+     * @param languages the new element to be added
      * @return the EnrichmentOptions builder
      */
     public Builder addLanguages(String languages) {
@@ -187,6 +205,61 @@ public Builder topK(long topK) {
       this.topK = topK;
       return this;
     }
+
+    /**
+     * Set the url.
+     *
+     * @param url the url
+     * @return the EnrichmentOptions builder
+     */
+    public Builder url(String url) {
+      this.url = url;
+      return this;
+    }
+
+    /**
+     * Set the version.
+     *
+     * @param version the version
+     * @return the EnrichmentOptions builder
+     */
+    public Builder version(String version) {
+      this.version = version;
+      return this;
+    }
+
+    /**
+     * Set the secret.
+     *
+     * @param secret the secret
+     * @return the EnrichmentOptions builder
+     */
+    public Builder secret(String secret) {
+      this.secret = secret;
+      return this;
+    }
+
+    /**
+     * Set the headers.
+     *
+     * @param headers the headers
+     * @return the EnrichmentOptions builder
+     */
+    public Builder headers(WebhookHeader headers) {
+      this.headers = headers;
+      return this;
+    }
+
+    /**
+     * Set the locationEncoding.
+     *
+     * @param locationEncoding the locationEncoding
+     * @return the EnrichmentOptions builder
+     */
+    public Builder locationEncoding(String locationEncoding) {
+      this.locationEncoding = locationEncoding;
+      return this;
+    }
   }
 
   protected EnrichmentOptions() {}
@@ -200,6 +273,11 @@ protected EnrichmentOptions(Builder builder) {
     modelId = builder.modelId;
     confidenceThreshold = builder.confidenceThreshold;
     topK = builder.topK;
+    url = builder.url;
+    version = builder.version;
+    secret = builder.secret;
+    headers = builder.headers;
+    locationEncoding = builder.locationEncoding;
   }
 
   /**
@@ -312,4 +390,69 @@ public Double confidenceThreshold() {
   public Long topK() {
     return topK;
   }
+
+  /**
+   * Gets the url.
+   *
+   * <p>A URL that uses the SSL protocol (begins with https) for the webhook. Required when type is
+   * `webhook`. Not valid when creating any other type of enrichment.
+   *
+   * @return the url
+   */
+  public String url() {
+    return url;
+  }
+
+  /**
+   * Gets the version.
+   *
+   * <p>The Discovery API version that allows to distinguish the schema. The version is specified in
+   * the `yyyy-mm-dd` format. Optional when `type` is `webhook`. Not valid when creating any other
+   * type of enrichment.
+   *
+   * @return the version
+   */
+  public String version() {
+    return version;
+  }
+
+  /**
+   * Gets the secret.
+   *
+   * <p>A private key can be included in the request to authenticate with the external service. The
+   * maximum length is 1,024 characters. Optional when `type` is `webhook`. Not valid when creating
+   * any other type of enrichment.
+   *
+   * @return the secret
+   */
+  public String secret() {
+    return secret;
+  }
+
+  /**
+   * Gets the headers.
+   *
+   * <p>An array of headers to pass with the HTTP request. Optional when `type` is `webhook`. Not
+   * valid when creating any other type of enrichment.
+   *
+   * @return the headers
+   */
+  public WebhookHeader headers() {
+    return headers;
+  }
+
+  /**
+   * Gets the locationEncoding.
+   *
+   * <p>Discovery calculates offsets of the text's location with this encoding type in documents.
+   * Use the same location encoding type in both Discovery and external enrichment for a document.
+   *
+   * <p>These encoding types are supported: `utf-8`, `utf-16`, and `utf-32`. Optional when `type` is
+   * `webhook`. Not valid when creating any other type of enrichment.
+   *
+   * @return the locationEncoding
+   */
+  public String locationEncoding() {
+    return locationEncoding;
+  }
 }

discovery/src/main/java/com/ibm/watson/discovery/v2/model/WebhookHeader.java

@@ -0,0 +1,126 @@
+/*
+ * (C) Copyright IBM Corp. 2024.
+ *
+ * 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.discovery.v2.model;
+
+import com.ibm.cloud.sdk.core.service.model.GenericModel;
+
+/**
+ * An array of headers to pass with the HTTP request. Optional when `type` is `webhook`. Not valid
+ * when creating any other type of enrichment.
+ */
+public class WebhookHeader extends GenericModel {
+
+  protected String name;
+  protected String value;
+
+  /** Builder. */
+  public static class Builder {
+    private String name;
+    private String value;
+
+    /**
+     * Instantiates a new Builder from an existing WebhookHeader instance.
+     *
+     * @param webhookHeader the instance to initialize the Builder with
+     */
+    private Builder(WebhookHeader webhookHeader) {
+      this.name = webhookHeader.name;
+      this.value = webhookHeader.value;
+    }
+
+    /** Instantiates a new builder. */
+    public Builder() {}
+
+    /**
+     * Instantiates a new builder with required properties.
+     *
+     * @param name the name
+     * @param value the value
+     */
+    public Builder(String name, String value) {
+      this.name = name;
+      this.value = value;
+    }
+
+    /**
+     * Builds a WebhookHeader.
+     *
+     * @return the new WebhookHeader instance
+     */
+    public WebhookHeader build() {
+      return new WebhookHeader(this);
+    }
+
+    /**
+     * Set the name.
+     *
+     * @param name the name
+     * @return the WebhookHeader builder
+     */
+    public Builder name(String name) {
+      this.name = name;
+      return this;
+    }
+
+    /**
+     * Set the value.
+     *
+     * @param value the value
+     * @return the WebhookHeader builder
+     */
+    public Builder value(String value) {
+      this.value = value;
+      return this;
+    }
+  }
+
+  protected WebhookHeader() {}
+
+  protected WebhookHeader(Builder builder) {
+    com.ibm.cloud.sdk.core.util.Validator.notNull(builder.name, "name cannot be null");
+    com.ibm.cloud.sdk.core.util.Validator.notNull(builder.value, "value cannot be null");
+    name = builder.name;
+    value = builder.value;
+  }
+
+  /**
+   * New builder.
+   *
+   * @return a WebhookHeader builder
+   */
+  public Builder newBuilder() {
+    return new Builder(this);
+  }
+
+  /**
+   * Gets the name.
+   *
+   * <p>The name of an HTTP header.
+   *
+   * @return the name
+   */
+  public String name() {
+    return name;
+  }
+
+  /**
+   * Gets the value.
+   *
+   * <p>The value of an HTTP header.
+   *
+   * @return the value
+   */
+  public String value() {
+    return value;
+  }
+}