docs：文档

README.md

+# 智谱大模型开放SDK - By 小傅哥版本
+
+为了让研发伙伴更快，更方便的接入使用智谱大模型，而开发的 chatglm-sdk-java 也欢迎👏🏻大家基于智谱API接口补充功能。
+
+此SDK设计，以 Session 会话模型，提供工厂🏭创建服务。代码非常清晰，易于扩展、易于维护。你的贡献💐会让AI更加璀璨，感谢智谱AI团队。
+
+## 安装
+
+- 申请ApiKey：[https://open.bigmodel.cn/usercenter/apikeys](https://open.bigmodel.cn/usercenter/apikeys) - 注册申请开通，即可获得 ApiKey
+- 运行环境：JDK 1.8+
+- maven pom - `暂时测试阶段，未推送到Maven中央仓库，需要下载代码本地 install 后使用`
+
+```pom
+<dependency>
+    <groupId>cn.bugstack</groupId>
+    <artifactId>chatglm-sdk-java</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```
+
+## 测试
+
+```java
+@Slf4j
+public class ApiTest {
+
+    private OpenAiSession openAiSession;
+
+    @Before
+    public void test_OpenAiSessionFactory() {
+        // 1. 配置文件
+        Configuration configuration = new Configuration();
+        configuration.setApiHost("https://open.bigmodel.cn/");
+        configuration.setApiSecretKey("4e087e4135306ef4a676f0cce3cee560.sgP2*****");
+        // 2. 会话工厂
+        OpenAiSessionFactory factory = new DefaultOpenAiSessionFactory(configuration);
+        // 3. 开启会话
+        this.openAiSession = factory.openSession();
+    }
+
+    /**
+     * 流式对话
+     */
+    @Test
+    public void test_completions() throws JsonProcessingException, InterruptedException {
+        // 入参；模型、请求信息
+        ChatCompletionRequest request = new ChatCompletionRequest();
+        request.setModel(Model.CHATGLM_LITE); // chatGLM_6b_SSE、chatglm_lite、chatglm_lite_32k、chatglm_std、chatglm_pro
+        request.setPrompt(new ArrayList<ChatCompletionRequest.Prompt>() {
+            private static final long serialVersionUID = -7988151926241837899L;
+
+            {
+                add(ChatCompletionRequest.Prompt.builder()
+                        .role(Role.user.getCode())
+                        .content("写个java冒泡排序")
+                        .build());
+            }
+        });
+
+        // 请求
+        openAiSession.completions(request, new EventSourceListener() {
+            @Override
+            public void onEvent(EventSource eventSource, @Nullable String id, @Nullable String type, String data) {
+                ChatCompletionResponse response = JSON.parseObject(data, ChatCompletionResponse.class);
+                log.info("测试结果 onEvent：{}", response.getData());
+                // type 消息类型，add 增量，finish 结束，error 错误，interrupted 中断
+                if (EventType.finish.getCode().equals(type)) {
+                    ChatCompletionResponse.Meta meta = JSON.parseObject(response.getMeta(), ChatCompletionResponse.Meta.class);
+                    log.info("[输出结束] Tokens {}", JSON.toJSONString(meta));
+                }
+            }
+
+            @Override
+            public void onClosed(EventSource eventSource) {
+                log.info("对话完成");
+            }
+        });
+
+        // 等待
+        new CountDownLatch(1).await();
+    }
+
+}
+```
+
+- 这是一个单元测试类，也是最常使用的流式对话模式。
+
+## 接入
+
+SpringBoot 配置类
+
+```java
+@Configuration
+@EnableConfigurationProperties(ChatGLMSDKConfigProperties.class)
+public class ChatGLMSDKConfig {
+
+    @Bean
+    public OpenAiSession openAiSession(ChatGLMSDKConfigProperties properties) {
+        // 1. 配置文件
+        cn.bugstack.chatglm.session.Configuration configuration = new cn.bugstack.chatglm.session.Configuration();
+        configuration.setApiHost(properties.getApiHost());
+        configuration.setApiSecretKey(properties.getApiSecretKey());
+
+        // 2. 会话工厂
+        OpenAiSessionFactory factory = new DefaultOpenAiSessionFactory(configuration);
+
+        // 3. 开启会话
+        return factory.openSession();
+    }
+
+}
+
+@Data
+@ConfigurationProperties(prefix = "chatglm.sdk.config", ignoreInvalidFields = true)
+public class ChatGLMSDKConfigProperties {
+    
+    /** 转发地址 */
+    private String apiHost;
+    /** 可以申请 sk-*** */
+    private String apiSecretKey;
+
+}
+```
+
+yml 配置
+
+```pom
+# ChatGLM SDK Config
+chatgpt:
+  sdk:
+    config:
+      # 官网地址 
+      api-host: https://open.bigmodel.cn/
+      # 官网申请 https://open.bigmodel.cn/usercenter/apikeys
+      api-key: 4e087e4135306ef4a676f0cce3cee560.sgP2DUs*****
+```
\ No newline at end of file