agents-flex

环境要求

• JDK 8 及以上（核心模块兼容 Java 8+）
• 可编辑 pom.xml 的 Maven 工程（普通 Java 或 Spring Boot 均可）
• 一个 OpenAI 兼容的模型服务，需提供 endpoint、model、apiKey
• 如需流式输出，需要实现 StreamResponseListener 接口

安装与启动步骤

1. 1添加 Maven 依赖

   普通 Java 项目在 pom.xml 中引入聚合依赖 agents-flex-bom；Spring Boot 项目把 artifactId 换成 starter。

   
       com.agentsflex
       agents-flex-bom
       2.2.9
   

   复制

2. 2按需引入模块

   不想用聚合依赖时，可只依赖需要的模块，例如 OpenAI 对话能力和 Redis 存储。

   
       com.agentsflex
       agents-flex-chat-openai
       2.2.9
   
   
   
       com.agentsflex
       agents-flex-store-redis
       2.2.9
   

   复制

3. 3设置 API Key

   把模型服务的密钥写入环境变量，示例代码通过 System.getenv 读取，避免硬编码。

   export GITEE_API_KEY=sk-xxxxxxxx

   复制

4. 4编写对话代码

   用 OpenAIChatConfig.builder() 设置 endpoint、provider、model、apiKey，buildModel() 得到 ChatModel 后调用 chat()。

   import com.agentsflex.core.model.chat.ChatModel;
   import com.agentsflex.model.chat.openai.OpenAIChatConfig;
   
   public class ChatDemo {
       public static void main(String[] args) {
           ChatModel chatModel = OpenAIChatConfig.builder()
               .endpoint("https://ai.gitee.com")
               .provider("GiteeAI")
               .model("Qwen3-32B")
               .apiKey(System.getenv("GITEE_API_KEY"))
               .buildModel();
   
           String reply = chatModel.chat("Introduce Agents-Flex in one sentence.");
           System.out.println(reply);
       }
   }

   复制

5. 5启用流式输出

   需要边生成边打印时改用 chatStream，实现 StreamResponseListener 的 onMessage 回调。

   chatModel.chatStream("Explain the Chain of Responsibility pattern in Java.", new StreamResponseListener() {
       @Override
       public void onMessage(StreamContext context, AiMessageResponse response) {
           System.out.print(response.getMessage().getContent());
       }
   });

   复制

关键配置

如何确认成功

运行 main 方法后，控制台打印出一句话介绍 Agents-Flex 的内容，即表示模型调用成功。

常见问题

注意事项

• README 中的版本号 2.2.9 请以实际最新版本为准。
• apiKey 不要硬编码进代码，建议通过环境变量注入。
• 同一套 Prompt、Options、拦截器和上下文机制同时适用于普通对话与流式输出。