Easy AI Framework Starter

Java Version Spring Boot License Version

🚀 企业级AI模型统一接入框架

一个功能强大的Spring Boot Starter,为企业提供统一的AI模型API接入方案

快速开始 • 配置指南 • API文档 • 扩展开发

✨ 功能特性

🎯 核心功能

🛠️ 技术特性

🎯 支持的AI提供商

🚀 快速开始

📦 1. 添加依赖

<dependency>
 <groupId>com.chow.easy</groupId>
 <artifactId>easy-ai-framework-starter</artifactId>
 <version>1.0.0.RELEASE</version>
</dependency>

⚙️ 2. 配置文件

bcl:
 ai-framework:
 # 是否启用框架(默认true)
 enabled: true
 
 # 默认使用的提供商
 default-provider: openai
 
 # 全局超时配置(毫秒)
 timeout: 30000
 read-timeout: 300000
 
 # 多提供商配置
 providers:
 # OpenAI配置
 openai:
 api-key: sk-your-openai-api-key
 api-url: https://api.openai.com/v1 # 可选
 default-model: gpt-3.5-turbo
 parameters:
 temperature: 0.7
 max_tokens: 2000
 
 # DeepSeek配置 
 deepseek:
 api-key: sk-your-deepseek-api-key
 default-model: deepseek-chat
 parameters:
 temperature: 1.0
 max_tokens: 4096
 
 # SiliconFlow配置
 siliconflow:
 api-key: sk-your-siliconflow-api-key
 default-model: Qwen/Qwen2.5-7B-Instruct
 parameters:
 temperature: 0.7
 max_tokens: 4096

💻 3. 代码使用

基础用法

@RestController
public class ChatController {
 
 @Autowired
 private AiServiceFactory serviceFactory;
 
 // 或者使用工具类
 @Autowired
 private AiServiceUtil aiServiceUtil;
 
 @PostMapping("/chat")
 public String chat(@RequestParam String message) {
 // 使用默认提供商
 return aiServiceUtil.chat(message);
 
 // 或者指定提供商
 // return aiServiceUtil.chat("openai", message);
 }
}

高级用法

@Service
public class AiService {
 
 @Autowired
 private AiServiceFactory serviceFactory;
 
 public void demonstrateAdvancedUsage() {
 // 获取特定提供商的服务
 AiService openaiService = serviceFactory.getService("openai");
 
 // 1. 简单对话
 String response = openaiService.chat("你好,请介绍一下你自己");
 
 // 2. 多轮对话
 List<AiMessage> messages = Arrays.asList(
 new AiMessage("user", "我正在学习Java编程"),
 new AiMessage("assistant", "很好!Java是一门强大的编程语言。"),
 new AiMessage("user", "能给我一个简单的例子吗?")
 );
 String multiResponse = openaiService.chat(messages);
 
 // 3. 流式对话
 openaiService.chatStream("请解释什么是机器学习", content -> {
 System.out.print(content); // 实时输出
 });
 
 // 4. 检查服务状态
 boolean available = openaiService.isAvailable();
 
 // 5. 获取支持的模型
 List<String> models = serviceFactory.getSupportedModels("openai");
 }
}

📋 配置指南

🔧 主要配置项

🏢 提供商配置

🎛️ 常用参数配置

parameters:
 temperature: 0.7 # 创造性控制 (0.0-2.0)
 max_tokens: 2000 # 最大输出长度
 top_p: 1.0 # 核心采样参数
 frequency_penalty: 0.0 # 频率惩罚
 presence_penalty: 0.0 # 存在惩罚
 stop: ["Human:", "AI:"] # 停止词列表

📚 API接口

🏭 AiServiceFactory

public interface AiServiceFactory {
 // 获取默认AI服务
 AiService getDefaultService();
 
 // 获取指定提供商的AI服务
 AiService getService(String providerName);
 
 // 检查提供商是否已配置
 boolean isProviderConfigured(String providerName);
 
 // 获取已配置的提供商
 Set<String> getConfiguredProviders();
 
 // 获取可用的SPI提供商
 Set<String> getAvailableSpiProviders();
 
 // 获取支持的模型列表
 List<String> getSupportedModels(String providerName);
 
