Merge pull request HamaWhiteGG#134 from HamaWhiteGG/dev

Supports functions HamaWhiteGG#133
dinsy008 · Nov 30, 2023 · d1e577a · d1e577a
2 parents aac53a3 + 9f9aa83
commit d1e577a
Show file tree

Hide file tree

Showing 22 changed files with 869 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,9 @@ The following example can view in the [langchain-example](langchain-examples/src
 ## 3. Integrations
 
 ### 3.1 LLMs
-- [OpenAI](langchain-examples/src/main/java/com/hw/langchain/examples/llms/OpenAIExample.java), (support [stream](langchain-examples/src/main/java/com/hw/langchain/examples/llms/StreamOpenAIExample.java))
+- [OpenAI](langchain-examples/src/main/java/com/hw/langchain/examples/llms/OpenAIExample.java), 
+  - support [stream](langchain-examples/src/main/java/com/hw/langchain/examples/llms/StreamOpenAIExample.java)
+  - support [functions](openai-client/src/test/java/com/hw/openai/function/ChatFunctionTest.java)
 - [Azure OpenAI](openai-client/src/test/java/com/hw/openai/AzureOpenAiClientTest.java)
 - [ChatGLM2](langchain-examples/src/main/java/com/hw/langchain/examples/llms/ChatGLMExample.java)
 - [Ollama](langchain-examples/src/main/java/com/hw/langchain/examples/llms/OllamaExample.java)

diff --git a/langchain-core/pom.xml b/langchain-core/pom.xml
@@ -133,6 +133,12 @@
         <dependency>
             <groupId>org.redisson</groupId>
             <artifactId>redisson</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-core</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>

diff --git a/openai-client/pom.xml b/openai-client/pom.xml
@@ -41,6 +41,16 @@
             <artifactId>jackson-annotations</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.module</groupId>
+            <artifactId>jackson-module-parameter-names</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.hibernate.validator</groupId>
             <artifactId>hibernate-validator</artifactId>

diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/ChatChoice.java b/openai-client/src/main/java/com/hw/openai/entity/chat/ChatChoice.java
@@ -35,6 +35,12 @@ public class ChatChoice {
     @JsonAlias("delta")
     private Message message;
 
+    /**
+     * The reason the model stopped generating tokens. This will be stopped if the model hit a natural stop point or a
+     * provided stop sequence, length if the maximum number of tokens specified in the request was reached,
+     * content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a
+     * tool, or function_call (deprecated) if the model called a function.
+     */
     @JsonProperty("finish_reason")
     private String finishReason;
 }
diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/ChatCompletion.java b/openai-client/src/main/java/com/hw/openai/entity/chat/ChatCompletion.java
@@ -82,6 +82,12 @@ public class ChatCompletion implements Serializable {
      */
     private boolean stream;
 
+    /**
+     * This feature is in Beta. If specified, our system will make a best effort to sample deterministically,
+     * such that repeated requests with the same seed and parameters should return the same result.
+     */
+    private Integer seed;
+
     /**
      * Up to 4 sequences where the API will stop generating further tokens.
      */
@@ -119,4 +125,19 @@ public class ChatCompletion implements Serializable {
      * A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
      */
     private String user;
+
+    /**
+     * A list of tools the model may call. Currently, only functions are supported as a tool.
+     * Use this to provide a list of functions the model may generate JSON inputs for.
+     */
+    private List<Tool> tools;
+
+    /**
+     * Controls which (if any) function is called by the model. none means the model will not call a function and
+     * instead generates a message.
+     * <p>
+     * none is the default when no functions are present. auto is the default if functions are present.
+     */
+    @JsonProperty("tool_choice")
+    private String toolChoice;
 }
diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/ChatCompletionResp.java b/openai-client/src/main/java/com/hw/openai/entity/chat/ChatCompletionResp.java
@@ -18,6 +18,7 @@
 
 package com.hw.openai.entity.chat;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.hw.openai.entity.completions.Usage;
 
 import lombok.Data;
@@ -39,6 +40,13 @@ public class ChatCompletionResp {
 
     private String model;
 
+    /**
+     * This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with
+     * the seed request parameter to understand when backend changes have been made that might impact determinism.
+     */
+    @JsonProperty("system_fingerprint")
+    private String systemFingerprint;
+
     private List<ChatChoice> choices;
 
     private Usage usage;

diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/ChatFunction.java b/openai-client/src/main/java/com/hw/openai/entity/chat/ChatFunction.java
@@ -0,0 +1,70 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.hw.openai.entity.chat;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+/**
+ * @author HamaWhite
+ */
+@Data
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ChatFunction {
+
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes,
+     * with a maximum length of 64.
+     */
+    @NotBlank
+    private String name;
+
+    /**
+     * A description of what the function does, used by the model to choose when and how to call the function.
+     */
+    private String description;
+
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object.
+     * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}
+     */
+    @NotNull
+    private ChatParameter parameters;
+
+    @Data
+    @NoArgsConstructor
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public static class ChatParameter {
+
+        private String type;
+
+        private ObjectNode properties;
+
+        private List<String> required;
+    }
+}
diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/Function.java b/openai-client/src/main/java/com/hw/openai/entity/chat/Function.java
@@ -0,0 +1,40 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.hw.openai.entity.chat;
+
+import lombok.Data;
+
+/**
+ * @author HamaWhite
+ */
+@Data
+public class Function {
+
+    /**
+     * The name of the function to call.
+     */
+    private String name;
+
+    /**
+     * The arguments to call the function with, as generated by the model in JSON format.
+     * Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your
+     * function schema. Validate the arguments in your code before calling your function.
+     */
+    private String arguments;
+}
diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/Message.java b/openai-client/src/main/java/com/hw/openai/entity/chat/Message.java
@@ -19,6 +19,7 @@
 package com.hw.openai.entity.chat;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 
 import jakarta.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
@@ -27,6 +28,7 @@
 import lombok.NoArgsConstructor;
 
 import java.io.Serializable;
+import java.util.List;
 
 /**
  * Message
@@ -59,11 +61,23 @@ public class Message implements Serializable {
      */
     private String name;
 
+    /**
+     * The name and arguments of a function that should be called, as generated by the model.
+     */
+    @JsonProperty("tool_calls")
+    private List<ToolCall> toolCalls;
+
     public Message(Role role, String content) {
         this.role = role;
         this.content = content;
     }
 
+    public Message(Role role, String content, String name) {
+        this.role = role;
+        this.content = content;
+        this.name = name;
+    }
+
     public static Message of(String role, String content) {
         return new Message(Role.fromValue(role), content);
     }

diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/Tool.java b/openai-client/src/main/java/com/hw/openai/entity/chat/Tool.java
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.hw.openai.entity.chat;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import lombok.Data;
+
+/**
+ * @author HamaWhite
+ */
+
+@Data
+public class Tool {
+
+    /**
+     * The type of the tool. Currently, only function is supported.
+     */
+    private String type = "function";
+
+    @JsonProperty("function")
+    private ChatFunction chatFunction;
+
+    public Tool(ChatFunction chatFunction) {
+        this.chatFunction = chatFunction;
+    }
+}
diff --git a/openai-client/src/main/java/com/hw/openai/entity/chat/ToolCall.java b/openai-client/src/main/java/com/hw/openai/entity/chat/ToolCall.java
@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.hw.openai.entity.chat;
+
+import lombok.Data;
+
+/**
+ * @author HamaWhite
+ */
+@Data
+public class ToolCall {
+
+    private Integer index;
+
+    /**
+     * The ID of the tool call.
+     */
+    private String id;
+
+    /**
+     * The type of the tool. Currently, only function is supported.
+     */
+    private String type;
+
+    private Function function;
+}
diff --git a/openai-client/src/main/java/com/hw/openai/function/FunctionExecutor.java b/openai-client/src/main/java/com/hw/openai/function/FunctionExecutor.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.hw.openai.function;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+
+import static com.hw.openai.utils.JsonUtils.convertFromJsonStr;
+
+/**
+ * @author HamaWhite
+ */
+public class FunctionExecutor {
+
+    private static final Map<String, Function<?, ?>> FUNCTION_MAP = new HashMap<>(16);
+
+    public static <T> void register(String functionName, Function<T, ?> function) {
+        FUNCTION_MAP.put(functionName, function);
+    }
+
+    @SuppressWarnings("unchecked")
+    public static <T, R> R execute(String functionName, Class<T> clazz, String arguments) throws ClassCastException {
+        Function<T, R> function = (Function<T, R>) FUNCTION_MAP.get(functionName);
+        if (function == null) {
+            throw new IllegalArgumentException("No function registered with name: " + functionName);
+        }
+        T input = convertFromJsonStr(arguments, clazz);
+        return function.apply(input);
+    }
+}