跳转到内容
Foldbun Stack文档
EN获取 API 密钥即将推出

根据提示分割对象

POST
/v1/segment
curl --request POST \
--url https://api.stack.foldbun.com/v1/segment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "model": "sam3", "image": { "id": "img_3b1f0c5e9a7d42c8b6e1f0a9d8c7b6a5f4e3d2c1b0a998877665544332211000" }, "prompts": [ { "text": "dog" } ], "options": { "defaults": { "filter": { "minScore": 0.5 } } } }'

sam3 接受文本提示、样例框(“查找更多类似项”)和点提示,可在同一请求中单独使用或混合使用。按解码次数计费:每个文本提示计费一次(prompt);样例框不另外收费(样例框附加到每个文本提示上),只含样例框而无文本提示的请求按一个提示计费。点提示按每个 point 计费,图片编码计费一次(encode_image,缓存命中时减免)。点提示只选定一个对象(该单个正向点对应的最佳蒙版),并且始终产生一个实例。样例框只作用于文本提示,不作用于点。仅含点提示的请求有效。sam-lite 只接受框和点;每个提示产生一个实例,按每个 box 或 point 计费,另加其自身的 encode_image。价格见 GET /v1/models。 后处理免费,按提示配置(options.defaults、prompts[].options):提示类型与合并见 SegmentRequest,处理顺序与限制见 SegmentOptions。默认情况下,每个实例带有一个含洞的简化多边形,不带蒙版。 调用在运行前预留全部价格(编码费加各提示费用),并按工作进程上报的用量结算。

Idempotency-Key
string
至少 1 个字符 至多 128 个字符 /^[\x21-\x7e]+$/

1 至 128 个可打印 ASCII 字符。在同一账户内,密钥保留 24 小时:使用相同请求体重复请求,会返回原始响应(响应头 Idempotent-Replayed: true),且不会再次扣费或运行。相同密钥搭配不同请求体返回 409 idempotency_conflict。见概览。

分割所用的模型、图片和提示。

媒体类型application/json

分割请求。提示分为搜索类提示(找出任意数量的对象)和对象提示(恰好返回一个对象):

提示 类型 filter cleanup、几何 nms merge maxInstances
sam3 文本 搜索 是 是 是 是 计入
没有文本提示时的 sam3 样例框(一次搜索,label 为 _exemplar) 搜索 是 是 是 是 计入
sam3 点、sam-lite 框和点 对象 400 是 从不 是 不计入,始终返回

与文本提示同用的样例框作用于每个文本提示,不接受 group 或 options(400 invalid_request)。没有文本提示时,样例框搜索使用第一个正向框的 group 和 options,其他框不接受这两项;其实例的 prompt 为该框的索引。

合并。 提示设置了 merge: true 的实例按 group 合并为一个实例:取其蒙版的并集,score 取最高值,prompt 取最小值(使用该提示的 label 和输出选项),bbox 和 area 为并集的值,merged 为合并的实例数。组内只有一个这样的实例时原样返回。包含对象提示实例的合并实例始终返回;否则计入 maxInstances。

object
model
必填

模型:sam3(文本、样例框、点)或 sam-lite(框、点)。

string
允许的值: sam3 sam-lite
image
必填

待分割的图片。

object
至少 1 个属性 至多 1 个属性
id

POST /v1/images(或之前的调用)返回的句柄:img_ 加清理后图片的 SHA-256。仅在上传它的账户内有效。

string
/^img_[0-9a-f]{64}$/
url

预留(后续提供)。目前返回 400 unsupported。

string format: uri
/^https:///
base64

JPEG、PNG 或 WebP 文件的标准 base64;允许带 data: 前缀。

string
prompts
必填

sam3:{"text": "..."}(1 至 200 个字符)、{"box": [...], "positive": true} 样例框(最多 10 个框;正向框表示“查找更多类似项”;允许仅含框的请求)以及 {"point": {"x","y"}} 点提示。点提示对应一个对象:恰好产生一个实例(该正向点对应的最佳蒙版),始终返回。样例框只作用于文本提示,不作用于点。点提示可与其他类型混合使用,也可单独使用。 sam-lite:{"box": [...]} 或 {"point": {"x","y"}};每个提示产生一个实例。 每个请求最多 50 个提示(各类型合计)。 每个提示只能包含 text、box 和 point 中的一个。请求至少需要一个文本提示、正向样例框或点;所有框均为负向的请求必须包含文本提示(点不计入)。 以下情形返回 400 invalid_request:带 point 的提示上的 positive、点内的 positive: false,以及使用 sam-lite 时的 text 提示或框上的 positive。

