本文介绍图文生成、图文检索等API内容
版本变更
版本 | 描述 | 时间 |
v0.7 |
| 20240731 |
v0.6 |
| 20240715 |
v0.5 | SDK版本升级 | 20240617 |
v0.4 | GetTextTask接口出参新增Texts相关数据 | 20240605 |
v0.3 |
| 20240603 |
v0.2 |
| 20240527 |
v0.1 | 功能发布 | 20240320 |
概述
本产品中的基本概念如下:
概念 | 描述 |
文案任务 | 一个提交文案生成的任务,一个任务中可以要求生成多篇文案。 |
文案 | 一篇生成的具体文案。 |
配图任务 | 一个提交配图生成的任务,一个配图任务可以要求生成多张配图。 一个配图任务需要针对某一篇文案发起。 |
配图 | 一张生成的配图 |
接入认证
接入准备
需要接入方提前准备阿里云账号,并利用阿里云子账号生成对应的AK/SK;
阿里云主账号需要对生成AK/SK的子账号进行RAM授权;
使用阿里云主账号登录平台,签署相关法务协议。
产品规格
说明 | 规格数量 |
单次文案任务中生成文案数量上限 | 10 |
单篇文案支持挂载的配图任务数量上限 | 5 |
API概览
本产品中所有开放的API,按照功能目录分类,将API链接和API描述罗列出来。
通用接口
API | 描述 |
GetOssUploadToken | 获取oss上传签名 |
文案接口
API | 描述 |
CreateTextTask | 创建文案任务 |
GetTextTask | 获取文案任务 |
GetText | 获取文案 |
ListTexts | 列举文案 |
ListTextThemes | 列举文案主题 |
GetTextTemplate | 获取行业对应风格 |
AddTextFeedback | 添加文案反馈 |
CountText | 统计文案数量 |
配图接口
API | 描述 |
CreateIllustrationTask | 创建配图任务 |
GetIllustrationTask | 获取配图任务 |
GetIllustration | 获取配图 |
API详情
GetOssUploadToken
接口说明:获取oss上传签名
入参:GetOssUploadRequest
参数名称 | 类型 | 是否必填 | 说明 | 示例值 |
fileName | String | 是 | 文件名称 | xxx.png |
fileType | String | 是 | 文件类型ProductImage | ProductImage |
出参:UploadInfo
参数名称 | 类型 | 说明 | 示例值 |
host | String | 上传的oss host | yic-pre.oss-cn-hangzhou.aliyuncs.com |
key | String | 允许的上传key | 1234/temp-novels/xxxx-xxx-xx.txt |
policy | String | 上传策略(base64编码) | xxxxxxxx |
policySignature | String | 上传策略签名结果 | xxxxxxxx |
accessId | String | 上传使用ak | xxxxxx |
url | String | 文件url地址 | http://oss.xxxxx |
CreateTextTask
接口说明:创建文案任务
入参:TextTaskCreateCmd
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
style | String | 是 | 文案风格
| WECHAT_MOMENT |
textModeType | String | 是 | 模式
| Generate |
number | Integer | 是 | 生成文案数量 | 4 |
industry | String | 是 | 行业属性 生成模式使用 | Garment |
themes | array | 是 | 多内容主题 生成模式使用 | [TOUR_ROUTE] |
contentRequirement | String | 除朋友圈、企微话术外,必填 | 内容要求 生成模式使用 | xxx |
introduction | String | 是 | 产品介绍 生成模式使用 | xxx |
point | String | 否 | 产品卖点 生成模式使用 | 超强续航 |
target | String | 除朋友圈、企微话术外,必填 | 文案视角 生成模式使用
| User |
referenceTag | obj | 仿写模式必填 | 仿写 仿写模式使用 | |
relatedRagIds | array | 否 | 关联的RAG知识库 | [1] |
agentId | String | 否 | 智能体id | 123 |
ReferenceTag:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
referenceTitle | String | 小红书必填 | 仿写标题 | xxx |
referenceContent | String | 是 | 仿写内容 | xxx |
出参:TextTaskResult
参数名称 | 类型 | 说明 | 示例值 |
textTask | obj | 文本任务对象 | TextTask |
TextTask:
参数名称 | 类型 | 说明 | 示例值 |
textTaskId | Long | 任务id | 123 |
gmtCreate | String | 创建时间 | |
gmtModified | String | 更新时间 | |
textTaskStatus | String | 文案任务状态 | SUCCESS |
style | String | 文案风格 | RED_BOOK |
theme | String | 内容主题Name | TOUR_ROUTE |
themeDesc | String | 文案主题描述 | 旅游路线 |
contentRequirement | String | 内容要求 | 九寨沟三日游攻略 |
introduction | String | 产品介绍 | xxx |
point | String | 产品卖点 | xxx |
target | String | 文案视角 | User |
referenceTag | obj | 仿写参考 | ReferenceTag |
nums | Integer | 生成数量 | 1 |
relatedRagIds | array | 关联知识库 | [1] |
textModeType | String | 生成模式 | Generate |
textIds | array | 文案Id列表 | [123,456] |
agentName | String | 智能体名称 | |
agentId | String | 智能体id |
ReferenceTag:
参数名称 | 类型 | 说明 | 示例值 |
referenceTitle | String | 仿写标题 | |
referenceContent | String | 仿写内容 |
生成模式-微信朋友圈调用模板
{
"number": 2,
"textModeType": "Generate",
"style": "WECHAT_MOMENT",
"industry": "CulturalTour",
"introduction": "九寨沟山清水秀,环境优美。" ,
"themes": [
"TOUR_ROUTE",
"ATTRACTION_TICKET"
]
}
生成模式-小红书调用模板
{
"number": 2,
"textModeType": "Generate",
"style": "RED_BOOK",
"industry": "CulturalTour",
"contentRequirement": "厦门4日游",
"introduction": "路线安排 第1天: 中山路-猫街-沙坡尾-黄厝沙滩(日出)-曾厝按 第2天: 厦门植物园-厦门大学(需预约)-南普陀寺-钟鼓索道-演武大桥(观日落) 第3天: 鼓浪屿-八市 第4天: 海上地铁-海堤路-集美学村-厦门北",
"point": "景点旅游线路",
"target": "Seller",
"themes": [
"TOUR_ROUTE"
]
}
GetTextTask
接口说明:获取文案任务
入参:
参数名称 | 类型 | 是否必选 | 说明 |
textTaskId | Long | 是 | 文案任务id |
出参:TextTaskResult
参数名称 | 类型 | 说明 | 示例值 |
textTask | obj | 文案任务对象 | TextTask |
TextTask:
参数名称 | 类型 | 说明 | 示例值 |
textTaskId | Long | 任务id | 123 |
gmtCreate | String | 创建时间 | |
gmtModified | String | 更新时间 | |
textTaskStatus | String | 文案任务状态 | SUCCESS |
style | String | 文案风格 | RED_BOOK |
theme | String | 内容主题Name | TOUR_ROUTE |
themeDesc | String | 文案主题描述 | 旅游路线 |
contentRequirement | String | 内容要求 | 九寨沟三日游攻略 |
introduction | String | 产品介绍 | xxx |
point | String | 产品卖点 | xxx |
target | String | 文案视角 | User |
referenceTag | obj | 仿写参考 | ReferenceTag |
nums | Integer | 生成数量 | 1 |
relatedRagIds | array | 关联知识库 | [1] |
textModeType | String | 生成模式 | Generate |
textIds | array | 文案Id列表 | [123,456] |
texts | obj | 文案信息对象 | 数据结果详见“GetText”接口Text对象 |
agentName | String | 智能体名称 | |
agentId | String | 智能体id |
GetText
接口说明:查看文案内容
入参:
参数名称 | 类型 | 是否必选 | 说明 |
textId | Long | 是 | 文案ID |
出参:TextResult
参数名称 | 类型 | 说明 | 示例值 |
text | obj | 文案对象 | Text |
requstId | String | 接口请求requestId | xxx |
Text:
参数名称 | 类型 | 说明 | 示例值 |
textId | Long | 文案ID | 123 |
gmtCreate | String | 创建时间 | |
gmtModified | String | 更新时间 | |
textStatus | String | 文案任务状态 | SUCCESS |
textTaskIdID | Long | 文案关联文案任务ID | 123 |
userNameCreate | String | 文案创建用户名称 | |
userNameModified | String | 文案修改用户名称 | |
title | String | 文案标题 | |
desc | String | 描述 | |
textContent | String | 文案内容 | |
textModeType | String | 文案生成类型 | Generate |
textIllustrationTag | Boolean | 是否用于配图任务 | true |
illustrationTaskIdList | array | 配图任务ID列表 | [123,456] |
textStyleType | String | 文案风格 | WECHAT_MOMENT |
publishStatus | String | 发布状态 | PUBLISH |
textThemes | array | 文案主题列表 | ["xxx", "xxxx"] |
agentName | String | 智能体名称 | |
agentId | String | 智能体id |
ListTexts
接口说明:列举文案
入参:
参数名称 | 类型 | 是否必选 | 说明 |
industry | String | 否 | 行业信息 |
textStyleType | String | 否 | 文案风格 |
textTheme | String | 否 | 文案主题 |
publishStatus | String | 否 | 发布状态
|
generationSource | String | 否 | 生成来源
|
keyword | String | 否 | 用于搜索生成文案的关键词 |
pageSize | Integer | 是 | 分页大小
|
pageNumber | Integer | 是 | 当前页序号,从1开始。 |
出参:
参数名称 | 类型 | 说明 | 示例值 |
requestId | String | 接口请求requestId | xxx |
total | Integer | 总数 | 10 |
texts | array | 文案列表 | Text |
ListTextThemes
接口说明:查询文案主题列表
入参:
参数名称 | 类型 | 是否必选 | 说明 |
industry | String | 是 | 行业信息 |
出参:TextThemeListResult
参数名称 | 类型 | 说明 | 示例值 |
textThemeList | array | 主题类型 | TextTheme |
requestId | String | 接口请求requestId | xxx |
TextTheme:
参数名称 | 类型 | 说明 | 示例值 |
name | String | 名称 | TOUR_ROUTE |
desc | String | 描述 | 旅游路线 |
CreateIllustrationTask
接口说明:创建配图任务
入参:
参数名称 | 类型 | 是否必选 | 说明 |
textId | Long | 是 | 文件名称 |
body | obj | 是 | IllustrationTaskCreateCmd |
IllustrationTaskCreateCmd:
参数名称 | 类型 | 是否必选 | 说明 |
ossPaths | array | 是 | oss path list ["1235/xxx.text","1235/xxxx2113.text"] |
nums | Integer | 是 | 生成数量 |
stickerText | String | 是 | 花字 |
backgroundType | Integer | 是 | 0-不换背景,1-换背景 |
dstWidth | Integer | 是 | 生成图片宽度 |
dstHeight | Integer | 是 | 生成图片高度 |
出参:IllustrationTaskResult
参数名称 | 类型 | 说明 | 示例值 |
illustrationTask | obj | 配图任务 | IllustrationTask |
IllustrationTask:
参数名称 | 类型 | 说明 | 示例值 |
illustrationTaskId | Long | 配图任务ID | 123 |
gmtCreate | Date | 创建时间 | |
gmtModified | Date | 更新时间 | |
textId | Long | 关联文案ID | |
taskStatus | String | 任务状态 | Success |
illustrationIds | array | 配图Id信息 | [123,456] |
GetIllustrationTask
接口说明:查询配图任务
入参:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textId | Long | 是 | 文案ID | 123 |
illustrationTaskId | Long | 是 | 配图任务ID | 123 |
出参:IllustrationTaskResult
参数名称 | 类型 | 说明 | 示例值 |
illustrationTask | obj | 配图任务 | IllustrationTask |
requestId | String | 接口请求requestId | xxx |
GetIllustration
接口说明:查询配图
入参:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textId | Long | 是 | 文案ID | 123 |
illustrationId | Long | 是 | 配图任务ID | 123 |
出参:IllustrationResult
参数名称 | 类型 | 说明 | 示例值 |
requestId | String | 接口请求request | xxx |
illustration | obj | 配图信息 | Illustration |
illustration:
参数名称 | 类型 | 说明 | 示例值 |
illustrationId | Long | 配图ID | 123 |
oss | String | oss加签后地址 | http://ossxxxxxx |
GetTextTemplate
接口说明:查询文本模板
入参:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
industry | String | 是 | 行业类型 | Car |
出参:TextTemplateOpenResult
参数名称 | 类型 | 说明 | 示例值 |
requestId | String | 接口请求request | xxx |
availableIndustry | obj | 可用行业 |
AvailableIndustryOpen:
参数名称 | 类型 | 说明 | 示例值 |
name | String | 行业值 | Common |
textModeTypes | List | 文本枚举类型 |
AvailableTextModeTypeOpen:
参数名称 | 类型 | 说明 | 示例值 |
name | String | 文案生成类型
| Generate |
textStyles | List | 文本风格 |
AvailableTextStyleOpen:
参数名称 | 类型 | 说明 | 示例值 |
name | String | 文案风格名称 | RED_BOOK |
desc | String | 文案风格说明 | 小红书 |
{
"requestId": "0987EED3-752A-150A-B78B-ABCDD4890507",
"availableIndustry": {
"textModeTypes": [
{
"name": "Generate",
"textStyles": [
{
"name": "RED_BOOK",
"disabled": false,
"desc": "小红书"
},
{
"name": "WECHAT_MOMENT",
"disabled": false,
"desc": "朋友圈"
}
]
},
{
"name": "Rewrite",
"textStyles": [
{
"name": "RED_BOOK",
"disabled": false,
"desc": "小红书"
},
{
"name": "WECHAT_MOMENT",
"disabled": false,
"desc": "朋友圈"
}
]
}
],
"name": "Common"
}
}
AddTextFeedback
接口说明:添加文案效果反馈
入参:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textId | Long | 是 | 文案ID | 123 |
content | String | 否 | 更新后的文案内容 | 123 |
quality | Integer | 否 | 反馈类型: 1-点赞 0-踩 | 1 |
出参
参数名称 | 类型 | 说明 | 示例值 |
requestId | String | 接口请求request | xxx |
success | Boolean | 请求结果 | true |
CountText
接口说明:统计文案数量
入参:
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
style | String | 否 | 文案风格
| RED_BOOK |
publishStatus | String | 否 | 发布状态
| DRAFT |
generationSource | String | 否 | 生成来源
| API |
industry | String | 否 | 行业 | Car |
出参
参数名称 | 类型 | 说明 | 示例值 |
count | Long | 数量 | 11 |
theme | String | 主题名称 | ATTRACTION_TICKET |
附录
行业信息枚举
Car: 汽车行业
Common: 通用行业
CulturalTour: 文旅行业
Garment: 运动户外行业
Internet: 互联网工具行业
RED_BOOK : 小红书
WECHAT_MOMENT :朋友圈
TIKTOK :抖音
ZHIHU :知乎
QIWEI_TEXT :企微话术
VIDEO_SCRIPT :视频脚本
SDK下载及更新
PHP
接入参考
require 'vendor/autoload.php';
use AlibabaCloud\SDK\Imarketing\V20220704\Models\GetOssUploadSignatureRequest;
use AlibabaCloud\SDK\IntelligentCreation\V20240313\IntelligentCreation;
use Darabonba\OpenApi\Models\Config as AlibabaConfig;
$config = new AlibabaConfig();
$config->accessKeyId = '****';
$config->accessKeySecret = '****';
$config->endpoint = "intelligentcreation.cn-zhangjiakou.aliyuncs.com";
$intelligentCreationClient = new IntelligentCreation($config);
// GetOssUploadToken 接口示例
$request = new GetOssUploadSignatureRequest();
$request->fileName = 'xxx.png';
$request->fileType = "ProductImage";
try {
$response = $intelligentCreationClient->getOssUploadToken($request);
var_dump($response->toMap());
} catch (TeaError $e) {
Log::error($e);
}
2.2.0
u-a4bf8c7a-c6fd-42d3-94af-d52e9f095a56-composer-tea.zip
composer require alibabacloud/intelligentcreation-20240313 2.2.0
2.1.4
u-ce29b5c7-8a37-4590-98f4-71a02e5366f9-composer-tea.zip
composer require -W alibabacloud/intelligentcreation-20240313 2.1.4
2.0.2
u-cf800400-f94e-495b-ac5f-404e4fbc2f5a-composer-tea.zip
composer require alibabacloud/intelligentcreation-20240313 2.0.2
2.0.0
u-b27117b1-7af9-4255-a725-1cd2b688a921-composer-tea.zip
composer require alibabacloud/intelligentcreation-20240313 2.0.0
1.0.0
u-7e0b8929-6999-4650-bf07-6d757195633b-composer-tea.zip
composer require alibabacloud/intelligentcreation-20240313 1.0.0
Java
接入参考
package com.aliyun;
import com.aliyun.intelligentcreation20240313.Client;
import com.aliyun.intelligentcreation20240313.models.GetOssUploadTokenRequest;
import com.aliyun.intelligentcreation20240313.models.GetOssUploadTokenResponse;
import com.aliyun.intelligentcreation20240313.models.UploadInfo;
import com.aliyun.teaopenapi.models.Config;
import java.util.HashMap;
import java.util.Map;
public class Test {
public static void main(String[] args) throws Exception {
//初始化配置
Config config = new Config().setAccessKeyId("test").setAccessKeySecret("test").setEndpoint("intelligentcreation.cn-zhangjiakou.aliyuncs.com");
// 创建客户端
Client client = new Client(config);
Map<String, Object> map = new HashMap<>();
map.put("fileName","xxx.png");
map.put("fileType","ProductImage");
GetOssUploadTokenRequest request = GetOssUploadTokenRequest.build(map);
// 请求接口
GetOssUploadTokenResponse response = client.getOssUploadToken(request);
if (response.getStatusCode().equals(200)) {
System.out.println("请求成功");
UploadInfo uploadInfo = response.getBody().getUploadInfo();
System.out.println("请求出参:" + uploadInfo);
}
}
}
2.2.0
u-a4bf8c7a-c6fd-42d3-94af-d52e9f095a56-java-tea.zip
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>intelligentcreation20240313</artifactId>
<version>2.2.0</version>
</dependency>
2.1.0
u-ce29b5c7-8a37-4590-98f4-71a02e5366f9-java-tea.zip
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>intelligentcreation20240313</artifactId>
<version>2.1.0</version>
</dependency>
2.0.2
u-cf800400-f94e-495b-ac5f-404e4fbc2f5a-java-tea.zip
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>intelligentcreation20240313</artifactId>
<version>2.0.2</version>
</dependency>
GO
接入参考
import (
"fmt"
"strings"
facebody "github.com/alibabacloud-go/facebody-20191230/client"
rpc "github.com/alibabacloud-go/tea-rpc/client"
util "github.com/alibabacloud-go/tea-utils/service"
credential "github.com/aliyun/credentials-go/credentials"
)
func main() {
config := new(rpc.Config)
// 使用 ak 初始化 config
config.SetAccessKeyId("ACCESS_KEY_ID").
SetAccessKeySecret("ACCESS_KEY_SECRET").
SetRegionId("cn-zhangjiakou").
SetEndpoint("intelligentcreation.cn-zhangjiakou.aliyuncs.com")
// 使用 credential 初始化 config
credentialConfig := &credential.Config{
AccessKeyId: config.AccessKeyId,
AccessKeySecret: config.AccessKeySecret,
SecurityToken: config.SecurityToken,
}
// 关于 credenial 的创建可以参考 https://github.com/aliyun/credentials-go/blob/master/README-CN.md
cred, err := credential.NewCredential(credentialConfig)
if err != nil {
panic(err)
}
config.SetCredential(cred).
SetEndpoint("intelligentcreation.cn-zhangjiakou.aliyuncs.com")
// 创建客户端
client, err := facebody.NewClient(config)
if err != nil {
panic(err)
}
// 初始化 runtimeObject
runtimeObject := new(util.RuntimeOptions).SetAutoretry(false).
SetMaxIdleConns(3)
// 初始化 request
request := new(facebody.DetectFaceRequest)
// 调用 api
resp, err := client.DetectFace(request, runtimeObject)
if err != nil {
fmt.Println(err.Error())
}
fmt.Println(resp)
}
SDK
go get github.com/alibabacloud-go/intelligentcreation-20240313/v2