You need to enable JavaScript to run this app.
导航
Java 使用示例
最近更新时间:2025.03.28 19:07:12首次发布时间:2025.03.28 19:07:12
我的收藏
有用
有用
无用
无用

本文为您介绍大模型应用防火墙 Java SDK 的下载地址、安装方式以及代码示例,帮助您快速了解如何使用 SDK 调用 OpenAPI。

前提条件

环境要求

  • 运行 SDK 需要 jdk Java 1.7+,您可以下载最新版本。
  • 由于高于或者等于 Java 9 版本的 SDK 中javax.annotation-api被移除,若您的 SDK 版本高于或者等于Java 9,需要添加以下依赖:
    <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.3.2</version>
    </dependency>
    

步骤一 下载 SDK

方式一 下载当前产品的 SDK

  1. 新建新建一个 Maven 项目。

  2. 在项目目录下的pom.xml中,添加如下设置,引入当前产品的 SDK 依赖。

    <dependencies>
      <dependency>
        <groupId>com.volcengine</groupId>
        <artifactId>volcengine-java-sdk-waf</artifactId>
       <version>0.1.154</version>
      </dependency>
    </dependencies>
    
  3. 引入依赖后,Maven 项目管理工具会自动下载相关 jar 包。

方式二 下载所有产品的 SDK

如果您需要引入火山引擎已支持的全部云产品 SDK,可以通过 bom 方式引入。如下文所示,引入volcengine-java-sdk-bom后,即可引入所有支持的服务。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.volcengine</groupId>
            <artifactId>volcengine-java-sdk-bom</artifactId>
            <version>0.1.154</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

步骤二 访问授权

通过环境变量导入:

export VOLCENGINE_ACCESS_KEY=your ak
export VOLCENGINE_SECRET_KEY=your sk
#如果使用token
export VOLCENGINE_SESSION_TOKEN=token

步骤三 调用接口

以下提供调用CheckLLMPrompt判别大模型提示词是否合规的示例代码,实际使用时,您可以替换成 SDK 中已经支持的任意接口。CheckLLMPrompt相关参数的详细说明,可参考CheckLLMPrompt - 判别大模型提示词是否合规

package com.volcengine.sdk.example;

import com.volcengine.ApiClient;
import com.volcengine.ApiException;
import com.volcengine.sign.Credentials;
import com.volcengine.waf.WafApi;
import com.volcengine.waf.model.CheckLLMPromptRequest;
import com.volcengine.waf.model.CheckLLMPromptResponse;

public class TestCheckLLMPrompt {
    public static void main(String[] args) throws Exception {
        // 注意示例代码安全,代码泄漏会导致AK/SK泄漏,有极大的安全风险。
        String ak = "YOUR AK";
        String sk = "YOUR SK";
        String region = "cn-beijing";

        ApiClient apiClient = new ApiClient()
                .setCredentials(Credentials.getCredentials(ak, sk))
                .setRegion(region);

        WafApi api = new WafApi(apiClient);
        
        CheckLLMPromptRequest checkLLMPromptRequest = new CheckLLMPromptRequest();
        checkLLMPromptRequest.setContent("请输入您想要校验的内容,文本内容或资源URL");
        checkLLMPromptRequest.setContentType(1);
        checkLLMPromptRequest.setHost("example.com");
        checkLLMPromptRequest.setMsgClass(0);
        checkLLMPromptRequest.setRegion("cn-beijing");
        
        try {
            // 复制代码运行示例,请自行打印API返回值。
            CheckLLMPromptResponse data = api.checkLLMPrompt(checkLLMPromptRequest);
            System.out.println(data.toString()); 

        } catch (ApiException e) {
            // 复制代码运行示例,请自行打印API错误信息。
            System.out.println(e.getResponseBody());
        }
    }
}