本文为您介绍大模型应用防火墙 Java SDK 的下载地址、安装方式以及初始化配置。

前提条件 #

• 已注册火山引擎账号并完成实名认证。具体步骤，请参见账号注册及实名认证。
• 已在火山引擎控制台开通当前服务。
• 已获取账号的AccessKey、SecretKey，具体步骤，请参见获取AccessKey、SecretKey。

环境要求 #

JDK 1.7 或以上版本。执行java -version可检查当前 Java 的版本信息。

注意事项 #

从 Java 9 及更高版本开始，javax.annotation-api不再作为 JDK 的默认组件。如果您使用的是 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 依赖。

   说明

   引入依赖后，Maven 项目管理工具会自动下载相关 jar 包。

   <dependencies>
     <dependency>
       <groupId>com.volcengine</groupId>
       <artifactId>volcengine-java-sdk-waf</artifactId>
       <artifactId>volcengine-java-sdk-wafruntime</artifactId>
      <version>0.2.16</version>
     </dependency>
   </dependencies>
   

方式二 下载所有产品的 SDK #

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

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

初始化 #

配置 AK 和 SK #

在代码中设置您的 AK 和 SK，可直接使用主账号信息，或者通过用户管理创建子账号，并为子账号授予相应的权限。

方式一 在环境变量中设置

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

方式二 在代码中设置

String ak = "YOUR AK";
String sk = "YOUR SK"

配置服务接入地域 #

1. 在大模型应用防火墙控制台实例列表，查看实例所在地域。
   
2. 获取地域 ID，详情请参见 Region 列表。例如：
   • 华北 2（北京）：cn-beijing
   • 华东 2（上海）：cn-shanghai
3. 在代码中设置服务接入地域。

   String region = "cn-beijing"
   

示例代码 #

完整的初始化示例代码如下：

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 {
        // 设置认证信息
        String ak = "YOUR AK";        // Access Key，用于身份验证
        String sk = "YOUR SK";        // Secret Key，用于签名
        String region = "cn-beijing"; // 大模型应用防火墙所属地域对应的 ID

        // 创建 API 客户端
        ApiClient apiClient = new ApiClient()
                .setCredentials(Credentials.getCredentials(ak, sk))  
                .setRegion(region);  

        // 创建 WAF API 实例
        WafApi api = new WafApi(apiClient);