环境要求

Go 版本不低于 1.18。

下载地址

• 源码地址：https://github.com/volcengine/volcengine-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"

配置访问凭证

初始化 SDK 客户端前，您需要配置访问凭证。

设置 API Key

执行以下命令配置 API Key 作为访问凭证，其中 YOUR_API_KEY 需要替换为您在平台上创建的 API Key。获取 API Key 访问凭证具体步骤参见签名鉴权方式。

export ARK_API_KEY=<YOUR_API_KEY>

执行以下命令验证配置信息：

echo $ARK_API_KEY

如果配置成功，则返回如下示例：

ea3b96d6-***************************

客户端初始化

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

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

设置地域和访问域名

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

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

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

设置超时/重试次数

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),
)