Array<object>
至少 1 项 至多 50 项

一个提示:text、box 和 point 中恰好一个,另可带 group 和 options。

object
text

文本提示(sam3):要查找的对象类型,1 至 200 个字符。

string
至少 1 个字符 至多 200 个字符
box

框提示:样例框(sam3)或对象框(sam-lite)。

Array<number>
至少 4 项 至多 4 项
positive

样例框(sam3):true 表示“查找更多类似项”。为 false 时,该框是负向样例框(“排除此类”):与之相似的物体不会返回。仅适用于 sam3 的样例框。

boolean
默认值:true
point

点提示(sam3、sam-lite):落在对象上的一个正向点击,单位为摆正后的原图的像素。此处不接受负向点(positive: false),请使用 POST /v1/refine。

object
x
必填

水平位置,单位为摆正后的原图的像素。

number
y
必填

垂直位置,单位为摆正后的原图的像素。

number
positive

True:该点位于对象上。false:该点位于需要排除的区域上。

boolean
默认值:true
group

用于重叠去除(nms.scope: group)和合并的分组:1 到 64 个字母、数字和 _.:-。同一分组的提示相互比较和合并;没有分组的提示自成一组。会在实例上返回。

string
/^[A-Za-z0-9_.:-]{1,64}$/
options

单个提示的实例的后处理,在 options.defaults 中为所有提示设置,在 prompts[].options 中为单个提示设置。每个字段先取内置默认值,再由 options.defaults 覆盖,再由该提示的 options 覆盖。对象(polygon、mask、filter、cleanup)按字段合并:设置 polygon.tolerance 时保留 polygon.holes。数组(geometry)和阈值对象(minSize、minArea、dropFragments、fillHoles)整体替换;被替换的阈值中缺少的字段取其默认值,null 关闭阈值。

object
geometry

polygon:含洞的简化轮廓(Instance.polygon)。mask:像素蒙版(Instance.mask)。[]:不返回几何。

Array<string>
默认值:polygon 至多 2 项 元素唯一
允许的值: polygon mask
polygon

多边形输出。轮廓在清理后的蒙版上按图片分辨率描出(长边超过 4096 px 时,在长边 4096 px 的网格上描出后缩放),并用 Douglas-Peucker 算法简化。tolerance 和 tolerancePx 是同一项设置:在同一对象中同时给出返回 400 invalid_request;分层选项中以更具体的一层为准。

object
tolerance

简化容差,以图片对角线(sqrt(image.width² + image.height²))的比例表示:简化后的边与描出的轮廓之间的最大距离。默认值可能调整;对精度有要求时应显式设置。

number
默认值:0.001 <= 0.02
tolerancePx

简化容差,单位为图片像素,代替 tolerance。0 保留轮廓的全部顶点(受顶点上限约束)。

number
<= 50
holes

返回每个部分的洞。false 只返回外环。

boolean
默认值:true
maxParts

每个实例最多的部分(彼此分离的块)数量。保留最大的部分。

integer
默认值:64 >= 1 <= 64
mask

蒙版输出,在 geometry 包含 mask 时使用。

object
encoding

coco:整张蒙版的 COCO 压缩 RLE,无损,可用 pycocotools 读取。webp:对象紧贴裁剪区域的无损 WebP;只在发丝等极细的轮廓上比 coco 小,生成较慢,并受 WebP 像素预算限制(见 SegmentOptions)。

string
默认值:coco
允许的值: coco webp
filter

搜索类实例(sam3 文本提示和样例框)的过滤条件。写在对象提示上返回 400 invalid_request;options.defaults.filter 对对象提示不生效。

object
minScore

保留的最低 score(dropStats.lowScore)。

number
默认值:0.5 <= 1
minSize

