feat: custom tool

Author: szl97

api/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>top.bella</groupId>
         <artifactId>openai-java</artifactId>
-        <version>0.23.61</version>
+        <version>0.23.62</version>
     </parent>
     <packaging>jar</packaging>
     <artifactId>openai-api</artifactId>

api/src/main/java/com/theokanning/openai/assistants/assistant/Tool.java

@@ -5,11 +5,14 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.theokanning.openai.response.tool.definition.CustomTool;
 import com.theokanning.openai.response.tool.definition.ImageGenerationTool;
 import com.theokanning.openai.response.tool.definition.LocalShellTool;
 import com.theokanning.openai.response.tool.definition.ToolDefinition;
 import com.theokanning.openai.response.tool.definition.WebSearchTool;
+import lombok.AllArgsConstructor;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
 import javax.validation.constraints.NotBlank;
 import java.util.ArrayList;
@@ -23,6 +26,7 @@
  **/
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
 @JsonSubTypes({
+        @JsonSubTypes.Type(value = Tool.Custom.class, name = "custom_tool"),
         @JsonSubTypes.Type(value = Tool.LocalShell.class, name = "local_shell"),
         @JsonSubTypes.Type(value = Tool.Function.class, name = "function"),
         @JsonSubTypes.Type(value = CodeInterpreterTool.class, name = "code_interpreter"),
@@ -61,6 +65,24 @@ default ToolDefinition definition() {
         return null;
     }
 
+    @Data
+    @AllArgsConstructor
+    @NoArgsConstructor
+    class Custom implements Tool {
+
+        private CustomTool definition;
+
+        @Override
+        public String getType() {
+            return "custom_tool";
+        }
+
+        @Override
+        public ToolDefinition definition() {
+            return definition;
+        }
+    }
+
     class LocalShell implements Tool {
 
         @Override

api/src/main/java/com/theokanning/openai/response/tool/definition/CustomTool.java

@@ -1,5 +1,9 @@
 package com.theokanning.openai.response.tool.definition;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.theokanning.openai.assistants.assistant.Tool;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -34,13 +38,33 @@ public class CustomTool implements ToolDefinition {
     /**
      * Input format specification.
      */
-    private Object format; // TextFormat or GrammarFormat
+    private Format format; // TextFormat or GrammarFormat
+
+
+    @JsonTypeInfo(
+            use = JsonTypeInfo.Id.NAME,
+            include = JsonTypeInfo.As.EXISTING_PROPERTY,
+            property = "type"
+    )
+    @JsonSubTypes({
+            @JsonSubTypes.Type(value = TextFormat.class, name = "text"),
+            @JsonSubTypes.Type(value = GrammarFormat.class, name = "grammar"),
+    })
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public interface Format {
+
+        /**
+         * Get the tool type.
+         */
+        String getType();
+    }
+
 
     @Data
     @Builder
     @NoArgsConstructor
     @AllArgsConstructor
-    public static class TextFormat {
+    public static class TextFormat implements Format {
 
         /**
          * Format type, always "text".
@@ -52,7 +76,7 @@ public static class TextFormat {
     @Builder
     @NoArgsConstructor
     @AllArgsConstructor
-    public static class GrammarFormat {
+    public static class GrammarFormat implements Format {
 
         /**
          * Format type, always "grammar".
@@ -69,4 +93,9 @@ public static class GrammarFormat {
          */
         private String definition;
     }
+
+    @Override
+    public Tool getRealTool() {
+        return new Tool.Custom(this);
+    }
 }

client/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>top.bella</groupId>
         <artifactId>openai-java</artifactId>
-        <version>0.23.61</version>
+        <version>0.23.62</version>
     </parent>
     <packaging>jar</packaging>
 

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>top.bella</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.23.61</version>
+    <version>0.23.62</version>
     <packaging>pom</packaging>
     <description>openai java 版本</description>
     <name>openai-java</name>

service/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>top.bella</groupId>
         <artifactId>openai-java</artifactId>
-        <version>0.23.61</version>
+        <version>0.23.62</version>
     </parent>
     <packaging>jar</packaging>