星火大模型AI接口Spring中项目中使用【星火、AIGC】

2023-10-07 02:44

本文主要是介绍星火大模型AI接口Spring中项目中使用【星火、AIGC】,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

星火大模型AI接口使用

讯飞的星火大模型是有免费版本赠送200万个Token,就个人学习来说完全够用了。

请添加图片描述

免费申请过后,到控制台,两个红色方框是最要紧的。

请添加图片描述

星火认知大模型Web文档 | 讯飞开放平台文档中心 (xfyun.cn)这是官方文档对于接口的详细使用,里面有对各种请求的详细描述。接下来我们将在Spring项目中使用星火的AIGC能力。

首先是星火给的APPID、APISecret、APIKey是连接到大模型的关键,通过这三个参数按照通用鉴权URL生成说明 | 讯飞开放平台文档中心 (xfyun.cn)生成通用鉴权URL就可以就行html请求,发送请求参数,接受返回信息。

https://xfyun-doc.cn-bj.ufileos.com/static%2F16933832521697972%2Fbig_model.zip 这是官方给出的Java例子。

通用鉴权URL的生成

官方给的,直接拿来用。

/ 获得鉴权地址public static String getAuthUrl(String hostUrl, String apiSecret, String apiKey) throws Exception {URL url = new URL(hostUrl);// 时间SimpleDateFormat format = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);format.setTimeZone(TimeZone.getTimeZone("GMT"));String date = format.format(new Date());// 拼接String preStr = "host: " + url.getHost() + "\n" +"date: " + date + "\n" +"GET " + url.getPath() + " HTTP/1.1";// System.err.println(preStr);// SHA256加密Mac mac = Mac.getInstance("hmacsha256");SecretKeySpec spec = new SecretKeySpec(apiSecret.getBytes(StandardCharsets.UTF_8), "hmacsha256");mac.init(spec);byte[] hexDigits = mac.doFinal(preStr.getBytes(StandardCharsets.UTF_8));// Base64加密String sha = Base64.getEncoder().encodeToString(hexDigits);// System.err.println(sha);// 拼接String authorization = String.format("api_key=\"%s\", algorithm=\"%s\", headers=\"%s\", signature=\"%s\"", apiKey, "hmac-sha256", "host date request-line", sha);// 拼接地址HttpUrl httpUrl = Objects.requireNonNull(HttpUrl.parse("https://" + url.getHost() + url.getPath())).newBuilder().//addQueryParameter("authorization", Base64.getEncoder().encodeToString(authorization.getBytes(StandardCharsets.UTF_8))).//addQueryParameter("date", date).//addQueryParameter("host", url.getHost()).//build();// System.err.println(httpUrl.toString());return httpUrl.toString();}

项目中实现

在项目中使用我们需要一个Config进行全局配置,一个WebListener发送接受请求,还有与星火交互的DTO。

请添加图片描述

1. XfunConfig
/***   星火大模型AI接口配置*/
@Configuration
@Data
@ConfigurationProperties(prefix = "xfun.open")
public class XfunConfig {private String appid;private String apiSecret;private String hostUrl;private String apiKey;
}

在application.yml中的配置

#星火
xfun:open:appid: XXXXXXXXXXXXXXXXXXXXXXXapiSecret: XXXXXXXXXXXXXXXXXXXXXXXhostUrl: https://spark-api.xf-yun.com/v2.1/chatapiKey: XXXXXXXXXXXXXXXXXXXXXXX
3. DTO – Xfun

看官方文档中对请求参数以及对各个字段的解释。

# 参数构造示例如下
{"header": {"app_id": "12345","uid": "12345"},"parameter": {"chat": {"domain": "general","temperature": 0.5,"max_tokens": 1024, }},"payload": {"message": {# 如果想获取结合上下文的回答,需要开发者每次将历史问答信息一起传给服务端,如下示例# 注意:text里面的所有content内容加一起的tokens需要控制在8192以内,开发者如有较长对话需求,需要适当裁剪历史信息"text": [{"role": "user", "content": "你是谁"} # 用户的历史问题{"role": "assistant", "content": "....."}  # AI的历史回答结果# ....... 省略的历史对话{"role": "user", "content": "你会做什么"}  # 最新的一条问题,如无需上下文,可只传最新一条问题]}}
}

请添加图片描述

其中Message单独为一个类

/*** 消息对象**/
@Data
public class MsgDTO {/*** 角色*/private String role;/*** 消息内容*/private String content;private Integer index;@Getterpublic static enum Role {SYSTEM("system"),USER("user"),ASSISTANT("assistant");private String name;private Role(String name) {this.name = name;}}}

这样一个请求构成的数据对象类如下:

@Data
public class XfunSendRequest {@JsonProperty("header")private Header header;@JsonProperty("parameter")private ParameterDTO parameterDTO;@JsonProperty("payload")private PayloadDTO payload;@Datapublic static class Header{@JSONField(name = "app_id")private String appId;@JSONField(name = "uid")private String uid;}@ Datapublic static class ParameterDTO{@JsonProperty("chat")private ChatDTO chat;@Datapublic static class ChatDTO {@JsonProperty("domain")private String domain = "generalv2";@JsonProperty("temperature")private Double temperature = 0.5;@JSONField(name = "max_tokens")private Integer maxTokens = 2048;}}@Datapublic static class PayloadDTO {@JsonProperty("message")private MessageDTO message;@Datapublic static class MessageDTO {@JsonProperty("text")private List<MsgDTO> text;}}}

接下来是构造接口响应对象:

# 接口为流式返回,此示例为最后一次返回结果,开发者需要将接口多次返回的结果进行拼接展示
{"header":{"code":0,"message":"Success","sid":"cht000cb087@dx18793cd421fb894542","status":2},"payload":{"choices":{"status":2,"seq":0,"text":[{"content":"我可以帮助你的吗?","role":"assistant","index":0}]},"usage":{"text":{"question_tokens":4,"prompt_tokens":5,"completion_tokens":9,"total_tokens":14}}}
}

请添加图片描述

由官方描述可见,其中 payload.choice.text中的内容就是构造的MsgDto, 根据官方文档给出的接口响应构造XfunReceieveRequest;

@Data
public class XfunReceieveRequest {@JsonProperty("header")private HeaderDTO header;@JsonProperty("payload")private PayloadDTO payload;@NoArgsConstructor@Datapublic static class HeaderDTO {@JsonProperty("code")private Integer code;@JsonProperty("message")private String message;@JsonProperty("sid")private String sid;@JsonProperty("status")private Integer status;}@NoArgsConstructor@Datapublic static class PayloadDTO {@JsonProperty("choices")private ChoicesDTO choices;@JsonProperty("usage")private UsageDTO usage;@NoArgsConstructor@Datapublic static class ChoicesDTO {@JsonProperty("status")private Integer status;@JsonProperty("seq")private Integer seq;@JsonProperty("text")private List<MsgDTO> text;}@NoArgsConstructor@Datapublic static class UsageDTO {@JsonProperty("text")private TextDTO text;@NoArgsConstructor@Datapublic static class TextDTO {@JsonProperty("question_tokens")private Integer questionTokens;@JsonProperty("prompt_tokens")private Integer promptTokens;@JsonProperty("completion_tokens")private Integer completionTokens;@JsonProperty("total_tokens")private Integer totalTokens;}}}}

这样发送和接受请求都构造完成可以尝试与星火进行交互。

使用WebSocket将XfunSendRequest发出即可;以下是XfunListener中发送消息代码:

    public XfunListener sendMsg(String uid, List<MsgDTO> msgs, XfunListener webSocketListener) throws Exception {// 获取鉴权urlString url = getAuthUrl(hostUrl,apiSecret,apiKey);//建立请求OkHttpClient okHttpClient = new OkHttpClient.Builder().build();Request request = new Request.Builder().url(url).build();WebSocket webSocket = okHttpClient.newWebSocket(request, webSocketListener);XfunSendRequest xfunSendRequest = this.getSendRequest(uid, msgs);System.out.println("params:" + JSONObject.toJSONString(xfunSendRequest));//发送消息webSocket.send(JSONObject.toJSONString(xfunSendRequest));return webSocketListener;}

可以看到整个发送消息的过程:

  1. 建立请求,根据请求创建WebSoeckt
  2. 利用WebSocket发出XfunSendRequest

接受消息写在XfunListener的OnMessage重载函数中,根据XfunReceiveRequest来处理数据;

3. XfunListener

具体代码如下:

最关键的就是两个函数:

  • OnMessage: 接受消息,处理消息
  • SendMsg: 发送消息
@Builder
public class XfunListener extends WebSocketListener {private String hostUrl;private String appid;private String apiSecret;private String apiKey;@Builder.Defaultpublic boolean is_finished = false;@Builder.Defaultprivate String answer = "";public String getAnswer() {return answer;}public boolean isFinished() {return is_finished;}public List<MsgDTO> getHistoryList() {return historyList;}@Builder.Defaultpublic List<MsgDTO> historyList = new ArrayList<>();@Overridepublic void onOpen(@NotNull WebSocket webSocket, @NotNull Response response) {super.onOpen(webSocket, response);}public  void deleteHistory(){historyList = new ArrayList<>();}public void init_chat(){is_finished = false;}// 接收到消息如何处理@Overridepublic void onMessage(@NotNull WebSocket webSocket, @NotNull String text) {super.onMessage(webSocket, text);// System.out.println("接收到消息:" + text);// 消息格式处理XfunReceieveRequest xfunReceieveRequest = JSONObject.parseObject(text, XfunReceieveRequest.class);//状态判断if(xfunReceieveRequest.getHeader().getCode() == 0) {// 0的话 ,获取状态成功XfunReceieveRequest.PayloadDTO payload = xfunReceieveRequest.getPayload();XfunReceieveRequest.PayloadDTO.ChoicesDTO choices = payload.getChoices();//处理得到的答案List<MsgDTO> msgs = choices.getText();//打上indexfor(int i = 0; i < msgs.size(); i++){MsgDTO msg =msgs.get(i);msg.setIndex(historyList.size()+i);historyList.add(msg);}if(xfunReceieveRequest.getHeader().getStatus() == 2){//表示会话来到最后一个结果XfunReceieveRequest.PayloadDTO.UsageDTO.TextDTO text1 = payload.getUsage().getText();System.out.println("PromptTokecn:" + text1.getPromptTokens());System.out.println("QuestionToken:" + text1.getQuestionTokens());System.out.println("CompletionToken:" + text1.getCompletionTokens());System.out.println("TotalToken"+text1.getTotalTokens());is_finished = true;// 消息整合StringBuilder message = new StringBuilder();for(MsgDTO msg: historyList){message.append(msg.getContent());}deleteHistory();answer = message.toString();//断开连接// webSocket.close(3,"客户端断开连接");}}}// 获得鉴权地址public static String getAuthUrl(String hostUrl, String apiSecret, String apiKey) throws Exception {URL url = new URL(hostUrl);// 时间SimpleDateFormat format = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);format.setTimeZone(TimeZone.getTimeZone("GMT"));String date = format.format(new Date());// 拼接String preStr = "host: " + url.getHost() + "\n" +"date: " + date + "\n" +"GET " + url.getPath() + " HTTP/1.1";// System.err.println(preStr);// SHA256加密Mac mac = Mac.getInstance("hmacsha256");SecretKeySpec spec = new SecretKeySpec(apiSecret.getBytes(StandardCharsets.UTF_8), "hmacsha256");mac.init(spec);byte[] hexDigits = mac.doFinal(preStr.getBytes(StandardCharsets.UTF_8));// Base64加密String sha = Base64.getEncoder().encodeToString(hexDigits);// System.err.println(sha);// 拼接String authorization = String.format("api_key=\"%s\", algorithm=\"%s\", headers=\"%s\", signature=\"%s\"", apiKey, "hmac-sha256", "host date request-line", sha);// 拼接地址HttpUrl httpUrl = Objects.requireNonNull(HttpUrl.parse("https://" + url.getHost() + url.getPath())).newBuilder().//addQueryParameter("authorization", Base64.getEncoder().encodeToString(authorization.getBytes(StandardCharsets.UTF_8))).//addQueryParameter("date", date).//addQueryParameter("host", url.getHost()).//build();// System.err.println(httpUrl.toString());return httpUrl.toString();}// msgs和uid 转成 XfunSendRequestpublic XfunSendRequest getSendRequest(String uid, List<MsgDTO> msgs) {XfunSendRequest xfunSendRequest = new XfunSendRequest();XfunSendRequest.Header header = new XfunSendRequest.Header();header.setAppId(appid);header.setUid(uid);xfunSendRequest.setHeader(header);XfunSendRequest.ParameterDTO parameterDTO = new XfunSendRequest.ParameterDTO();XfunSendRequest.ParameterDTO.ChatDTO chatDTO = new XfunSendRequest.ParameterDTO.ChatDTO();parameterDTO.setChat(chatDTO);xfunSendRequest.setParameterDTO(parameterDTO);XfunSendRequest.PayloadDTO payloadDTO = new XfunSendRequest.PayloadDTO();XfunSendRequest.PayloadDTO.MessageDTO messageDTO = new XfunSendRequest.PayloadDTO.MessageDTO();messageDTO.setText(msgs);payloadDTO.setMessage(messageDTO);xfunSendRequest.setPayload(payloadDTO);return xfunSendRequest;}/***  发送信息*/public XfunListener sendMsg(String uid, List<MsgDTO> msgs, XfunListener webSocketListener) throws Exception {// 获取鉴权urlString url = getAuthUrl(hostUrl,apiSecret,apiKey);//建立请求OkHttpClient okHttpClient = new OkHttpClient.Builder().build();Request request = new Request.Builder().url(url).build();WebSocket webSocket = okHttpClient.newWebSocket(request, webSocketListener);XfunSendRequest xfunSendRequest = this.getSendRequest(uid, msgs);System.out.println("params:" + JSONObject.toJSONString(xfunSendRequest));//发送消息webSocket.send(JSONObject.toJSONString(xfunSendRequest));return webSocketListener;}
}

可以看到这个XfunListener不是一个Bean,所以在MainApplication中创建了这个Bean。

@SpringBootApplication(exclude = {RedisAutoConfiguration.class})
@MapperScan("com.yupi.springbootinit.mapper")
@EnableScheduling
@EnableAspectJAutoProxy(proxyTargetClass = true, exposeProxy = true)
public class MainApplication {@Autowiredprivate XfunConfig xfunConfig;public static void main(String[] args) {SpringApplication.run(MainApplication.class, args);}@Beanpublic XfunListener getXfunListener() {return XfunListener.builder().apiKey(xfunConfig.getApiKey()).apiSecret(xfunConfig.getApiSecret()).hostUrl(xfunConfig.getHostUrl()).appid(xfunConfig.getAppid()).build();}
}

这样整个星火的AIGC就设计完成,可以随意复用在任意的项目之中,利用XfunListener即可发送消息或获取消息。

详细的数据处理,发送消息,另外写一个AI的Service做具体的处理即可。例如以下一个简单的实例:

@Service
public class AiManager {@Resourceprivate XfunListener xfunListener;  // 实现发送接受消息的websockectpublic String testChat(String question){//8位随机数String random = String.valueOf((int)((Math.random()*9+1)*10000000));List<MsgDTO> msgs = new ArrayList<>();MsgDTO msgDTO = new MsgDTO( );msgDTO.setRole("user");msgDTO.setContent(question);msgDTO.setIndex(0);msgs.add(msgDTO);xfunListener.init_chat();try {// 获取接受消息的webSoecktXfunListener webSocket = xfunListener.sendMsg(random, msgs, xfunListener);//等待weSocked返回消息 , 这是一个笨笨的处理方法。int cnt = 30;//最长等待30Swhile (!webSocket.isFinished() && cnt > 0){Thread.sleep(1000);  //休息1Scnt--;}if(cnt == 0){return null;}String answer = webSocket.getAnswer();//返回答案return answer;} catch (Exception e) {throw new RuntimeException(e);}}public static void main(String[] args) {AiManager ai = new AiManager();ai.xfunListener =  XfunListener.builder().apiKey("xxxxxxx").apiSecret("xxxxxxx").appid("xxxxxxx").hostUrl("https://spark-api.xf-yun.com/v2.1/chat").build();System.out.println(ai.testChat("你好啊!"));}}

AiManager运行结果

请添加图片描述

这篇关于星火大模型AI接口Spring中项目中使用【星火、AIGC】的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/155533

相关文章

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定

Linux使用nload监控网络流量的方法

《Linux使用nload监控网络流量的方法》Linux中的nload命令是一个用于实时监控网络流量的工具,它提供了传入和传出流量的可视化表示,帮助用户一目了然地了解网络活动,本文给大家介绍了Linu... 目录简介安装示例用法基础用法指定网络接口限制显示特定流量类型指定刷新率设置流量速率的显示单位监控多个

部署Vue项目到服务器后404错误的原因及解决方案

《部署Vue项目到服务器后404错误的原因及解决方案》文章介绍了Vue项目部署步骤以及404错误的解决方案,部署步骤包括构建项目、上传文件、配置Web服务器、重启Nginx和访问域名,404错误通常是... 目录一、vue项目部署步骤二、404错误原因及解决方案错误场景原因分析解决方案一、Vue项目部署步骤

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

Spring AI集成DeepSeek的详细步骤

《SpringAI集成DeepSeek的详细步骤》DeepSeek作为一款卓越的国产AI模型,越来越多的公司考虑在自己的应用中集成,对于Java应用来说,我们可以借助SpringAI集成DeepSe... 目录DeepSeek 介绍Spring AI 是什么?1、环境准备2、构建项目2.1、pom依赖2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本