最小框尺寸(dropStats.tooSmall)。默认:关闭。

object
ratio

阈值,以图片短边的比例表示。

number
<= 1
px

阈值,单位为图片像素。

number
<= 16384
border

贴着图片边界的框如何判断(见表)。

string
默认值:strict
允许的值: strict directional cornerLongSide cornerShortSide
edgeTolerancePx

框的边与图片边界的距离在此值(图片像素)以内时,视为贴边。

integer
默认值:1 <= 16
minArea

清理后实例的最小 area(dropStats.tooSmallArea)。默认:关闭。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
cleanup

蒙版清理,在尺寸过滤和几何输出之前作用于每个实例。面积为蒙版的像素面积。

object
dropFragments

除最大部分以外、面积小于此值的部分(彼此分离的块)被去除;最大的部分始终保留。null 保留所有部分。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
fillHoles

面积小于此值的洞被填充。null 保留所有洞。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
merge

把该提示的实例与同一 group 中其他 merge: true 的实例合并为一个实例(见 SegmentRequest)。

boolean
options

请求级选项。后处理免费,按固定顺序进行;每一步只处理前面各步保留下来的实例,括号中是该步丢弃的实例所计入的 dropStats 计数:

  1. 分数:低于 filter.minScore 的搜索类候选被丢弃(lowScore)。每个请求最多 300 个候选按分数顺序继续处理(limit)。
  2. 对每个实例进行清理(cleanup)。
  3. 尺寸:在清理后的实例上先按 filter.minSize(tooSmall),再按 filter.minArea(tooSmallArea)过滤。
  4. 重叠:nms(overlap)。
  5. 合并:在每个 group 内按 merge 合并。
  6. 数量:按分数顺序保留前 maxInstances 个搜索类实例(limit)。对象提示的实例始终保留。
  7. 几何输出,然后应用下列响应限制。

分数顺序用于每一步以及 instances 的排列:score 降序,然后 prompt 升序,然后按模型候选的顺序。

取决于图片内容的限制。 这些限制无法在调用运行前检查,因此按固定规则缩减输出,而不是使调用失败;同一图片上的同一请求得到相同的结果,每次缩减都在响应中可见:

  • 顶点上限,每个实例 8,192 个顶点(所有环合计)。超过时,将容差加倍后重新简化多边形,最多 6 次,起始值取请求的容差与 1 px 中的较大者;此时 tolerancePx 给出实际使用的容差。仍然超过上限时,从最大的部分起依次保留,直到再加一个部分就会超出上限;最大的部分单独就超过上限时,该实例没有 polygon,并带有 omitted: vertices。
  • 响应预算,每个响应 4 MiB 几何数据,按每个多边形顶点 4 字节、每个 COCO counts 字符串的长度和每个 WebP 蒙版的大小计算。实例按分数顺序使用预算;从第一个几何数据放不下的实例开始,实例保留 bbox、score 和 area,但不带几何,并带有 omitted: budget(budget)。
  • WebP 像素预算,每个响应 32 百万像素的 WebP 裁剪区域,按分数顺序计算;从第一个放不下的裁剪区域开始,蒙版以 coco 返回(由 mask.encoding 指明)。
  • dropped 最多列出 300 个实例,分数高者优先。

在调用运行前检查(返回 400 invalid_request,不收费):所有选项的取值范围、最多 50 个提示,以及 SegmentRequest 中列出的被拒绝的组合。

object
defaults

单个提示的实例的后处理,在 options.defaults 中为所有提示设置,在 prompts[].options 中为单个提示设置。每个字段先取内置默认值,再由 options.defaults 覆盖,再由该提示的 options 覆盖。对象(polygon、mask、filter、cleanup)按字段合并:设置 polygon.tolerance 时保留 polygon.holes。数组(geometry)和阈值对象(minSize、minArea、dropFragments、fillHoles)整体替换;被替换的阈值中缺少的字段取其默认值,null 关闭阈值。

object
geometry

polygon:含洞的简化轮廓(Instance.polygon)。mask:像素蒙版(Instance.mask)。[]:不返回几何。

Array<string>
默认值:polygon 至多 2 项 元素唯一
允许的值: polygon mask
polygon

