Merge pull request #248 from xiexiaojing/main

1:客户端核心类添加基础doc文档注释 2:优化异常抛出文案 3:格式化日期类移除到客户端核心类外，避免用户误用,对用户更友好

Author: PlexPt

src/main/java/com/plexpt/chatgpt/ChatGPT.java

@@ -40,6 +40,8 @@
 import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
 import retrofit2.converter.jackson.JacksonConverterFactory;
 
+import static com.plexpt.chatgpt.util.FormatDateUtil.formatDate;
+
 
 /**
  * open ai 客户端
@@ -80,7 +82,7 @@ public class ChatGPT {
 
 
     /**
-     * 初始化
+     * 初始化：与服务端建立连接，成功后可直接与服务端进行对话
      */
     public ChatGPT init() {
         OkHttpClient.Builder client = new OkHttpClient.Builder();
@@ -109,7 +111,7 @@ public ChatGPT init() {
                     log.error(baseResponse.getError().getMessage());
                     throw new ChatException(baseResponse.getError().getMessage());
                 }
-                throw new ChatException("error");
+                throw new ChatException("ChatGPT init error!");
             }
             return response;
         });
@@ -139,8 +141,8 @@ public ChatGPT init() {
     /**
      * 最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
      *
-     * @param chatCompletion 问答参数
-     * @return 答案
+     * @param chatCompletion 问答参数，即咨询的内容
+     * @return 服务端的问答响应
      */
     public ChatCompletionResponse chatCompletion(ChatCompletion chatCompletion) {
         Single<ChatCompletionResponse> chatCompletionResponse =
@@ -149,17 +151,20 @@ public ChatCompletionResponse chatCompletion(ChatCompletion chatCompletion) {
     }
 
     /**
-     * 简易版
+     * 支持多个问答参数来与服务端进行对话
      *
-     * @param messages 问答参数
+     * @param messages  问答参数，即咨询的内容
+     * @return 服务端的问答响应
      */
     public ChatCompletionResponse chatCompletion(List<Message> messages) {
         ChatCompletion chatCompletion = ChatCompletion.builder().messages(messages).build();
         return this.chatCompletion(chatCompletion);
     }
 
     /**
-     * 直接问
+     * 与服务端进行对话
+     * @param message 问答参数，即咨询的内容
+     * @return 服务端的问答响应
      */
     public String chat(String message) {
         ChatCompletion chatCompletion = ChatCompletion.builder()
@@ -172,7 +177,7 @@ public String chat(String message) {
     /**
      * 余额查询
      *
-     * @return
+     * @return 余额总金额及明细
      */
     public CreditGrantsResponse creditGrants() {
         Single<CreditGrantsResponse> creditGrants = this.apiClient.creditGrants();
@@ -183,7 +188,7 @@ public CreditGrantsResponse creditGrants() {
     /**
      * 余额查询
      *
-     * @return
+     * @return 余额总金额
      */
     public BigDecimal balance() {
         Single<SubscriptionData> subscription = apiClient.subscription();
@@ -200,9 +205,9 @@ public BigDecimal balance() {
     }
 
     /**
-     * 余额查询
+     * 新建连接进行余额查询
      *
-     * @return
+     * @return 余额总金额
      */
     public static BigDecimal balance(String key) {
         ChatGPT chatGPT = ChatGPT.builder()
@@ -212,9 +217,4 @@ public static BigDecimal balance(String key) {
 
         return chatGPT.balance();
     }
-
-    public static String formatDate(Date date) {
-        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd", Locale.getDefault());
-        return sdf.format(date);
-    }
 }

src/main/java/com/plexpt/chatgpt/util/FormatDateUtil.java

@@ -0,0 +1,17 @@
+package com.plexpt.chatgpt.util;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Locale;
+
+public class FormatDateUtil {
+    /**
+     * 使用SimpleDateFormat格式化日期为yyyy-MM-dd，每次新建对象避免线程安全问题
+     * @param date 日期
+     * @return yyyy-MM-dd格式的日期字符串对象
+     */
+    public static String formatDate(Date date) {
+        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd", Locale.getDefault());
+        return sdf.format(date);
+    }
+}