WenXin-Starter 安装和配置指南

WenXin-Starter 安装和配置指南

wenxin-starter 项目地址: https://gitcode.com/gh_mirrors/we/wenxin-starter

1. 项目基础介绍和主要编程语言

项目基础介绍

WenXin-Starter 是一个专为快速集成百度“文心千帆 WENXINWORKSHOP”大模型而设计的 Spring Boot 启动器。它提供了高性能的 Spring Boot 支持，帮助开发者快速接入百度的 AI 能力，包括连续对话（流式返回）、Prompt 模板、文生图等功能。

主要编程语言

该项目主要使用 Java 编程语言，基于 Spring Boot 框架开发。

2. 项目使用的关键技术和框架

关键技术和框架

• Spring Boot: 项目基于 Spring Boot 3.0 开发，要求 JDK 版本为 17 及以上。
• Maven: 项目使用 Maven 进行依赖管理和构建。
• 百度文心千帆 API: 项目完整对接了文心千帆的官方 API，支持文生图、内置对话记忆等功能。
• Reactor: 支持流式返回和连续对话。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. JDK 17 及以上: 确保你的开发环境已经安装了 JDK 17 或更高版本。
2. Maven 3.9 及以上: 确保你已经安装了 Maven 3.9 或更高版本。
3. IDE: 推荐使用 IntelliJ IDEA 或 Eclipse 作为开发环境。
4. 百度文心千帆 API 密钥: 你需要在百度文心千帆平台上注册并获取 API 密钥。

详细安装步骤

步骤 1: 克隆项目

首先，从 GitHub 克隆项目到本地：

git clone https://github.com/gemingjia/gear-wenxinworkshop-starter.git

步骤 2: 导入项目到 IDE

将克隆下来的项目导入到你的 IDE 中。如果你使用的是 IntelliJ IDEA，可以通过以下步骤导入：

1. 打开 IntelliJ IDEA。
2. 选择 File -> New -> Project from Existing Sources。
3. 选择你克隆的项目目录，点击 OK。
4. 选择 Import project from external model，然后选择 Maven，点击 Next。
5. 按照提示完成项目导入。

步骤 3: 配置 Maven

确保你的 Maven 配置正确。你可以在 pom.xml 文件中查看项目的依赖配置。

步骤 4: 配置 API 密钥

在项目的 application.yml 或 application.properties 文件中配置你的百度文心千帆 API 密钥：

gear:
  wenxin:
    api-key: your-api-key
    secret-key: your-secret-key

步骤 5: 运行项目

在 IDE 中运行项目。你可以通过右键点击 Application 类，然后选择 Run 来启动项目。

步骤 6: 测试 API

项目启动后，你可以通过浏览器或 Postman 等工具测试 API。例如，访问 http://localhost:8080/stream/chats?msg=你好&uid=123 来测试连续对话功能。

总结

通过以上步骤，你应该能够成功安装和配置 WenXin-Starter 项目。如果你在安装过程中遇到任何问题，可以参考项目的 GitHub 页面或联系项目维护者获取帮助。

wenxin-starter 项目地址: https://gitcode.com/gh_mirrors/we/wenxin-starter