多边形输出。轮廓在清理后的蒙版上按图片分辨率描出(长边超过 4096 px 时,在长边 4096 px 的网格上描出后缩放),并用 Douglas-Peucker 算法简化。tolerance 和 tolerancePx 是同一项设置:在同一对象中同时给出返回 400 invalid_request;分层选项中以更具体的一层为准。

object
tolerance

简化容差,以图片对角线(sqrt(image.width² + image.height²))的比例表示:简化后的边与描出的轮廓之间的最大距离。默认值可能调整;对精度有要求时应显式设置。

number
默认值:0.001 <= 0.02
tolerancePx

简化容差,单位为图片像素,代替 tolerance。0 保留轮廓的全部顶点(受顶点上限约束)。

number
<= 50
holes

返回每个部分的洞。false 只返回外环。

boolean
默认值:true
maxParts

每个实例最多的部分(彼此分离的块)数量。保留最大的部分。

integer
默认值:64 >= 1 <= 64
mask

蒙版输出,在 geometry 包含 mask 时使用。

object
encoding

coco:整张蒙版的 COCO 压缩 RLE,无损,可用 pycocotools 读取。webp:对象紧贴裁剪区域的无损 WebP;只在发丝等极细的轮廓上比 coco 小,生成较慢,并受 WebP 像素预算限制(见 SegmentOptions)。

string
默认值:coco
允许的值: coco webp
filter

搜索类实例(sam3 文本提示和样例框)的过滤条件。写在对象提示上返回 400 invalid_request;options.defaults.filter 对对象提示不生效。

object
minScore

保留的最低 score(dropStats.lowScore)。

number
默认值:0.5 <= 1
minSize

最小框尺寸(dropStats.tooSmall)。默认:关闭。

object
ratio

阈值,以图片短边的比例表示。

number
<= 1
px

阈值,单位为图片像素。

number
<= 16384
border

贴着图片边界的框如何判断(见表)。

string
默认值:strict
允许的值: strict directional cornerLongSide cornerShortSide
edgeTolerancePx

框的边与图片边界的距离在此值(图片像素)以内时,视为贴边。

integer
默认值:1 <= 16
minArea

清理后实例的最小 area(dropStats.tooSmallArea)。默认:关闭。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
cleanup

蒙版清理,在尺寸过滤和几何输出之前作用于每个实例。面积为蒙版的像素面积。

object
dropFragments

除最大部分以外、面积小于此值的部分(彼此分离的块)被去除;最大的部分始终保留。null 保留所有部分。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
fillHoles

面积小于此值的洞被填充。null 保留所有洞。

object
ratio

阈值,以图片面积(image.width x image.height)的比例表示。

number
<= 1
px

阈值,单位为平方图片像素。

number
<= 268435456
merge

把该提示的实例与同一 group 中其他 merge: true 的实例合并为一个实例(见 SegmentRequest)。

boolean
maxInstances

返回的搜索类实例的最大数量,在过滤、重叠去除和合并之后计数。对象提示的实例不计入。

integer
默认值:100 >= 1 <= 300
maskSize

蒙版网格的长边,单位为像素(64 到 4096),只用于 mask 输出。网格不会比图片大,因此实际长边取该值与图片长边中的较小者;mask.size 给出实际尺寸。多边形和框始终以图片像素表示。

integer
默认值:2048 >= 64 <= 4096
nms

搜索类实例之间的重叠去除(非极大值抑制)。按分数顺序贪心处理:实例与同一范围内已保留的实例的 IoU 大于 iou 时被丢弃(dropStats.overlap)。对象提示的实例从不参与。缺省或 null:关闭。

object
iou

IoU 大于此值时丢弃分数较低的实例(IoU 相等时两者都保留)。

number
默认值:0.7 <= 1
metric

mask:清理后蒙版的 IoU。box:bbox 的 IoU。

string
默认值:mask
允许的值: mask box
scope

group:只比较同一 group 的实例。all:比较所有搜索类实例。

string
默认值:group
允许的值: group all
report

丢弃实例的报告。

object
droppedBoxes

返回 dropped:每个被丢弃实例的框、分数和原因。

boolean
lowScoreFloor

