Merge pull request #115 from IBM/test-classification-api

Text Classification APIs

Author: andreadimaio

modules/watsonx-ai-core/src/main/java/com/ibm/watsonx/ai/core/exeception/model/WatsonxError.java

@@ -71,6 +71,9 @@ public static enum Code {
         /** Text extraction event does not exist. */
         TEXT_EXTRACTION_EVENT_DOES_NOT_EXIST("text_extraction_event_does_not_exist"),
 
+        /** Text classification event does not exist. */
+        TEXT_CLASSIFICATION_EVENT_DOES_NOT_EXIST("text_classification_event_does_not_exist"),
+
         /** Access to Cloud Object Storage was denied. */
         COS_ACCESS_DENIED("AccessDenied"),
 

modules/watsonx-ai-core/src/test/java/com/ibm/watsonx/ai/core/WatsonxErrorTest.java

@@ -9,7 +9,7 @@
 import java.util.List;
 import org.junit.jupiter.api.Test;
 import com.ibm.watsonx.ai.core.exeception.model.WatsonxError;
-import com.ibm.watsonx.ai.core.exeception.model.WatsonxError.Error;;
+import com.ibm.watsonx.ai.core.exeception.model.WatsonxError.Error;
 
 public class WatsonxErrorTest {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/WatsonxJacksonModule.java

@@ -5,12 +5,17 @@
 package com.ibm.watsonx.ai;
 
 import java.util.List;
+import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.ibm.watsonx.ai.chat.model.AssistantMessage;
 import com.ibm.watsonx.ai.chat.model.JsonSchema.EnumSchema;
 import com.ibm.watsonx.ai.foundationmodel.FoundationModel;
+import com.ibm.watsonx.ai.textprocessing.KvpFields;
+import com.ibm.watsonx.ai.textprocessing.Schema;
 
 /**
  * Custom Jackson module used to register mix-in annotations for serializing and deserializing specific components.
@@ -32,12 +37,16 @@ public WatsonxJacksonModule() {
         setMixInAnnotation(FoundationModel.TargetModules.class, DefaultValueMixin.class);
         setMixInAnnotation(FoundationModel.DeploymentParameter.class, DefaultValueMixin.class);
         setMixInAnnotation(AssistantMessage.class, AssistantMessageMixIn.class);
+        setMixInAnnotation(Schema.class, SchemaMixin.class);
+        setMixInAnnotation(Schema.Builder.class, SchemaBuilderMixin.class);
+        setMixInAnnotation(KvpFields.class, KvpFieldsMixin.class);
+        setMixInAnnotation(KvpFields.Builder.class, KvpFieldsBuilderMixin.class);
     }
 
     /**
      * Mix-in interface to support enum deserialization where the enum values should be listed under the JSON property "enum".
      */
-    public static abstract class EnumSchemaMixin {
+    public abstract static class EnumSchemaMixin {
         @JsonProperty("enum")
         abstract List<String> enumValues();
     }
@@ -46,7 +55,7 @@ public static abstract class EnumSchemaMixin {
      * Mix-in abstract class for supporting default value serialization/deserialization. This is used for various parameter types that expose a
      * "default" field in JSON.
      */
-    public abstract class DefaultValueMixin {
+    public abstract static class DefaultValueMixin {
         @JsonProperty("default")
         abstract Object defaultValue();
     }
@@ -55,8 +64,35 @@ public abstract class DefaultValueMixin {
      * Mix-in abstract class for supporting serialization/deserialization of {@link AssistantMessage} without exposing the internal {@code thinking}
      * field.
      */
-    public abstract class AssistantMessageMixIn {
+    public abstract static class AssistantMessageMixIn {
         @JsonIgnore
         abstract String thinking();
     }
+
+    /**
+     * Mix-in class that provides custom deserialization support for the {@link Schema} model using its builder pattern.
+     */
+    @JsonDeserialize(builder = Schema.Builder.class)
+    public abstract class SchemaMixin {}
+
+    /**
+     * Mix-in class that provides custom deserialization support for the {@link Schema.Builder} model using its builder pattern.
+     */
+    @JsonPOJOBuilder(withPrefix = "")
+    public abstract class SchemaBuilderMixin {}
+
+    /**
+     * Mix-in class that provides custom deserialization support for the {@link KvpFields} model using its builder pattern.
+     */
+    @JsonDeserialize(builder = KvpFields.Builder.class)
+    public abstract class KvpFieldsMixin {}
+
+    /**
+     * Mix-in class that provides custom deserialization support for the {@link KvpFields.Builder} model using its builder pattern.
+     */
+    @JsonPOJOBuilder(withPrefix = "")
+    public abstract class KvpFieldsBuilderMixin {
+        @JsonAnySetter
+        public abstract KvpFields.Builder add(String key, KvpFields.KvpField value);
+    }
 }

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/WatsonxService.java

@@ -17,6 +17,7 @@
 import com.ibm.watsonx.ai.foundationmodel.FoundationModelService;
 import com.ibm.watsonx.ai.rerank.RerankService;
 import com.ibm.watsonx.ai.textgeneration.TextGenerationService;
+import com.ibm.watsonx.ai.textprocessing.textclassification.TextClassificationService;
 import com.ibm.watsonx.ai.textprocessing.textextraction.TextExtractionService;
 import com.ibm.watsonx.ai.timeseries.TimeSeriesService;
 import com.ibm.watsonx.ai.tokenization.TokenizationService;
@@ -33,6 +34,7 @@
  * @see RerankService
  * @see TokenizationService
  * @see TextExtractionService
+ * @see TextClassificationService
  * @see TimeSeriesService
  * @see FoundationModelService
  * @see ToolService

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/chat/DefaultRestClient.java

@@ -31,7 +31,7 @@
 import com.ibm.watsonx.ai.core.http.interceptors.LoggerInterceptor.LogMode;
 
 /**
- * Default implementation of the {@link ChatRestClient} interface.
+ * Default implementation of the {@link ChatRestClient} abstract class.
  */
 final class DefaultRestClient extends ChatRestClient {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/deployment/DefaultRestClient.java

@@ -35,7 +35,7 @@
 import com.ibm.watsonx.ai.timeseries.ForecastResponse;
 
 /**
- * Default implementation of the {@link DeploymentRestClient} interface.
+ * Default implementation of the {@link DeploymentRestClient} abstract class.
  */
 final class DefaultRestClient extends DeploymentRestClient {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/embedding/DefaultRestClient.java

@@ -18,7 +18,7 @@
 import com.ibm.watsonx.ai.core.http.interceptors.LoggerInterceptor.LogMode;
 
 /**
- * Default implementation of the {@link EmbeddingRestClient} interface.
+ * Default implementation of the {@link EmbeddingRestClient} abstract class.
  */
 final class DefaultRestClient extends EmbeddingRestClient {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/foundationmodel/DefaultRestClient.java

@@ -20,7 +20,7 @@
 import com.ibm.watsonx.ai.core.spi.json.TypeToken;
 
 /**
- * Default implementation of the {@link FoundationModelRestClient} interface.
+ * Default implementation of the {@link FoundationModelRestClient} abstract class.
  */
 final class DefaultRestClient extends FoundationModelRestClient {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/rerank/DefaultRestClient.java

@@ -18,7 +18,7 @@
 import com.ibm.watsonx.ai.core.http.interceptors.LoggerInterceptor.LogMode;
 
 /**
- * Default implementation of the {@link RerankRestClient} interface.
+ * Default implementation of the {@link RerankRestClient} abstract class.
  */
 final class DefaultRestClient extends RerankRestClient {
 

modules/watsonx-ai/src/main/java/com/ibm/watsonx/ai/textgeneration/DefaultRestClient.java

@@ -27,7 +27,7 @@
 import com.ibm.watsonx.ai.core.http.interceptors.LoggerInterceptor.LogMode;
 
 /**
- * Default implementation of the {@link TextGenerationRestClient} interface.
+ * Default implementation of the {@link TextGenerationRestClient} abstract class.
  */
 final class DefaultRestClient extends TextGenerationRestClient {