本文介绍图文生成、图文检索等API内容
版本变更
版本 | 描述 | 时间 |
v1.3 | 更新:
| 20250313 |
v1.2 | 更新: 1.创建配图任务接口新增参数:imageUrls, stickerText
| 20250120 |
v1.1 | 新增个性化文案接口, SDK版本更新 | 20241218 |
v1.0 | 更新接口:GetTextTask,GetText接口的Text对象新增errMsg字段 | 20241114 |
v0.9 | 新增接口:InteractText - 互动文案创作 | 20240929 |
v0.8 | 新增接口:QueryTextStream,TransferPortraitStyle,CreateRealisticPortrait,SelectImageTask 更新接口:CreateTextTask新增参数 - streamApi SDK版本更新 | 20240910 |
v0.7 | ListTexts支持搜索关键词,新增统计接口 | 20240731 |
v0.6 | 新增“获取行业对应风格接口”,“更新文案回调接口” | 20240715 |
v0.5 | SDK版本升级 | 20240617 |
v0.4 | GetTextTask接口出参新增Texts相关数据 | 20240605 |
v0.3 | 1.CreateTextTask入参新增智能体id 2.CreateTextTask,GetTextTask, GetText, ListTexts出参新增智能体id,智能体名称 | 20240603 |
v0.2 |
| 2024-05-27 |
v0.1 | 功能发布 | 2024-03-20 |
概述
本产品中的基本概念如下:
概念 | 描述 |
文案任务 | 一个提交文案生成的任务,一个任务中可以要求生成多篇文案。 |
文案 | 一篇生成的具体文案。 |
配图任务 | 一个提交配图生成的任务,一个配图任务可以要求生成多张配图。 一个配图任务需要针对某一篇文案发起。 |
配图 | 一张生成的配图 |
接入认证
接入准备
需要接入方提前准备阿里云账号,并利用阿里云子账号生成对应的AK/SK;
阿里云主账号需要对生成AK/SK的子账号进行RAM授权;
使用阿里云主账号登录平台,签署相关法务协议。
产品规格
说明 | 规格 |
单次文案任务中生成文案数量上限 | 10 |
单篇文案支持挂载的配图任务数量上限 | 5 |
API概览
本产品中所有开放的API,按照功能目录分类,将API链接和API描述罗列出来。
通用接口
API | 描述 |
GetOssUploadToken | 获取oss上传签名 |
文案接口
API | 描述 |
InteractText | 营销互动文案创作 |
QueryTextStream | 文本接口流式输出内容 |
CreateTextTask | 创建文案任务 |
GetTextTask | 获取文案任务 |
GetText | 获取文案 |
ListTexts | 列举文案 |
ListTextThemes | 列举文案主题 |
GetTextTemplate | 获取行业对应风格 |
AddTextFeedback | 添加文案反馈 |
CountText | 统计文案数量 |
ListAgents | 查询智能体列表 |
配图接口
API | 描述 |
CreateIllustrationTask | 创建配图任务 |
GetIllustrationTask | 获取配图任务 |
GetIllustration | 获取配图 |
个性化文案接口
API | 描述 |
CreateIndividuationProject | 创建项目 |
DeleteIndividuationProject | 删除项目 |
CreateIndividuationTextTask | 创建文案任务 |
QueryIndividuationTextTask | 查询文案任务 |
BathQueryIndividuationText | 批量查询文案内容 |
DeleteIndividuationText | 删除文案 |
文案接口详情
InteractText
接口说明:营销互动文案创作
入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
agentId | String | 否,与sessionId二选一 | 智能体id,输入了agentId未输入sessionId则会创建一个新的会话 | 11 |
sessionId | String | 否,与agentId二选一 | 会话id,输入了sessionId则会根据当前会话的上下文进行问答 | 11 |
content | String | 是 | 对话内容 | 介绍一下旅游攻略 |
出参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
type | Int | 是 | 消息类型: 2 - 文案内容 3 - 错误信息 | 2 |
message | String | 否 | 消息内容 | 你好 |
sessionId | String | 否 | 会话id | 111 |
relatedImages | List<String> | 否 | 相关图片 url | |
relatedVideos | List<String> | 否 | 相关视频 url | |
end | Boolean | 否 | 是否输出结束 | true |
流式接口需要使用java异步SDK
InteractTextRequest request = InteractTextRequest.builder()
.agentId("1")
// .sessionId("1")
.content("测试").build();
ResponseIterable<InteractTextResponseBody> responseBodies = client.interactTextWithResponseIterable(request);
Gson gson = new Gson();
System.out.println("------------");
System.out.println(gson.toJson(request));
System.out.println();
for (InteractTextResponseBody responseBody : responseBodies) {
System.out.print(responseBody.getMessage());
if (responseBody.getEnd()) {
System.out.println("\n\n请求已经结束: sessionId=" + responseBody.getSessionId());
if (responseBody.getRelatedImages() != null && !responseBody.getRelatedImages().isEmpty()) {
System.out.println("相关图片:" + responseBody.getRelatedImages());
}
if (responseBody.getRelatedVideos() != null && !responseBody.getRelatedVideos().isEmpty()) {
System.out.println("相关视频:" + responseBody.getRelatedVideos());
}
break;
}
}
System.out.println();
System.out.println();
System.out.println();
System.out.println("-------------");
System.out.println(responseBodies.getHeaders());
QueryTextStream
接口说明:文本接口流式输出内容
入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textId | Long | 是 | 文案id | 329 |
出参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
type | Int | 是 | 消息类型: 0 - 心跳 1 - 文案标题 2 - 文案内容 3 - 错误信息 | 1 |
message | String | 否 | 消息内容 | 你好 |
index | Int | 否 | 文本序列 | 1 |
end | Boolean | 否 | 是否输出结束 | true |
流式接口java SDK需要使用java异步SDK
public static void main(String[] args) {
StaticCredentialProvider provider = StaticCredentialProvider.create(
Credential.builder()
.accessKeyId(ak)
.accessKeySecret(sk)
.build()
);
AsyncClient client = AsyncClient.builder()
.region("cn-hangzhou")
.credentialsProvider(provider)
.serviceConfiguration(Configuration.create()
.setSignatureVersion(SignatureVersion.V3)
)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setProtocol("HTTPS")
.setEndpointOverride(url)
)
.build();
QueryTextStreamRequest request = QueryTextStreamRequest.builder().textId(329L).build();
ResponseIterable<QueryTextStreamResponseBody> responseBodies = client.queryTextStreamWithResponseIterable(request);
for (QueryTextStreamResponseBody responseBody : responseBodies) {
if (responseBody.getType().equals(0)) {
// 心跳检测无需输出
continue;
}
if (responseBody.getType().equals(3)) {
// 异常信息,进行告警
break;
}
System.out.print(responseBody.getMessage());
if (responseBody.getEnd()) {
System.out.println("\n\n请求已经结束:" + responseBody.getType() + " -- " + responseBody.getIndex());
}
}
System.out.println();
System.out.println();
System.out.println();
System.out.println(responseBodies.getHeaders());
}
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 |
streamApi | Boolean | 否 | 是否流式输出 | true |
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 | |
errMsg | String | 错误信息 | 内容要求等输入信息不足,无法生成营销文案,请重新输入 |
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 | 描述 | 旅游路线 |
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 |
ListAgents
接口说明:查询智能体列表
入参:
参数名称 | 类型 | 是否必选 | 说明 |
status | Integer | 否 | 智能体状态: 0-已发布,1-构建中,2-待发布,3-构建失败 |
agentScene | String | 未填写智能体id时必填 | 智能体场景: text-营销文案, aiCoachPractice-对练智能体, digitalHuman-数字人智能对话 |
owner | String | 否 | 智能体所属: SYSTEM-系统,CUSTOMER-客户(默认值) |
agentId | String | 否 | 智能体id:精确查询,会使其它入参失效 |
pageNumber | Integer | 是 | 页码,默认1 |
pageSize | Integer | 是 | 分页大小,默认10 |
出参:
参数名称 | 类型 | 说明 | 示例值 |
list | Array | 智能体信息列表 | AgentResult |
success | Boolean | 请求是否成功 | true |
total | Integer | 总数量 | 100 |
requestId | String | 接口请求requestId | xxx |
AgentResult说明
参数名称 | 类型 | 说明 | 示例值 |
agentId | String | 智能体id | 111111 |
agentScene | String | 智能体场景: text-营销文案, aiCoachPractice-对练智能体, digitalHuman-数字人智能对话 | text |
agentName | String | 智能体名称 | 测试智能体 |
industry | String | 行业信息,详见附录 | Car |
textStyle | String | 文案风格,详见附录 | RED_BOOK |
enableInteraction | Integer | 互动文案状态: 1:内容文本, 2:互动文本, 3 内容+互动 | 1 |
viewer | String | 视角:Seller-卖家,User-用户 | User |
onlineSearch | Boolean | 联网搜索:true开启,false未开启 | true |
status | Integer | 智能体状态: 0-已发布,1-构建中,2-待发布,3-构建失败 | 1 |
charactersDescription | String | 详细描述 | 测试智能体描述 |
owner | String | 智能体所属: 客户 or 系统 | SYSTEM |
referenceUrl | String | 参考范文链接 |
配图接口详情
TransferPortraitStyle
接口说明:人物风格变化
入参
参数名称 | 类型 | 是否必填 | 说明 | 示例值 |
width | Integer | 是 | 图片宽度,最大2048 | 11 |
height | Integer | 是 | 图片高度,最大2048 | 22 |
imageUrl | String | 是 | 人像图片地址 | http |
style | Integer | 是 | 风格:0 - 卡通,1 - 国风, 2 - 水彩画 | 1 |
numbers | Integer | 是 | 生成数量,最大4 | 4 |
redrawAmplitude | Integer | 是 | 重绘幅度:范围0-50 | 10 |
出参
参数名称 | 类型 | 说明 | 示例值 |
taskId | String | 任务id | 11111 |
CreateRealisticPortrait
接口说明:写实人像创作
入参
参数名称 | 类型 | 是否必填 | 说明 | 示例值 |
ratio | String | 图片生成写实人像不填, 标签创建写实人像必填 | 比例:1:1 , 3:2 , 2:3 , 4:3 , 3:4 , 16:9, 9:16 , auto - 自由比例 | auto |
width | Integer | 是 | 图片宽度,最大2048 | 11 |
height | Integer | 是 | 图片高度,最大2048 | 22 |
numbers | Integer | 是 | 生成数量,最大4 | 1 |
imageUrl | String | 图片生成写实人像必填, 标签创建写实人像不填 | 参考图地址 | http |
gender | Integer | 是 | 性别:0-男,1-女 | 1 |
ages | List<Integer> | 是 | 年龄范围:最小1,最大100,年龄跨度不超过10 | [1,10] |
figure | Integer | 是 | 身材:0-瘦, 1-中, 2-胖 | 1 |
hairColor | Integer | 标签创建写实人像可选 | 发色:0-黑,1-棕,2-金,3-红,4-粉,5-栗,6-灰,7-白, | 0 |
hairstyle | Integer | 标签创建写实人像可选 | 发型:1-长发,2-短发 | 2 |
color | Integer | 否 | 肤色:0-黄,1-白,2-黑 | 2 |
face | List<Integer> | 标签创建写实人像可选 | 面部特征:0-戴眼镜,1-微笑 | [0,1] |
cloth | Integer | 标签创建写实人像可选 | 服装:1-西装,2-连衣裙,3-衬衫,4-白大褂 | 4 |
custom | String | 否 | 特殊要求:最多支持100个字 | 光头 |
出参
参数名称 | 类型 | 说明 | 示例值 |
taskId | String | 任务id | 11111 |
SelectImageTask
接口说明:查询图片任务详情
入参
参数名称 | 类型 | 是否必填 | 说明 | 示例值 |
taskId | String | 是 | 任务id | 11111 |
出参
参数名称 | 类型 | 说明 | 示例值 |
gmtCreate | Stiring | 提交时间:yyyy.MM.dd HH:mm:ss | |
scene | String | 任务场景: RealisticPortraitWithImage-图片写实人像创作,RealisticPortraitWithTag-标签写实人像创作,TransferPortraitStyle-人物风格变化 | 人物风格变化 |
status | String | 任务状态: Uncommit-待提交,InProgress-执行中,Failed-执行失败,Successed-执行成功 | Uncommit |
total | Integer | 总数量 | 3 |
failed | Integer | 失败数量 | 1 |
success | Integer | 成功数量 | 1 |
subtaskProcessing | Integer | 子任务处理中数量 | 1 |
errorMessage | String | 失败原因 | 异常 |
generationSource | String | 来源:API, PLATFORM | API |
imageInfos | List<Object> | 图片信息 |
图片信息
参数名称 | 类型 | 说明 | 示例值 |
gmtCreate | Stiring | 生成时间:yyyy.MM.dd HH:mm:ss | |
customImageUrl | String | 图片链接 | http |
imageW | Integer | 图片宽度 | 111 |
imageH | Integer | 图片高度 | 222 |
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 |
CreateIllustrationTask
接口说明:创建配图任务
入参:
参数名称 | 类型 | 是否必选 | 说明 |
textId | Long | 是 | 文件名称 |
body | obj | 是 | IllustrationTaskCreateCmd |
IllustrationTaskCreateCmd:
参数名称 | 类型 | 是否必选 | 说明 |
ossPaths | array | 否,与imageUrls二选一 | oss key 图片路径["1235/xxx.text","1235/xxxx2113.text"] |
imageUrls | array | 否,与ossPaths二选一 | http图片地址 ["http://image.com"] |
nums | Integer | 是 | 生成数量 |
stickerText | String | 是 | 花字, json格式:{"title":"标题","subTitle":"副标题","point":"亮点, 不同亮点通过\n分隔"} |
backgroundType | Integer | 是 | 0-不换背景,1-换背景 |
dstWidth | Integer | 是 | 生成图片宽度,范围[1-1920] |
dstHeight | Integer | 是 | 生成图片高度,范围[1-1920] |
出参: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 |
个性化文案接口详情
1. 创建项目
API: CreateIndividuationProject
1.1. 入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
projectName | String | 是 | 项目名称,不允许重复 | 测试项目 |
purpose | String | 是 | 项目目的 | 10月生日用户邀约 |
projectInfo | String | 是 | 项目信息,json(知识数据) | [] |
sceneId | String | 是 | 场景id | 1001 |
1.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
projectId | String | 项目id | 11 |
2. 删除项目
API: DeleteIndividuationProject
2.1. 入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
projectId | String | 是 | 项目id | 11 |
2.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
status | String | 删除结果:SUCCESS-成功, FAIL-失败 | SUCCESS |
desc | String | 结果描述:删除失败的原因 | 任务进行中不能删除 |
3. 创建文案任务
API: CreateIndividuationTextTask
3.1. 入参
同时进行中的任务,不能超过5个
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
projectId | String | 是 | 项目id | 11 |
taskName | String | 是 | 任务名称,不允许重复 | 测试人群包-1 |
crowdPack | Array | 是 | 人群信息,json格式,最多支持2000个人群信息 | 详见人群信息示例 |
3.1.1. 人群信息示例
[
[
"user_id",
"username",
"sex_name",
"city",
"birthday",
"height",
"age",
"consumer_behavior",
"purchase_time"
],
[
"123456",
"王**",
"男",
"杭州",
"1989/10",
"180",
"30",
"偏好服饰类目",
"2024/12/20"
]
]
3.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
taskId | String | 任务id | 11 |
4. 查询文案任务
API: QueryIndividuationTextTask
4.1. 入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
taskId | String | 是 | 任务id | 11 |
4.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
createTime | String | 创建时间(yyyy-MM-dd HH:mm:ss) | |
updateTime | String | 更新时间(yyyy-MM-dd HH:mm:ss) | |
status | Integer | 任务状态: 0 执行中,1 已完成 | 0 |
textList | Array | 文案信息(只有已完成的任务才有文案信息) |
text
参数名称 | 类型 | 说明 | 示例值 |
textId | String | 文案id | 11 |
userId | String | 对应用户标签的用户id | 11 |
status | Integer | 文案状态:0 生成中,1 成功,2 失败 | 0 |
5. 批量查询文案内容
API: BatchQueryIndividuationText
5.1. 入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textIdList | Array | 是 | 文案id集合,最多支持50个 | ["11","22"] |
5.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
textList | Array | 文案列表 |
Text对象
参数名称 | 类型 | 说明 | 示例值 |
content | String | 文案内容 | 测试文案 |
userId | String | 用户id | |
itemId | String | 商品id | 0 |
taskId | String | 任务id | |
projectId | String | 项目id | |
createTime | String | 创建时间(yyyy-MM-dd HH:mm:ss) | |
updateTime | String | 更新时间(yyyy-MM-dd HH:mm:ss) | |
status | Integer | 文案状态:0 生成中,1 成功,2 失败 | 0 |
errorMsg | String | 错误信息 | 账号信息不一致 |
6. 删除文案
API: DeleteIndividuationText
6.1. 入参
参数名称 | 类型 | 是否必选 | 说明 | 示例值 |
textIdList | Array | 是 | 文案id集合 |
6.2. 出参
参数名称 | 类型 | 说明 | 示例值 |
status | String | 删除结果:SUCCESS-成功, FAIL-失败 | SUCCESS |
desc | String | 结果描述:删除失败的原因 | 任务进行中不能删除 |
附录
行业信息枚举
Car: 汽车行业
Common: 通用行业
CulturalTour: 文旅行业
Garment: 运动户外行业
Internet: 互联网工具行业
RED_BOOK : 小红书
WECHAT_MOMENT :朋友圈
TIKTOK :抖音
ZHIHU :知乎
QIWEI_TEXT :企微话术
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.12.0
composer require alibabacloud/intelligentcreation-20240313 2.12.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.12.0
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>intelligentcreation20240313</artifactId>
<version>2.12.0</version>
</dependency>
Java异步
接入参考
public static void main(String[] args) {
StaticCredentialProvider provider = StaticCredentialProvider.create(
Credential.builder()
.accessKeyId(ak)
.accessKeySecret(sk)
.build()
);
AsyncClient client = AsyncClient.builder()
.region("cn-zhangjiakou")
.credentialsProvider(provider)
.serviceConfiguration(Configuration.create()
.setSignatureVersion(SignatureVersion.V3)
)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setProtocol("HTTPS")
.setEndpointOverride(url)
)
.build();
QueryTextStreamRequest request = QueryTextStreamRequest.builder().textId(329L).build();
ResponseIterable<QueryTextStreamResponseBody> responseBodies = client.queryTextStreamWithResponseIterable(request);
for (QueryTextStreamResponseBody responseBody : responseBodies) {
if (responseBody.getType().equals(0)) {
// 心跳检测无需输出
continue;
}
if (responseBody.getType().equals(3)) {
// 异常信息,进行告警
break;
}
System.out.print(responseBody.getMessage());
if (responseBody.getEnd()) {
System.out.println("\n\n请求已经结束:" + responseBody.getType() + " -- " + responseBody.getIndex());
}
}
System.out.println(responseBodies.getHeaders());
}
2.0.7
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>alibabacloud-intelligentcreation20240313</artifactId>
<version>2.0.7</version>
</dependency>
GO
接入参考
package main
import (
"fmt"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
intelligentcreation20240313 "github.com/alibabacloud-go/intelligentcreation-20240313/v2"
util "github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
)
func CreateClient() (_result *intelligentcreation20240313.Client, _err error) {
config := &openapi.Config{
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
// 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
}
config.Endpoint = tea.String("intelligentcreation.cn-zhangjiakou.aliyuncs.com")
_result = &intelligentcreation20240313.Client{}
_result, _err = intelligentcreation20240313.NewClient(config)
return _result, _err
}
func main() {
client, _err := CreateClient()
if _err != nil {
panic(_err)
}
queryIndividuationTextTaskRequest := &intelligentcreation20240313.QueryIndividuationTextTaskRequest{
// 文案任务id
TaskId: tea.String("1111"),
}
resp, tryErr := func() (response *intelligentcreation20240313.QueryIndividuationTextTaskResponse, _e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
// 复制代码运行请自行打印 API 的返回值
response, _err = client.QueryIndividuationTextTask(queryIndividuationTextTaskRequest)
if _err != nil {
return response, _err
}
return response, nil
}()
if tryErr != nil {
if sdkError, ok := tryErr.(*tea.SDKError); ok {
// 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
fmt.Println(tea.StringValue(sdkError.Message))
fmt.Println(tea.StringValue(sdkError.Code))
fmt.Println(tea.StringValue(sdkError.Data))
} else {
// 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
fmt.Println(tea.String(tryErr.Error()))
}
} else {
fmt.Println("Response:", resp) // 输出响应
}
}
SDK
go get github.com/alibabacloud-go/intelligentcreation-20240313/v2
- 本页导读 (0)
- 版本变更
- 概述
- 接入认证
- 接入准备
- 产品规格
- API概览
- 通用接口
- 文案接口
- 配图接口
- 个性化文案接口
- 文案接口详情
- InteractText
- 入参
- 出参
- QueryTextStream
- 入参
- 出参
- CreateTextTask
- GetTextTask
- GetText
- ListTexts
- ListTextThemes
- GetTextTemplate
- AddTextFeedback
- CountText
- ListAgents
- 配图接口详情
- TransferPortraitStyle
- 入参
- 出参
- CreateRealisticPortrait
- 入参
- 出参
- SelectImageTask
- 入参
- 出参
- GetOssUploadToken
- CreateIllustrationTask
- GetIllustrationTask
- GetIllustration
- 个性化文案接口详情
- 1. 创建项目
- 1.1. 入参
- 1.2. 出参
- 2. 删除项目
- 2.1. 入参
- 2.2. 出参
- 3. 创建文案任务
- 3.1. 入参
- 3.2. 出参
- 4. 查询文案任务
- 4.1. 入参
- 4.2. 出参
- 5. 批量查询文案内容
- 5.1. 入参
- 5.2. 出参
- 6. 删除文案
- 6.1. 入参
- 6.2. 出参
- 附录
- 行业信息枚举
- SDK下载及更新
- PHP
- 接入参考
- 2.12.0
- Java
- 接入参考
- 2.12.0
- Java异步
- 接入参考
- 2.0.7
- GO
- 接入参考