summaryrefslogtreecommitdiff
path: root/data/zh_cn/aigen/2024-01-11/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/aigen/2024-01-11/api-docs.php
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
Diffstat (limited to 'data/zh_cn/aigen/2024-01-11/api-docs.php')
-rw-r--r--data/zh_cn/aigen/2024-01-11/api-docs.php638
1 files changed, 638 insertions, 0 deletions
diff --git a/data/zh_cn/aigen/2024-01-11/api-docs.php b/data/zh_cn/aigen/2024-01-11/api-docs.php
new file mode 100644
index 0000000..fd3698b
--- /dev/null
+++ b/data/zh_cn/aigen/2024-01-11/api-docs.php
@@ -0,0 +1,638 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'aigen',
+ 'version' => '2024-01-11',
+ ],
+ 'directories' => [
+ [
+ 'id' => 0,
+ 'title' => '其它',
+ 'type' => 'directory',
+ 'children' => [
+ 'GenerateCosplayImage',
+ 'InteractiveFullSegmentation',
+ 'InteractiveScribbleSegmentation',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'GenerateCosplayImage' => [
+ 'summary' => '本文介绍生成专区(aigen)类目下的Cosplay-动漫人物生成GenerateCosplayImage的语法及示例。',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FaceImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输入的人脸图像URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG。'."\n"
+ .'- 图像大小:不超过4 MB。'."\n"
+ .'- 人脸图像:大于等于256x256像素,小于等于5760x3240像素,长宽比不超过1:2。'."\n"
+ .'> 当图像分辨率超过最大限制时,请先将图片进行缩放,调整图片大小,具体请参见[图片缩放](~~44688~~)。'."\n"
+ .'- URL地址中不能包含中文字符。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx01.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'TemplateImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输入的模板图像 URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG。'."\n"
+ .'- 图像大小:不超过4 MB。'."\n"
+ .'- 模板图像:大于等于256x256像素,小于等于5760x3240像素,长宽比不超过1:1.5,如果超过将自适应裁剪至1:1.5。'."\n"
+ .'> 当图像分辨率超过最大限制时,请先将图片进行缩放,调整图片大小,具体请参见[图片缩放](~~44688~~)。'."\n"
+ .'- URL地址中不能包含中文字符。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx02.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'Style',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '生成风格。取值范围:'."\n"
+ .'- 0:真人形象(realportrait)'."\n"
+ .'- 1:3D卡通形象(3dcartoon)',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => '59697D68-2A6E-4553-89BD-0FADD07881E8',
+ ],
+ 'Data' => [
+ 'description' => '返回的结果数据内容。该数据需要在异步任务执行成功后,通过调用[GetAsyncJobResult](~~607824~~)接口,对其Result字段进行JSON反序列化之后得到。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultUrl' => [
+ 'description' => 'Cosplay-人物动漫化生成结果图的URL地址。'."\n"
+ ."\n"
+ .'> 该URL地址为临时地址,有效期为30分钟,过期后将无法访问。若需要长时间或者永久保存文件,请在30分钟内访问URL地址,下载文件转存到自己的OSS或者其他存储空间。',
+ 'type' => 'string',
+ 'example' => 'https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/person_image_cartoonizer/2023-10-25/55798d04-0957-4ab1-accc-0e4d2d01a039/20231025092636774205_styleanime_n2vedxruht.jpg?Expires=1698283596&OSSAccessKeyId=LTAI****************&Signature=ut2kn46Lz%2FRwqJ9jWJ0RBDut12****',
+ ],
+ ],
+ ],
+ 'Message' => [
+ 'description' => '提交异步任务后的提示信息。',
+ 'type' => 'string',
+ 'example' => '该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"59697D68-2A6E-4553-89BD-0FADD07881E8\\",\\n \\"Data\\": {\\n \\"ResultUrl\\": \\"https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/person_image_cartoonizer/2023-10-25/55798d04-0957-4ab1-accc-0e4d2d01a039/20231025092636774205_styleanime_n2vedxruht.jpg?Expires=1698283596&OSSAccessKeyId=LTAI****************&Signature=ut2kn46Lz%2FRwqJ9jWJ0RBDut12****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<GenerateCosplayImageResponse>\\n <RequestId>59697D68-2A6E-4553-89BD-0FADD07881E8</RequestId>\\n <Message>该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</GenerateCosplayImageResponse>","errorExample":""}]',
+ 'title' => 'Cosplay-动漫人物生成',
+ 'description' => '## 功能描述'."\n"
+ .'通过输入人像图片和卡通形象图片,可快速生成人物卡通写真。目前支持3D卡通形象和真人形象两种风格。'."\n"
+ .'关于该接口功能的示例图如下:'."\n"
+ ."\n"
+ .'- 3D卡通形象图(左侧为输入的人像图片+卡通形象图片,右侧为输出的效果图)'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01cv0oWy1omnOgta8tO_!!6000000005268-2-tps-481-410.png" width="500)'."\n"
+ .'- 真人形象图(左侧为输入的人像图片+卡通形象图片,右侧为输出的效果图)'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01nDqiY21rUQMI21cl2_!!6000000005634-2-tps-443-392.png" width="500)'."\n"
+ ."\n"
+ .'> - 您可以进入[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)获取在线人工帮助。'."\n"
+ .'- 当前能力可在视觉智能开放平台有完整的免费产品体验,您可以单击[立即试用](https://vision.aliyun.com/experience/detail?tagName=aigen&children=GenerateCosplayImage)对该能力进行更直观试用以及在线购买。'."\n"
+ .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
+ ."\n"
+ .'## 应用场景'."\n"
+ ."\n"
+ .'- 社交媒体个性化:可以在社交媒体平台上传自己的照片,并使用人物动漫化工具将其转换为卡通形象作为头像或分享给好友,展现个性和创意。'."\n"
+ .'- 纪念品定制与艺术创作:制作个人化的动漫肖像画、T恤印花、杯子图案等定制商品,用于生日礼物、节日纪念或者艺术收藏。'."\n"
+ .'- 游戏与虚拟世界:在游戏设计中,可以将玩家的真实照片转化为动漫角色,用于游戏角色创建或个性化装扮,增强沉浸式体验。'."\n"
+ .'- 数字营销与广告设计:广告商在宣传活动中采用动漫化的人物形象,以新颖、有趣的方式吸引消费者关注,尤其适合年轻人群体的市场推广。'."\n"
+ .'- 教育与培训:在教育软件和在线课程中,将教师或学生形象动漫化,既保护隐私又增加了趣味性,有助于提高学习兴趣和参与度。'."\n"
+ .'- 内容创作与动画制作:动漫风格的人物生成可用于动画短片、漫画书以及网络表情包的快速制作,简化了美术设计流程,降低了内容创作者的门槛。'."\n"
+ .'- 视频编辑与特效处理:在视频剪辑软件中集成人物动漫滤镜,支持用户轻松制作出具有动漫效果的MV、短视频或其他创意作品。'."\n"
+ ."\n"
+ .'## 特色优势'."\n"
+ ."\n"
+ .'- 复刻人物表情:基于深度学习算法,能够准确识别人物的性别、表情等特征,并在生成的卡通头像上高度还原真实人物的表情。'."\n"
+ .'- 全身卡通化:不仅限于人脸的卡通化处理,提供全身卡通化的功能,从而避免因仅对脸部进行卡通化而可能产生的不协调感,如笑场等尴尬场景。'."\n"
+ .'- 批量稳定特效生成:该技术在社交媒体、游戏开发、广告设计、数字教育、娱乐产业等多个领域都可广泛应用,为各行业带来创新与活力。'."\n"
+ .'- 广泛适用性:该技术在社交媒体、游戏开发、广告设计、数字教育、娱乐产业等多个领域都可广泛应用,为各行业带来创新与活力。'."\n"
+ ."\n"
+ .'## 接入指引'."\n"
+ .'1. 注册阿里云账号:打开[阿里云官网](https://www.aliyun.com),在阿里云官网右上角,单击**立即注册**,按照操作提示完成账号注册。'."\n"
+ .'2. 开通能力:请确保您已开通生成专区服务,若未开通服务请[立即开通](https://common-buy.aliyun.com/?commodityCode=viapi_synthesis_public_cn)。'."\n"
+ .'3. 创建AccessKey:请确保您已[创建AccessKey](~~175144~~),如果您使用的是子账号AccessKey,您需要给子账号赋予AliyunVIAPIFullAccess权限,具体操作,请参见[RAM授权](~~145025~~)。'."\n"
+ .'4. 在线调试(可选):您可以通过[OpenAPI Explorer](https://next.api.aliyun.com/api/aigen/2024-01-11/GenerateCosplayImage)在线调试能力,查看完整的调用示例代码及SDK依赖信息,也可以下载完整的工程。'."\n"
+ .'5. 开发接入步骤:'."\n"
+ .'- 在[SDK总览](~~145033~~)中选择您要接入使用的SDK语言。'."\n"
+ .'- 在对应语言的SDK文档中找到AI类目为生成专区(aigen)的SDK包进行安装。'."\n"
+ .'- 参考文档中提供的示例代码进行适当修改后调用。'."\n"
+ ."\n"
+ .'6. 示例代码:该能力常用语言的示例代码,请参见[Cosplay-动漫人物生成示例代码](~~2699414~~),常用语言查询异步任务结果的示例代码,请参见[查询异步任务结果示例代码](~~607974~~)。'."\n"
+ .'7. 客户端直接调用:该能力常用的客户端调用方式包括以下几种。'."\n"
+ .'- [Web前端直接调用](~~467779~~)'."\n"
+ .'- [小程序场景下直接调用](~~467780~~)'."\n"
+ .'- [Android端直接调用](~~467781~~)'."\n"
+ .'- [iOS端直接调用](~~467782~~)'."\n"
+ ."\n"
+ .'## 输入限制'."\n"
+ ."\n"
+ .'- 图像格式:JPG、JPEG、PNG。'."\n"
+ .'- 图像大小:不超过4 MB。'."\n"
+ .'- 人脸图像:大于等于256x256像素,小于等于5760x3240像素,长宽比不超过1:2。'."\n"
+ .'> 当图像分辨率超过最大限制时,请先将图片进行缩放,调整图片大小,具体请参见[图片缩放](~~44688~~)。'."\n"
+ ."\n"
+ .'- 模板图像:大于等于256x256像素,小于等于5760x3240像素,长宽比不超过1:1.5,如果超过将自适应裁剪至1:1.5。'."\n"
+ .'> 当图像分辨率超过最大限制时,请先将图片进行缩放,调整图片大小,具体请参见[图片缩放](~~44688~~)。'."\n"
+ ."\n"
+ .'- URL地址中不能包含中文字符。'."\n"
+ ."\n"
+ .'## 调用步骤'."\n"
+ .'该能力为异步能力,需分两步进行调用。'."\n"
+ .'第一步调用GenerateCosplayImage接口提交任务,请求成功后,得到一个任务ID。'."\n"
+ .'第二步调用[GetAsyncJobResult](~~607824~~)接口查询结果,根据任务ID查询任务执行状态和结果。如果任务还在处理中,可稍等一段时间后再进行查询。'."\n"
+ ."\n"
+ .'## 计费说明'."\n"
+ .'Cosplay-动漫人物生成能力目前处于公测期,可免费调用。',
+ 'responseParamsDescription' => '## SDK参考'."\n"
+ .'阿里云视觉AI生成专区类目下的Cosplay-动漫人物生成能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为生成专区(aigen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见[SDK总览](~~145033~~)。'."\n"
+ ."\n"
+ .'## 示例代码'."\n"
+ .'该能力常用语言的示例代码,请参见[Cosplay-动漫人物生成示例代码](~~2699414~~)。',
+ 'extraInfo' => '## 错误码'."\n"
+ .'关于Cosplay-动漫人物生成的错误码,具体请参见[常见错误码](~~2699435~~)。'."\n"
+ ."\n"
+ .'## 安全声明'."\n"
+ .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
+ .'- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。',
+ ],
+ 'InteractiveFullSegmentation' => [
+ 'summary' => '本文介绍生成专区(aigen)类目下的全图分割InteractiveFullSegmentation的语法及示例。',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输入的图像URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过10 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素。'."\n"
+ .'- URL地址中不能包含中文字符。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx01.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'ReturnFormat',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输出图像格式。支持JPG、PNG,默认为PNG。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PNG',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => '7574ee8f-38a3-4b1e-9280-11c33ab46e51',
+ ],
+ 'Data' => [
+ 'description' => '返回的结果数据内容。该数据需要在异步任务执行成功后,通过调用[GetAsyncJobResult](~~607824~~)接口,对其Result字段进行JSON反序列化之后得到。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultUrl' => [
+ 'description' => '存放结果的txt文件的地址,包含如下信息:'."\n"
+ .'- output.region_index:索引图像,取值范围0~255。'."\n"
+ .'- output.region_info:由所有分割结果组成的列表,每个分割结果中的`region`值就是对应的分割图像,有效分割区域可视化为白色(像素值255),其他区域可视化为黑色(像素值0),`index`值为该分割结果的对应的索引值。'."\n"
+ ."\n"
+ .'> 该URL地址为临时地址,有效期为30分钟,过期后将无法访问。若需要长时间或者永久保存文件,请在30分钟内访问URL地址,下载文件转存到自己的OSS或者其他存储空间。',
+ 'type' => 'string',
+ 'example' => 'https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/interactive_seg_wanx/2024-02-21/6013dba4-2ce3-4f00-a2e7-14b8d22e81a5/20240221_120038993181_wcmohvxj9a.txt?Expires=1708574441&OSSAccessKeyId=LTAI****************&Signature=GZuvrbw8F3GOv0ykq9al%2FFBdg8****',
+ ],
+ ],
+ ],
+ 'Message' => [
+ 'description' => '提交异步任务后的提示信息。',
+ 'type' => 'string',
+ 'example' => '该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7574ee8f-38a3-4b1e-9280-11c33ab46e51\\",\\n \\"Data\\": {\\n \\"ResultUrl\\": \\"https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/interactive_seg_wanx/2024-02-21/6013dba4-2ce3-4f00-a2e7-14b8d22e81a5/20240221_120038993181_wcmohvxj9a.txt?Expires=1708574441&OSSAccessKeyId=LTAI****************&Signature=GZuvrbw8F3GOv0ykq9al%2FFBdg8****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<InteractiveFullSegmentationResponse>\\n <RequestId>7574ee8f-38a3-4b1e-9280-11c33ab46e51</RequestId>\\n <Message>该调用为异步调用,任务已提交成功,请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</InteractiveFullSegmentationResponse>","errorExample":""}]',
+ 'title' => '交互式全图分割',
+ 'description' => '## 服务说明'."\n"
+ .'由于产品业务调整,交互式全图分割服务将于2025年08月14日起停止新用户开通调用,历史开通过该服务的老用户可继续调用,2025年10月14日后该服务将下架,不再支持新老用户调用,请尽早寻找替代方案。如果对交互式全图分割API服务使用有疑问,可通过搜索钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
+ ."\n"
+ .'## 功能描述'."\n"
+ .'交互式全图分割能力支持以单张图片作为输入,无需任何其他提示,即可返回图片中所有元素的分割结果。用户可以通过点击操作选择其中所需的元素,实现图片中分割元素的自由选择。'."\n"
+ .'关于该接口功能的示例图如下:'."\n"
+ ."\n"
+ .'- 输入原图'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01lCAP981RoPdPWzKLg_!!6000000002158-0-tps-750-500.jpg" width="500)'."\n"
+ .'- 全图分割'."\n"
+ .'![](https://img.alicdn.com/imgextra/i4/O1CN01Yva0je1jNXTkrGbO9_!!6000000004536-0-tps-750-500.jpg" width="500)'."\n"
+ .'- 点选操作后的mask'."\n"
+ .'![](https://img.alicdn.com/imgextra/i2/O1CN015PLtdV1PV3fH2nxF9_!!6000000001845-0-tps-750-500.jpg" width="500)'."\n"
+ .'- 分割结果'."\n"
+ .'![](https://img.alicdn.com/imgextra/i2/O1CN01GPJfUh1J6QfiuDwdc_!!6000000000979-2-tps-1000-667.png" width="500)'."\n"
+ ."\n"
+ .'> - 您可以进入[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)获取在线人工帮助。'."\n"
+ .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
+ ."\n"
+ .'## 应用场景'."\n"
+ .'图片编辑:可对图像中的任意涂抹元素进行选择并智能分离,实现图像后续的二次编辑。'."\n"
+ ."\n"
+ .'## 特色优势'."\n"
+ .'- 图片元素识别:根据涂抹区域的位置和大小,自动对涂抹目标进行识别和分割。'."\n"
+ .'- 自由开放选择:允许用户通过鼠标涂抹操作自由选择和排除所需的分割对象。'."\n"
+ .'- 适用多种场景:适用于人、动物、食物、物品、家居等各种抠图场景,使用范围广。'."\n"
+ ."\n\n"
+ ."\n"
+ .'## 输入限制'."\n"
+ ."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过10 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素。'."\n"
+ .'- URL地址中不能包含中文字符。'."\n"
+ ."\n"
+ .'## 调用步骤'."\n"
+ .'该能力为异步能力,需分两步进行调用。'."\n"
+ ."\n"
+ .'第一步调用InteractiveFullSegmentation接口提交任务,请求成功后,得到一个任务ID。'."\n"
+ ."\n"
+ .'第二步调用GetAsyncJobResult接口查询结果,根据任务ID查询任务执行状态和结果。如果任务还在处理中,可稍等一段时间后再进行查询。'."\n"
+ ."\n"
+ .'## 计费说明'."\n"
+ .'交互式全图分割能力目前处于公测期,可免费调用。',
+ 'responseParamsDescription' => '## 结果文件格式'."\n"
+ .'分割的结果会以JSON字符串的形式存储在输出的文本文件中,对应的图像会以Base64的结构存储在对应的Base64字段中。'."\n"
+ .'| 名称 | 类型 | 示例值 | 描述 |'."\n"
+ .'| --- | --- | --- | --- |'."\n"
+ .'| output.region_info | List | [{"region": "data:image/png;base64,/9j/4AAQ........GBlPjwh//2Q==", "area": 178579,"index": 1}, ...] | 所有输出mask的信息。region为mask的Base64编码,area为mask的面积, index为该mask的索引,index从1开始,0表示没有结果。 |'."\n"
+ .'| output.region_index | String | "data:image/png;base64,/9j/4AAQSkZJR........GBlPjwh//2Q==" | 所有mask index的整合,值为0~255,输出为Base64编码。 |'."\n"
+ .'| bbox | Array of Integer | [303,0,21,14] | 包含mask的bounding box的坐标,按照XYWH的顺序。 |'."\n"
+ .'| crop_box | Array of Integer | [0,0,585,390] | 预测mask时用到的image切片的坐标,按照XYWH的顺序。 |'."\n"
+ .'| point_coords | Array of Integer | [310.78125,12.1875] | 生成mask对应的预测点坐标。 |'."\n"
+ .'| predicted_iou | Float | 0.9326171875 | 预测的置信度。 |'."\n"
+ .'| stability_score | Float | 0.9660193920135498 | mask质量的评估。 |'."\n"
+ .'| area | Long | 204 | mask所占的像素数,可以理解为面积。 |'."\n"
+ ."\n"
+ .'结果文件示例'."\n"
+ .'`{'."\n"
+ .' "output":{'."\n"
+ .' "region_index":"<BASE64_CODE>",'."\n"
+ .' "region_info":['."\n"
+ .' {'."\n"
+ .' "area":204,'."\n"
+ .' "bbox":[303,0,21,14],'."\n"
+ .' "crop_box":[0,0,585,390],'."\n"
+ .' "index":1,'."\n"
+ .' "point_coords":['."\n"
+ .' [310.78125,12.1875]'."\n"
+ .' ],'."\n"
+ .' "predicted_iou":0.9326171875,'."\n"
+ .' "region":"<BASE64_CODE>",'."\n"
+ .' "stability_score":0.9660193920135498'."\n"
+ .' },'."\n"
+ .' ... ...'."\n"
+ .' ... ...'."\n"
+ .' {'."\n"
+ .' "area":1353,'."\n"
+ .' "bbox":Array[4],'."\n"
+ .' "crop_box":Array[4],'."\n"
+ .' "index":10,'."\n"
+ .' "point_coords":Array[1],'."\n"
+ .' "predicted_iou":0.94873046875,'."\n"
+ .' "region":"<BASE64_CODE>",'."\n"
+ .' "stability_score":0.9708878993988037'."\n"
+ .' },'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .'}`'."\n"
+ .'返回值的可视化效果示例图如下:'."\n"
+ .'- 第一列为`output.region_index`的可视化结果,取值0~255,尺寸与原图一致,该返回值起索引作用,实际渲染时不会用到。'."\n"
+ .'- 第二列为`output.region_info`的部分mask的可视化结果示意,每个mask取值为0和255,尺寸与原图一致。`output.region_info`是由所有分割结果组成的列表,通过`output.region_index`与原图建立映射。'."\n"
+ ."\n"
+ .'![](https://img.alicdn.com/imgextra/i4/O1CN01FjYgjm1F5HEcololR_!!6000000000435-2-tps-1465-1036.png" width="500)'."\n"
+ ."\n\n"
+ .'## 查询结果'."\n"
+ .'该接口为异步接口,当前并未返回真实的请求结果,您需要通过返回的RequestId调用GetAsyncJobResult接口来获取该接口的真实请求结果。详情请参见[GetAsyncJobResult](~~607824~~)。'."\n"
+ ."\n"
+ .'## SDK参考'."\n"
+ .'阿里云视觉AI创新专区类目下的交互式全图分割能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为创新专区(aigen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见[SDK总览](~~145033~~)。'."\n"
+ ."\n"
+ .'## 示例代码'."\n"
+ .'该能力常用语言的示例代码,请参见[交互式全图分割示例代码](~~2699417~~)。',
+ 'extraInfo' => '## 错误码'."\n"
+ .'关于交互式全图分割的错误码,具体请参见[常见错误码](~~2699435~~)。'."\n"
+ ."\n"
+ .'## 安全声明'."\n"
+ .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
+ .'- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。',
+ ],
+ 'InteractiveScribbleSegmentation' => [
+ 'summary' => '本文介绍生成专区(aigen)类目下的交互式涂抹分割InteractiveScribbleSegmentation的语法及示例。',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输入的图像URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过10 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素。'."\n"
+ .'- URL地址中不能包含中文字符。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx01.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'MaskImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输入的Mask URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过5 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,并与输入原图分辨率保持一致。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx02.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'PosScribbleImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '正向涂抹轨迹图像URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过5 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素,并与输入原图分辨率保持一致。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx03.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'NegScribbleImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '负向涂抹轨迹图像URL。推荐使用上海地域的OSS链接,对于文件在本地或者非上海地域OSS链接的情况,请参见[文件URL处理](~~155645~~)。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过5 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素,并与输入原图分辨率保持一致。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx04.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'IntegratedMaskUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '整合的Mask URL。将初始mask、正向划线记录、负向划线记录分别放在rgb图像的三个通道,合成一个图片,减少传输的图片数量,从而节省上传下载时间。输入限制如下:'."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过5 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素,并与输入原图分辨率保持一致。'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/aigen/xxx05.png',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'ReturnForm',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输出图像形式。取值范围如下:'."\n"
+ ."\n"
+ .'- rgb_alpha(默认):返回四通道PNG图,即透明底图。'."\n"
+ .'- only_alpha:返回单通道mask。'."\n"
+ .'- white_background:返回白底图。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'only_alpha',
+ ],
+ ],
+ [
+ 'name' => 'ReturnFormat',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '输出图像格式。支持JPG、PNG,默认为PNG。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PNG',
+ ],
+ ],
+ [
+ 'name' => 'EdgeFeathering',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '是否做边缘羽化。默认值为true。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'PostprocessOption',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '选择mask精细化模型。取值范围如下:'."\n"
+ ."\n"
+ .'- edgerefine:稳定但精细度稍微差一点。'."\n"
+ .'- maskrefine(默认):精细度高但不够稳定。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'edgerefine',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '请求ID。',
+ 'type' => 'string',
+ 'example' => '7574ee8f-38a3-4b1e-9280-11c33ab46e51',
+ ],
+ 'Data' => [
+ 'description' => '返回的结果数据内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResultUrl' => [
+ 'description' => '输出图片的URL,格式由请求参数确定。'."\n"
+ .'> 该URL地址为临时地址,有效期为30分钟,过期后将无法访问。若需要长时间或者永久保存文件,请在30分钟内访问URL地址,下载文件转存到自己的OSS或者其他存储空间。',
+ 'type' => 'string',
+ 'example' => 'https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/person_image_cartoonizer/2023-10-25/55798d04-0957-4ab1-accc-0e4d2d01a039/20231025092636774205_styleanime_n2vedxruht.jpg?Expires=1698283596&OSSAccessKeyId=LTAI****************&Signature=ut2kn46Lz%2FRwqJ9jWJ0RBDut12****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7574ee8f-38a3-4b1e-9280-11c33ab46e51\\",\\n \\"Data\\": {\\n \\"ResultUrl\\": \\"https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/person_image_cartoonizer/2023-10-25/55798d04-0957-4ab1-accc-0e4d2d01a039/20231025092636774205_styleanime_n2vedxruht.jpg?Expires=1698283596&OSSAccessKeyId=LTAI****************&Signature=ut2kn46Lz%2FRwqJ9jWJ0RBDut12****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<InteractiveScribbleSegmentationResponse>\\n <RequestId>7574ee8f-38a3-4b1e-9280-11c33ab46e51</RequestId>\\n <Data>\\n <ResultUrl>https://dashscope-result-sh.oss-cn-shanghai.aliyuncs.com/viapi-video/person_image_cartoonizer/2023-10-25/55798d04-0957-4ab1-accc-0e4d2d01a039/20231025092636774205_styleanime_n2vedxruht.jpg?Expires=1698283596&amp;OSSAccessKeyId=LTAI****************&amp;Signature=ut2kn46Lz%2FRwqJ9jWJ0RBDut12****</ResultUrl>\\n </Data>\\n</InteractiveScribbleSegmentationResponse>","errorExample":""}]',
+ 'title' => '交互式涂抹分割',
+ 'description' => '## 服务说明'."\n"
+ .'由于产品业务调整,交互式涂抹分割服务将于2025年08月14日起停止新用户开通调用,历史开通过该服务的老用户可继续调用,2025年10月14日后该服务将下架,不再支持新老用户调用,请尽早寻找替代方案。如果对交互式涂抹分割API服务使用有疑问,可通过搜索钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
+ ."\n"
+ .'## 功能描述'."\n"
+ .'交互式涂抹分割能力支持用户通过鼠标涂抹的方式选择目标元素,算法模型通过涂抹区域的位置和大小,自动对涂抹的目标进行分割。'."\n"
+ .'关于该接口功能的示例图如下:'."\n"
+ ."\n"
+ .'- 输入原图'."\n"
+ .'![](https://img.alicdn.com/imgextra/i4/O1CN01PqgYCG1QnCycLh5Ko_!!6000000002020-0-tps-750-500.jpg" width="500)'."\n"
+ .'- 涂抹操作'."\n"
+ .'![](https://img.alicdn.com/imgextra/i1/O1CN015rzRd21zXe4SBvMD3_!!6000000006724-0-tps-353-233.jpg" width="500)'."\n"
+ .'- 分割mask'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN0196ZJjz1C84mm1Wrjs_!!6000000000035-0-tps-750-500.jpg" width="500)'."\n"
+ .'- 分割结果'."\n"
+ .'![](https://img.alicdn.com/imgextra/i4/O1CN01JduQb127WHowZOHkQ_!!6000000007804-2-tps-1000-667.png" width="500)'."\n"
+ ."\n"
+ .'> - 您可以进入[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)获取在线人工帮助。'."\n"
+ .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
+ ."\n"
+ .'## 应用场景'."\n"
+ .'图片编辑:可对图像中的任意涂抹元素进行选择并智能分离,实现图像后续的二次编辑。'."\n"
+ ."\n"
+ .'## 特色优势'."\n"
+ .'- 图片元素识别:根据涂抹区域的位置和大小,自动对涂抹目标进行识别和分割。'."\n"
+ .'- 自由开放选择:允许用户通过鼠标涂抹操作自由选择和排除所需的分割对象。'."\n"
+ .'- 适用多种场景:适用于人、动物、食物、物品、家居等各种抠图场景,使用范围广。'."\n"
+ ."\n\n"
+ ."\n"
+ .'## 输入限制'."\n"
+ ."\n"
+ .'- 图像格式:JPG、JPEG、PNG、BMP、WEBP。'."\n"
+ .'- 图像大小:不超过10 MB。'."\n"
+ .'- 输入图像:大于等于32x32像素,小于等于4096x4096像素。'."\n"
+ .'- URL地址中不能包含中文字符。'."\n"
+ ."\n"
+ .'## 计费说明'."\n"
+ .'交互式涂抹分割能力目前处于公测期,可免费调用。',
+ 'responseParamsDescription' => '## 参数可视化说明'."\n"
+ .'功能一:正向涂抹分割'."\n"
+ .'示例:输入原图、当前mask、正向涂抹记录,输出正向分割结果。'."\n"
+ .'![](https://img.alicdn.com/imgextra/i3/O1CN01ndnaA826l73mVmw9L_!!6000000007701-49-tps-750-556.webp" width="700)<br>'."\n"
+ ."\n"
+ .'功能二:负向涂抹分割'."\n"
+ .'输入原图、当前mask、负向涂抹记录,输出负向分割结果。'."\n"
+ .'![](https://img.alicdn.com/imgextra/i2/O1CN01ECIzHk1Nj8duHq6UM_!!6000000001605-49-tps-750-561.webp" width="700)'."\n"
+ ."\n"
+ .'## SDK参考'."\n"
+ .'阿里云视觉AI创新专区类目下的交互式涂抹分割能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为创新专区(aigen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见[SDK总览](~~145033~~)。'."\n"
+ ."\n"
+ .'## 示例代码'."\n"
+ .'该能力常用语言的示例代码,请参见[交互式涂抹分割示例代码](~~2699418~~)。',
+ 'extraInfo' => '## 错误码'."\n"
+ .'关于交互式涂抹分割的错误码,具体请参见[常见错误码](~~2699435~~)。'."\n"
+ ."\n"
+ .'## 安全声明'."\n"
+ .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
+ .'- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'aigen.cn-shanghai.aliyuncs.com',
+ ],
+ ],
+];