设置时:只有分数不低于此值的候选计入 dropStats.lowScore 并列入 dropped。null:分数不低于 0.1 的候选计入 dropStats.lowScore,且不列出。

number | null
<= 1

示例

{
"model": "sam3",
"image": {
"id": "img_3b1f0c5e9a7d42c8b6e1f0a9d8c7b6a5f4e3d2c1b0a998877665544332211000"
},
"prompts": [
{
"text": "dog"
}
],
"options": {
"defaults": {
"filter": {
"minScore": 0.5
}
}
}
}

找到的实例,以及本次调用的扣费和余额。使用 Accept: application/cbor 时为 CBOR。

object
id
必填

调用 ID call_<uuid>;联系支持时应提供。

string
model
必填

处理该调用的模型 ID。

string
image
必填

坐标所对应的摆正后的原图。纯文本向量嵌入时不出现。

object
id
必填

图片句柄:img_ 加清理后字节的 SHA-256。

string
/^img_[0-9a-f]{64}$/
width
必填

摆正后的原图的宽度,单位为像素(已应用 EXIF 方向)。

integer
height
必填

摆正后的原图的高度,单位为像素(已应用 EXIF 方向)。

integer
bytes
必填

已存储图片的大小,单位为字节。

integer
contentType
必填

已存储图片的媒体类型(与上传的类型相同)。

string
允许的值: image/jpeg image/png image/webp
cost
必填

本次调用扣除的额度。失败的调用,以及由每日包含额度覆盖的调用,为 0。内部账户只计量、不扣费,此时 cost 为该调用的价格。

number
balance
必填

调用后的账户余额,单位为额度(内部账户的余额不变)。

number
timing
必填

本次调用在服务器侧的耗时,单位为毫秒。queueMs 为从提交到 GPU 节点领取任务的时间(包括排队,以及节点故障后的重新排队);processingMs 为从节点领取任务到结果返回的时间(获取图片、推理,以及节点与服务器之间的往返)。inferenceMs、imageFetchMs 和 serverMs 对此作进一步细分。不包含客户端与 API 之间的网络时间。

object
queueMs
必填

从提交到 GPU 节点领取任务的毫秒数。

integer
processingMs
必填

从节点领取任务到结果返回的毫秒数。

integer
inferenceMs

节点测得的 GPU 节点上的模型耗时,不含获取图片。不会大于 processingMs。节点未上报时不出现。

integer
imageFetchMs

节点获取图片字节所用的时间。图片随任务一同发送,或节点无需获取(编码缓存命中)时为 0。节点未上报时不出现。

integer
serverMs

API 服务器内的总耗时:从收到请求到响应写出之前。包括读取请求体、图片准备、准入、queueMs、processingMs 和计费结算。仅在重放由旧版服务器存储的幂等响应时不出现。

integer
billing

该调用的计价方式。

object
lines
必填

该调用每个计价单位一行。

Array<object>
object
unit
必填

价目表中的计费单位,与 GET /v1/models 的 prices[].unit 相同(例如 encode_image、prompt、refine、image)。

string
quantity
必填

使用的单位数。

integer
>= 1
unitPrice
必填

单个单位的标价。

number
amount
必填

该行的价格:unitPrice * quantity,waived 时为 0。对未扣费(charged 为 false)的调用(试用、每日包含额度),各行仍显示标价。

number
waived
必填

节点已持有该编码(cache: hit)时,图片编码费为 true;此时 amount 为 0,原本适用的费用为 unitPrice * quantity。

boolean
total
必填

该调用的价格(各行金额之和;capped 时削减到余额)。

number
charged
必填

是否从账户余额中扣费。Playground 试用调用,以及由每日包含额度覆盖的调用(此时设置了 pool 和 allowance)为 false;计费调用为 true。内部账户按标价计量、不扣费,此时 charged 为 false,total 为该调用的价格。

boolean
pool
必填

其每日包含额度覆盖了该调用的模型池(public 或 free)。计费调用(包括超出额度的调用)、试用调用和内部账户为 null。

string | null
allowance

pool 当日(UTC)的包含调用,计入本次调用。仅在设置了 pool 时出现。

object
used
必填

当日(UTC)已用调用次数,包括本次。

