You need to enable JavaScript to run this app.
导航
Go SDK 安装与初始化
最近更新时间:2025.03.21 20:59:42首次发布时间:2024.08.12 12:43:50
我的收藏
有用
有用
无用
无用

环境要求

Go 版本不低于 1.18。

下载地址

安装 Go SDK

火山方舟 Go SDK 使用 go mod 进行管理,如果本地工程没有初始化 go mod,您可以运行以下命令初始化 go mod。

go mod init example

在本地初始化 go mod 后,运行以下命令安装最新版 SDK。

go get -u github.com/volcengine/volcengine-go-sdk

在代码中引入 SDK 使用。

import "github.com/volcengine/volcengine-go-sdk/service/arkruntime"

更新依赖后,使用以下命令清理不需要的依赖并整理 go.modgo.sum文件。

go mod tidy

获取并设置 API Key

详细请参见1.获取并配置 API Key

客户端初始化
import (
    "os"
    "github.com/volcengine/volcengine-go-sdk/service/arkruntime"
)

client := arkruntime.NewClientWithApiKey(
    os.Getenv("ARK_API_KEY"),
)

设置地域和访问域名

代码示例中 <ARK_BASE_URL> 处填写火山方舟推理接入点/应用资源所在区域对应的访问域名,如不填默认访问华北 2 (北京)。火山方舟支持的地域和访问域名参见地域和访问域名

import (
    "os"
    "github.com/volcengine/volcengine-go-sdk/service/arkruntime"
)
// 以华北 2 (北京) 为例,<ARK_BASE_URL> 处应改为 https://ark.cn-beijing.volces.com/api/v3
client := arkruntime.NewClientWithApiKey(
    os.Getenv("ARK_API_KEY"),
    arkruntime.WithBaseUrl("<ARK_BASE_URL>"),
)

设置超时/重试次数

import (
    "os"
    "time"
    "github.com/volcengine/volcengine-go-sdk/service/arkruntime"
)

client := arkruntime.NewClientWithApiKey(
    os.Getenv("ARK_API_KEY"),
    arkruntime.WithTimeout(2*time.Minute),
    arkruntime.WithRetryTimes(2),
)

使用Access Key鉴权

  1. 获取到Access Key。如需创建/查看Access Key,请参见API访问密钥管理
  2. 设置API密钥到环境变量,推荐命名为:VOLC_ACCESSKEYVOLC_SECRETKEY

环境变量配置方法类似API Key配置环境变量,具体请参见 配置 API Key 到环境变量

  1. 按照下面示例代码进行初始化。
import (
    "os"
    "time"
    "github.com/volcengine/volcengine-go-sdk/service/arkruntime"
)

client := arkruntime.NewClientWithAkSk(
        os.Getenv("VOLC_ACCESSKEY"),
        os.Getenv("VOLC_SECRETKEY"),
)

说明

因Access Key 鉴权原理是使用Access Key调用接口(GetApiKey - 获取临时API Key)来获取临时API Key,而该接口QPS较低。此时请使用单例模式调用模型服务,勿多次创建实例避免触发接口限流。