Java调用通义千问API

2,142 阅读7分钟

前置工作

申请通义千问API

首先,得找到通义千问在哪里,直接在阿里云官网主页:

然后点击搜索通义千问:

点击申请通义千问API:

我这里是第一次申请,然后系统提示需要开通模型服务灵积,点击去开通:

点击已阅读并同意: image-20230901130404382

然后好像是点击确认,系统就会提示开通成功: image-20230901130636732

回到下图的这个界面,点击我已开通,刷新页面(这步也可以在上一图直接点击前往控制台,然后在模型广场的通义千问下点击申请体验):

此时需要填一个问卷,模型名称就是通义千问,其他信息如实填写即可: image-20230901131844935

然后就是等待审核通过了: image-20230901132219762

此时,原本申请体验就变成了体验申请审核中,请耐心等待的状态了: image-20230901132434557

ps:以上内容是我第二次写了,明明typora有设置自动保存,但是电脑突然关机了,再打开,写的东西就全没了QAQ,所幸图片还在。所以上面有个地方我有点回忆不起来了,不过不是大问题。

审核通过的速度好快,我快速开始都还没看个大概就申请通过了(我刚刚在申请公众号,还有设置typora图片上传到Gitee,看了一点别人写的Java接入通义千问)。总之这个审核我这大概要等一两小时(我看别人申请文心千帆要一两天好像),审核通过后,会发短信到手机上:

image-20230901160322917

然后就按照官方文档继续整吧。

创建并获取API-KEY

根据官方文档说: image-20230901194559921

所以需要先获取API-KEY: image-20230901194821729

复制并保存创建的API-KEY: image-20230901194957612

(ps:我这现在如果没复制到API-KEY,可以通过安全验证的方式查看API-KEY)

方式一:原生接入

代码部分

通义千问支持http调用,可以参考官方给出的请求和响应实例(这里以SSE关闭、单轮问答为例):image-20230906002626571image-20230906232545616

再利用hutool来帮助代码的编写:

<!--添加hutool的依赖-->
<dependency>    
    <groupId>cn.hutool</groupId>   
    <artifactId>hutool-all</artifactId>  
    <version>5.8.16</version>
</dependency>

Controller类:

import cn.hutool.http.HttpRequest;
import cn.hutool.json.JSONUtil;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
//还需要引入下面两个domain类

@RestController
public class ChatController {
    @PostMapping("/chat")//文档要求使用post请求
    public ChatResponse chat(String q){
        String url = "https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation";//这里可以看官方文档
        String ApiKey = "sk-xxxxxxxxxx3d7fe";//这里换成自己的ApiKey

        ChatRequest chatRequest = new ChatRequest(q);//ChatRequest为自定义类
        String json = JSONUtil.toJsonStr(chatRequest);
        //System.out.println(json);//正式发送到api前,测试请求的主要数据情况
        String result = HttpRequest.post(url)
                .header("Authorization","Bearer "+ ApiKey)
                .header("Content-Type","application/json")
                .body(json)
                .execute().body();
        System.out.println(result);
        return JSONUtil.toBean(result, ChatResponse.class);//ChatResponse为自定义类
    }
}

domain类:

//这个是用来处理请求的
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.ArrayList;
import java.util.List;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ChatRequest {
    String model;
    Input input;
    Parameters parameters;

    public ChatRequest(String q){
        model  = "qwen-v1";
        input = new Input(q);
        parameters = new Parameters();
    }
    class Input {
        public List<Chat> messages;
        Input(String q){
            ArrayList<ChatRequest.Chat> chats = new ArrayList<>();
            //下一行的作用应该是为了更好的回答不同领域的问题,比如可以告诉它是它是歌曲机器人或是健康知识机器人之类的
            chats.add(new Chat("system","你是达摩院的生活助手机器人。"));
            chats.add(new Chat("user",q));
            messages = chats;
        }
    }
    class Chat {
        public String role;
        public String content;
        Chat(String role,String content){
            this.role = role;
            this.content = content;
        }
    }
    class Parameters {
        public String result_format = "text";//可根据需求更改,text格式看起来更清爽
    }
}
//这个是用来接收响应的
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ChatResponse {
    Output output;
    Usage usage;
    String request_id;
    class Output{
        public String text;
        public String finish_reason;
    }
    class Usage{
        public String output_tokens;
        public String input_tokens;
    }
}

效果:

启动项目,访问Knife4j的文档地址http://localhost:8081/api/doc.html,测试api/chat接口(这里也可以用postman、apipost、apifox、Swagger等接口测试工具): image-20230906235936032

响应数据为:

{
  "output": {
    "text": "I am a large language model created by DAMO Academy. I am called QianWen.",
    "finish_reason": "stop"
  },
  "usage": {
    "output_tokens": "20",
    "input_tokens": "30"
  },
  "request_id": "1f92c2ac-ccb9-9498-9870-55fbc04d2e9c"
}

我问中文时候就是回中文,回答的语言可能和问的语言有关吧

小结:

可以在上面代码的基础上,根据自己项目的实际情况,进行修改,上面的代码只是对数据进行了基础的处理。

但是方式一还是不够不优雅,就是项目文件夹看起来不简洁,而且也有很多我们不需要去关注的数据处理。

方式二:使用官方提供的依赖包

额外前置工作

安装DashScope SDK

除了申请API和获取API-KEY,还需要引入DashScope SDK依赖。

注意这里要求Java SDK支持java8及以上环境:

image-20230901200006774

maven网站查看DashScope Java SDK版本号,我当前查看的最新版本是2.3.0,所以我在pom.xml文件中添加以下依赖项:

<!--https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>dashscope-sdk-java</artifactId>
    <version>2.1.1</version>
</dependency>

但是,可能是我配置的镜像还没有2.3.0的版本,所以说没找到,所以我加载2.1.1的版本了。 另外,我这里应该是DashScope依赖和项目里的其他依赖冲突了,出现报错,有两份酸辣粉4斤了(bushi):

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/D:/Program%20Files/apache-maven-3.6.1/mvn_repo/ch/qos/logback/logback-classic/1.2.10/logback-classic-1.2.10.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/D:/Program%20Files/apache-maven-3.6.1/mvn_repo/org/slf4j/slf4j-simple/1.7.36/slf4j-simple-1.7.36.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]

查找冲突的包: image-20230905234709241

对依赖添加排除依赖,然后就不会报依赖包冲突的错了,如下:

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>dashscope-sdk-java</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
        </exclusion>
    </exclusions>
    <version>2.1.1</version>
</dependency>

参考博文:maven依赖包冲突如何处理 SLF4J: Class path contains multiple SLF4J bindings._debug time的博客-CSDN博客

代码部分:

这里把官方写的示例代码直接拿过来,修改些自己的参数,理论上就可以成功了,我没试过,有空可以自己试试(todo)。 因为个人觉得官方的示例看起来有麻烦,而且多轮回话的也不是很方便,所以主要介绍方式三,方式二就不继续介绍了。

方式三:使用自定义的依赖包

快速开始:

依赖地址:github.com/nmdsbzmhbky…(我的这个自定义依赖仅供参考,主要是拿来练习用的,模型支持这块做的不好,所以有需要的可以自己自定义)

1.引入Starer的maven坐标:

<dependency>
    <groupId>com.kaomao</groupId>
    <artifactId>aliyun-qianwen-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

2.在application.yml进行配置: 可以配置地址、api-key、模型、Parameters.result_format的格式

com:
  kaomao:
    # url可不写,默认就是https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation
    url: https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation
    api-key: sk-dxxxxxxxxxxxxxxxxxxxxxx7fe

3.在自己的工程里,引入客户端ChatCient的bean对象,然后进行测试单轮会话(更多详细示例在后面):

可以用@Resource注入依赖

@Resource
private ChatClient chatClient;

@Test
void contextLoads() {
    /**
     * 单轮会话
     * */
    //第一种:默认角色是达摩院的生活助手机器人。
    String response = chatClient.singleChat("你好");
    System.out.println(response);
    //第二种:可以指定角色。
    SingleChatRequest SinglechatRequest = new SingleChatRequest("你好呀","你是一个xxxx(这里写角色,上面chatClient.singleChat(q)的角色默认是达摩院的生活助手机器人。)");
    String json = JSONUtil.toJsonStr(SinglechatRequest);
    System.out.println(json);

    /**
     * 多轮会话
     * */
    //开启并进行一个新的多轮询问
    chatClient.startMultiChat("哪个公园离我最近");
    //第二次问
    chatClient.multiChat("你是谁呀");
    //第三次问
    chatClient.multiChat("第三次询问你是谁呀");
    //查看多轮询问的问答内容
    chatClient.outMultiChat();
}

补充:

todo,补充一下,不建议使用我的SDK,因为后面我发现一些细节没处理好,就是一开始没考虑到不同模型的json格式不一样,虽然大致一样,但是我还是没一开始考虑好,导致配置模型这块没正好,所以这里待改善,所以建议开始的时候就想好要做成什么,避免盲目的敲。

小结:

方式一的好处就是比较灵活,但是src/main文件下的文件数量会更多,另外在处理多轮回话的处理不方便。总之看个人需求,来考虑自己需要的方式。