integer
>= 1
limit
必填

每个 UTC 日包含的调用次数。

integer
>= 1
capped

仅当价格超过余额、扣费被削减到余额时出现,且为 true。

boolean
instances
必填

按分数顺序排列的被分割对象(见 SegmentOptions)。

Array<object>

一个被分割出的对象。除另有说明外,所有坐标均为图片像素。

object
prompt

产生该实例的提示在 prompts 中的索引(仅分割);合并实例取其成员的最小索引。

integer
group

提示的 group,仅当请求设置了分组时出现。

string
label

文本提示(sam3 文本提示),样例框为 _exemplar。点提示的实例没有该字段。POST /v1/refine 的响应中没有该字段。

string
score
必填

实例的置信度。对于文本提示和样例框的实例,该值为检测置信度;对于点、框(sam-lite)和修整产生的实例,该值为蒙版的预测 IoU,即模型对蒙版与物体贴合程度的自我估计。合并实例取其成员的最高分。

number
<= 1
bbox
必填

[x1, y1, x2, y2]:紧贴清理后实例的框。x2 和 y2 不包含在内,因此 x2 - x1 为以像素计的宽度。

Array<integer>
至少 4 项 至多 4 项
area
必填

清理后实例的像素面积。

integer
merged

仅合并实例:合并的实例数。

integer
>= 2
polygon

geometry 包含 polygon 时:各部分,从大到小排列。没有任何部分能构成 3 个顶点的环时为空(只有一两个像素宽的对象)。

Array<object>

多边形的一个部分(彼此分离的块)。环为扁平整数数组 [x0, y0, x1, y1, ...],单位为图片像素。每个顶点是轮廓像素的中心,因此 0 <= x <= image.width - 1 且 0 <= y <= image.height - 1。环至少有 3 个不同的顶点,且不闭合(不重复第一个顶点)。外环在屏幕上为顺时针方向(y 轴向下时鞋带公式面积为正),洞为逆时针方向。简化后的环可能自相交。

object
outer
必填

外环。

Array<integer>
至少 6 项
holes

洞,从大到小排列。该部分没有洞或 polygon.holes 为 false 时没有该字段。

Array<Array<integer>>
tolerancePx

顶点上限(每个实例 8,192 个)要求使用比请求更大的容差时出现:实际使用的容差,单位为图片像素。

number
mask
One of:

蒙版网格上的整张蒙版,以 COCO 压缩 RLE(列优先)表示。{"size", "counts"} 是 pycocotools 可直接使用的 COCO RLE 对象。

object
encoding
必填

COCO 压缩 RLE。

string
允许的值: coco
size
必填

蒙版网格的 [高, 宽]:图片缩放到长边不超过 options.maskSize,从不放大。蒙版坐标在水平方向按 image.width / size[1]、垂直方向按 image.height / size[0] 缩放。

Array<integer>
>= 2 items <= 2 items
counts
必填

COCO 压缩游程字符串。

string
omitted

budget:响应预算已用尽,该实例不带几何。vertices:最大的部分单独就超过顶点上限,该实例没有 polygon。bbox、score 和 area 始终保留。

string
允许的值: budget vertices
dropStats

仅 POST /v1/segment:每个丢失了实例的提示一项,按提示顺序排列;没有丢失时为空。

Array<object>

单个提示丢失的实例,按原因计数。每个计数都会出现(没有时为 0)。

object
prompt
必填

在 prompts 中的索引。

integer
lowScore
必填

低于 filter.minScore 且分数不低于 report.lowScoreFloor(为 null 时取 0.1)的候选;模型会产出大量接近 0 的分数,这些不计入。

integer
tooSmall
必填

被 filter.minSize 丢弃。

integer
tooSmallArea
必填

被 filter.minArea 丢弃。

integer
overlap
必填

被 nms 丢弃。

integer
limit
必填

超出每个请求 300 个候选或超出 maxInstances。

integer
budget
必填

因响应预算用尽而不带几何返回(omitted: budget);这些实例仍在 instances 中。

integer
dropped

仅在设置 report.droppedBoxes 时出现:被丢弃的实例,分数高者优先,最多 300 个。

Array<object>
至多 300 项

