Java 调用阿里通义 ModelScope API

在现代应用程序开发中，使用大模型API来增强自然语言处理能力已成为一种趋势。阿里云的通义千问（ModelScope API）是一个强大的工具，允许开发者轻松地在应用中集成自然语言处理功能。本文将详细介绍如何使用Java调用阿里通义 ModelScope API，从申请API到实际代码实现，帮助开发者快速上手。

申请通义千问API的步骤

为了使用阿里通义 ModelScope API，首先需要申请API。访问阿里云官网找到通义千问并完成申请过程。

阿里云官网

申请API的过程包括：

搜索并找到“通义千问”服务。
点击“申请通义千问API”。
如果是首次申请，系统会提示开通“模型服务灵积”。点击去开通，阅读并同意相关条款。
填写申请所需的问卷信息，等待审核通过。

审核通过后，可以在模型广场找到通义千问并开始使用。

前置工作：创建并获取API-KEY

在开始编写代码之前，确保已经获取了API-KEY。API-KEY用于验证身份和调用API时的授权。

获取API-KEY

保存好API-KEY，因为在后续步骤中需要将其用作身份验证的凭证。

安装DashScope SDK

为了使用Java调用API，首先需要在项目中引入DashScope SDK。确保Java环境在Java 8及以上版本。

在maven网站查看最新SDK版本，然后在项目的pom.xml文件中添加以下依赖：


    com.alibaba
    dashscope-sdk-java
    2.1.1

注意：有时可能会遇到依赖冲突，需要通过排除冲突依赖来解决。

使用Java代码调用ModelScope API

通义千问API支持HTTP调用，以下是一个使用Java进行API调用的简单示例。

配置项目依赖


    cn.hutool
    hutool-all
    5.8.16

编写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;

@RestController
public class ChatController {
    @PostMapping("/chat")
    public ChatResponse chat(String question) {
        String url = "https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation";
        String apiKey = "your-api-key";

        ChatRequest chatRequest = new ChatRequest(question);
        String json = JSONUtil.toJsonStr(chatRequest);
        String result = HttpRequest.post(url)
                .header("Authorization", "Bearer " + apiKey)
                .header("Content-Type", "application/json")
                .body(json)
                .execute().body();

        return JSONUtil.toBean(result, ChatResponse.class);
    }
}

请求和响应的Domain类

// ChatRequest处理请求数据
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ChatRequest {
    String model;
    Input input;
    Parameters parameters;

    public ChatRequest(String question) {
        model = "qwen-v1";
        input = new Input(question);
        parameters = new Parameters();
    }

    class Input {
        public List messages;

        Input(String question) {
            ArrayList chats = new ArrayList();
            chats.add(new Chat("system", "你是达摩院的生活助手机器人。"));
            chats.add(new Chat("user", question));
            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";
    }
}

处理响应数据

// ChatResponse处理响应数据
@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;
    }
}

小结

通过以上步骤，您可以使用Java调用阿里通义 ModelScope API，将自然语言处理功能集成到您的Java应用中。无论是进行简单的对话功能实现，还是复杂的自然语言处理应用开发，通义千问API都能提供强大的支持。

FAQ

问：如何获取API-KEY？
- 答：注册并登录阿里云账号，在模型服务灵积中找到通义千问，根据指引申请API-KEY。
问：使用通义千问API需要注意哪些事项？
- 答：确保API-KEY的安全性，避免泄露；调用API时注意请求格式和参数设置。
问：如何解决Java项目中依赖冲突的问题？
- 答：可以通过在pom.xml文件中使用<exclusions>标签排除冲突的依赖项。
问：可以在项目中使用哪个HTTP库来调用API？
- 答：可以使用HttpRequest库，如Hutool等，来简化HTTP请求的编写。
问：API调用失败时应该如何处理？
- 答：通过日志记录错误信息，并根据错误提示进行排查，确保请求参数和API-KEY的正确性。