 // 缓存管理
 void clearCache();
 void clearCache(String providerName);
}

🤖 AiService

public interface AiService {
 // 简单对话
 String chat(String prompt);
 
 // 多轮对话
 String chat(List<AiMessage> messages);
 
 // 流式对话
 void chatStream(String prompt, Consumer<String> callback);
 void chatStream(List<AiMessage> messages, Consumer<String> callback);
 
 // 获取提供商名称
 String getProviderName();
 
 // 检查服务可用性
 boolean isAvailable();
}

🛠️ AiServiceUtil

public class AiServiceUtil {
 // 使用默认提供商对话
 String chat(String prompt);
 
 // 使用指定提供商对话
 String chat(String providerName, String prompt);
 String chat(String providerName, List<AiMessage> messages);
 
 // 流式对话
 void chatStream(String prompt, Consumer<String> callback);
 void chatStream(String providerName, String prompt, Consumer<String> callback);
}

🔌 扩展开发

📝 实现自定义提供商

1️⃣ 实现 AiServiceProvider 接口

public class CustomAiServiceProvider implements AiServiceProvider {
 
 @Override
 public String getProviderName() {
 return "custom-ai";
 }
 
 @Override
 public boolean supports(String providerName) {
 return "custom-ai".equalsIgnoreCase(providerName);
 }
 
 @Override
 public AiService createAiService(
 BclAiFrameworkProperties.ProviderConfig config, 
 int timeout, 
 int readTimeout) {
 return new CustomAiService(config, timeout, readTimeout);
 }
 
 @Override
 public int getPriority() {
 return 50; // 优先级,数值越小越高
 }
 
 @Override
 public String getDescription() {
 return "Custom AI Provider - 自定义AI服务提供商";
 }
 
 @Override
 public List<String> getSupportedModels() {
 return Arrays.asList("custom-model-v1", "custom-model-v2");
 }
}

2️⃣ 实现 AiService 接口

public class CustomAiService extends BaseAiServiceImpl {
 
 public CustomAiService(BclAiFrameworkProperties.ProviderConfig config, 
 int timeout, int readTimeout) {
 super(config, timeout, readTimeout);
 }
 
 @Override
 public String getProviderName() {
 return "custom-ai";
 }
 
 @Override
 protected Map<String, Object> buildRequestBody(List<AiMessage> messages, boolean stream) {
 // 构建请求体
 return requestBody;
 }
 
 @Override
 protected String parseResponse(String responseBody) {
 // 解析响应
 return parsedContent;
 }
 
 @Override
 protected void parseStreamResponse(String line, Consumer<String> callback) {
 // 解析流式响应
 callback.accept(content);
 }
 
 @Override
 protected String getApiEndpoint() {
 return config.getApiUrl() + "/chat/completions";
 }
}

3️⃣ 注册SPI服务

com.example.provider.CustomAiServiceProvider

4️⃣ 配置使用

bcl:
 ai-framework:
 providers:
 custom-ai:
 api-key: your-custom-api-key
 api-url: https://api.custom-ai.com
 default-model: custom-model-v1

🎯 提供商使用指南

🔧 最佳实践

💡 性能优化

# 生产环境推荐配置
bcl:
 ai-framework:
 timeout: 60000 # 适当增加超时
 read-timeout: 180000 # 流式响应超时
 providers:
 openai:
 parameters:
 temperature: 0.3 # 降低随机性
 max_tokens: 1000 # 控制输出长度

🔒 安全配置

# 使用环境变量保护API密钥
bcl:
 ai-framework:
 providers:
 openai:
 api-key: ${OPENAI_API_KEY}
 deepseek:
 api-key: ${DEEPSEEK_API_KEY}

📊 监控调试

# 启用详细日志
logging:
 level:
 com.chow.easy.ai.framework: DEBUG

🚨 常见问题

Q: 启动时提示"Provider not configured"?

Q: 如何切换不同的提供商?

Q: 支持代理访问吗?

Q: 如何获取错误详情?

🗺️ 开发路线图

✅ 已完成

🚧 开发中

🔮 计划中

🤝 贡献指南

📄 许可证

🙏 致谢

🌟 如果这个项目对您有帮助,请给我们一个Star! 🌟

⬆ 回到顶部