一个被丢弃的实例(report.droppedBoxes)。

object
prompt
必填

在 prompts 中的索引。

integer
reason
必填

丢弃它的步骤;名称与 DropStats 中相同。

string
允许的值: lowScore tooSmall tooSmallArea overlap limit
score
必填

实例的分数。

number
<= 1
bbox
必填

[x1, y1, x2, y2],与 Instance.bbox 相同。对于 lowScore、limit 和部分 tooSmall 条目,实例在描出蒙版之前即被丢弃,框来自模型的低分辨率蒙版:是近似值,可能比对象大。

Array<integer>
至少 4 项 至多 4 项
cache
必填

hit:图片编码已被复用,编码费已减免。这不是承诺;见概览。

string
允许的值: hit miss
imageFee
必填

本次调用收取的图片编码费;缓存命中时为 0。

number

示例

{
"id": "call_0b6c2f0e-6f0e-4d0e-9f3a-5c1d2e3f4a5b",
"model": "sam3",
"image": {
"id": "img_3b1f0c5e9a7d42c8b6e1f0a9d8c7b6a5f4e3d2c1b0a998877665544332211000",
"width": 1008,
"height": 672,
"bytes": 184233,
"contentType": "image/jpeg"
},
"cost": 0.05,
"balance": 96.25,
"timing": {
"queueMs": 4,
"processingMs": 212,
"inferenceMs": 187,
"imageFetchMs": 0,
"serverMs": 231
},
"billing": {
"lines": [
{
"unit": "encode_image",
"quantity": 1,
"unitPrice": 0.5,
"amount": 0,
"waived": true
},
{
"unit": "prompt",
"quantity": 1,
"unitPrice": 0.05,
"amount": 0.05,
"waived": false
}
],
"total": 0.05,
"charged": true,
"pool": null
},
"instances": [
{
"prompt": 0,
"label": "dog",
"score": 0.97,
"bbox": [
312,
148,
702,
611
],
"area": 121530,
"polygon": [
{
"outer": [
402,
148,
655,
170,
701,
402,
610,
610,
330,
590,
312,
300
]
}
]
}
],
"dropStats": [
{
"prompt": 0,
"lowScore": 0,
"tooSmall": 0,
"tooSmallArea": 0,
"overlap": 1,
"limit": 0,
"budget": 0
}
],
"cache": "hit",
"imageFee": 0
}

错误信封。HTTP 状态码与 code 对应;只有 retryable: true 的错误才值得原样重复。失败的调用不收费。

状态码 错误码
400 invalid_request, invalid_image(图片通过了上传检查,但无法解码), unsupported
401 unauthorized
402 insufficient_balance
403 model_locked
404 not_found, image_not_found
409 idempotency_conflict, request_in_progress
413 payload_too_large
429 rate_limited, daily_limit_reached, too_many_batches(均带有 Retry-After)
500 internal_error
502 upstream_error, bad_model_output
503 model_unavailable, model_busy, unavailable(均带有 Retry-After)
504 upstream_timeout

model_unavailable 也用于唯一提供该模型的 GPU 节点短时失联:失联后约一分钟内,交互式调用立即返回该错误并带较短的 Retry-After(5 秒),同步和批量调用则继续排队到各自的截止时间,不会直接失败。

各错误码的含义和重试建议:错误。

媒体类型application/json

所有错误响应的响应体。

object
error
必填

错误。

object
code
必填

稳定的、机器可读的错误码。应依据该字段而不是 message 判断。与 HTTP 状态码的对应关系见响应部分。

string
message
必填

面向人的说明。措辞可能变化。

string
retryable
必填

为 true 时,原样重复同一请求有可能成功。

boolean
retryAfterMs
必填

建议重试前等待的毫秒数;无建议时为 0。

integer

示例

{
"error": {
"code": "model_busy",
"message": "model sam3 is busy; retry shortly",
"retryable": true,
"retryAfterMs": 5000
}
}
Retry-After
integer
>= 1

重试前须等待的整秒数;出现在 429 和 503 响应中。

X-Request-Id
string
/^[0-9a-f]{16}$/

服务器生成的请求 ID(16 个十六进制字符);出现在每个响应中。联系支持时应提供该值。