You need to enable JavaScript to run this app.
导航
快速入门
最近更新时间:2024.06.24 16:51:25首次发布时间:2022.07.21 16:20:22

体验中心

视觉智能体验中心
为给您带来更直观的产品体验,我们在火山引擎上架了视觉智能体验中心,其中包含各产品的体验部分,欢迎点击体验。

视觉智能体验馆
除了火山引擎视觉智能体验中心以外,我们也建设了视觉视觉智能体验馆小程序,欢迎使用微信扫码快速体验我们的产品。
alt

1 新手指南

Hi,开发者您好,欢迎使用火山引擎AI中台。以下内容,是您接入AI服务的基本介绍,在这里您可以接入使用上百项AI技术能力,感谢您的使用。

步骤1:成为开发者

请您使用火山引擎账号登陆火山引擎控制台;如还未持有火山引擎账户,点击立即注册,注册成为火山用户。

alt

alt

步骤2:进入视觉智能控制台
入口一示例

alt

入口二示例

  • 点击视觉相关产品落地页入口【管理控制台】按钮

alt

入口三示例

  • 点击控制台导航列表AI中台视觉相关产品,进入视觉智能控制台页面

alt

步骤3:实名认证与服务开通

STEP1:顶部欢迎卡片点击【去认证】,进行实名认证后再开通服务,若未完成实名认证会弹出认证弹窗

alt

alt

STEP2:完成认证后,进入视觉智能控制台,选择接入能力

alt

alt
alt
您也可以直接在页面上找到某项需要的服务,直接点击开通服务
alt

步骤4:获取AK/SK

在调用火山引擎视觉智能控制台的各个能力之前,确保您已生成访问密钥(AccessKey)。AccessKey包括AccessKeyID(AK)和AccessKeySecret(SK),其中AccessKeyID用于标识用户,AccessKeySecret是用来验证用户的密钥,请妥善保管。

获取方式:点击右上角账号,下拉列表选择【密钥管理】,点击【新建密钥】按钮,可获取AK/SK,可以此为凭证调用上述已接入应用的接口。

alt

alt

alt建议您仔细了解使用主账号密钥的风险,您也可以选择忽视此提示,选择继续创建

步骤5:启动开发

接入AI能力前,您可以选择各产品的接入文档,查看具体使用方法和参数。查看接入文档有以下两种方式:

  • 接入文档入口示例一:点击控制台中API产品【接入文档】链接,可直接跳转至对应API产品接口文档页面进行查看并调用;

alt

  • 接入文档入口示例二:官网文档中心-AI中台部分,选择对应API产品,可跳转至该API产品接口文档页面进行查看并调用;

为协助您快速调用API接口,火山引擎为用户提供快速接入服务端SDK示例,该SDK封装了网关签名与API调用。目前,SDK支持Python、Golang、PHP等常用语言,您可以选择对应语言类目下的视觉技术能力SDK进行接入。可通过进入AI中台公用文档-快速接入查看。

image.png

步骤6:正式开通服务/计费

注:如果仅是测试,可选择以免费试用的形式接入服务,无需正式开通,正式开通服务后,平台开始计费

STEP1:接入能力成功后,该API服务可开通,在视觉智能控制台对应的能力列表开通服务(接入应用的能力,会默认以免费试用的形式开通),正式开通服务后,若产生调用,平台开始计费

alt

STEP2:点击操作中的【开通服务】按钮,进入开通按量后付费页面,点击【正式调用】

alt

alt

alt
STEP3:开通服务后,可【增购】QPS和【购买】次数包/时长包
alt

alt
STEP4:开通服务后,使用已获取的 AK/SK 并结合该能力的接入文档完成接入。

如果您还有任何疑问,欢迎提交工单联系我们。

2 接入说明

Hi,开发者您好,欢迎使用火山引擎AI中台。请您按顺序依次阅读以下内容,并接入使用我们的能力。

2.1 新手指南

使用视觉智能控制台,请参考:新手指南

2.2 调用方式

通用说明

火山引擎以OpenAPI的形式对外提供服务,整体调用方式请参考:接口调用指南
其中:

  • 请求地址根据访问地区填写,国内为visual.volcengineapi.com

  • Service:人像人体、文字识别、图像技术、视频技术类取cv;自然语言处理类取nlp_gateway

  • Region根据访问地区填写,国内为cn-north-1

服务说明

服务具体说明、调用参数及返回信息,请参考接口文档页面

2.3 通用返回字段及错误码

服务有统一的返回结构及通用错误码,具体请参考:通用返回字段及错误码

2.4 快速接入

我们提供了SDK及签名示例供您实现服务快速接入,具体请参考快速接入

3 通用返回字段及错误码

整体说明

服务有统一的返回结构及通用错误码。

3.1 通用返回字段

服务会返回一个JSON结构体,具体字段说明如下:

字段类型是否必返回说明
ResponseMetadatajson网关层返回值,若此字段返回且值不为None,则无需关注其他字段
request_idString否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,代表此次请求的唯一ID
time_elapsedInt否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,整个请求所花费的时间,单位为毫秒

code

Int

否,若ResponseMetadata未返回或值为None时,必返回

服务层返回值,表示本次验证的结果状态码。
详见下方服务通用错误码和各服务接口文档中错误码部分

messageString否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,当请求失败时返回此字符串,否则此字段不存在
datajson否,若ResponseMetadata未返回或值为None时,必返回服务层返回值,json结构,里面包含的是各接口的业务数据,详细说明见各服务接口文档

ResponseMetadata字段说明

字段类型是否必返回说明
RequestIdstring网关层请求的唯一ID
Actionstring接口名
Versionstring版本号
Servicestring服务名
Regionstring地区
ErrorErrorInfo错误信息

ErrorInfo字段说明

字段类型是否必返回说明
Codestring网关层错误码,详见网关公共错误码
Messagestring网关层错误信息,详见网关公共错误码

3.2 服务通用错误码

http_codecode状态类型说明
20010000ECSuccess请求成功
40050200ECReqInvalidArgs参数错误
40050201ECReqMissingArgs缺少参数
40050204ECParseArgs参数类型错误/参数缺失
40050205ECImageSizeLimited图像尺寸超过限制
40050206ECImageEmpty请求参数中没有获取到图像
40050207ECImageDecodeError图像解码错误: 没有获取到图像或者通过image_base64参数传递图像是base64解码错误
40150400ECAuth权限校验失败
40450402ECReqMethod访问的接口不存在
42950429ECReqLimit超过调用QPS限制
50050500ECInternal服务器内部错误
50050501ECRPCInternal服务器内部RPC错误

4 快速接入

整体说明

您可通过服务端SDK来快速调用接口。

  • SDK封装了TOP网关层的签名,避免过于繁琐的自行计算;
  • SDK封装了API调用,包含请求和响应,并提供了对应的示例;

SDK

目前提供了以下几种语言的SDK,有其他语言需求请与我们沟通,我们会协助您进行接入。

Python

Golang

PHP

Java

签名示例

目前部分语言未开发SDK或SDK支持的能力不足,但可提供签名代码示例供您参考接入,具体请联系我们获取。
可提供的签名示例语言包括:Java

volc-signer-java-1.zip
20.03KB