图文生成openAPI

版本变更

概述

本产品中的基本概念如下：

接入认证

接入准备

1. 需要接入方提前准备阿里云账号，并利用阿里云子账号生成对应的AK/SK；

2. 阿里云主账号需要对生成AK/SK的子账号进行RAM授权；

3. 使用阿里云主账号登录平台，签署相关法务协议。

产品规格

API概览

本产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来。

通用接口

文案接口

配图接口

个性化文案接口

文案接口详情

InteractText

接口说明：营销互动文案创作

入参

出参

流式接口需要使用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

接口说明：文本接口流式输出内容

入参

出参

流式接口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

ReferenceTag:

出参：TextTaskResult

TextTask：

ReferenceTag:

生成模式-微信朋友圈调用模板

{
    "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

接口说明：获取文案任务

入参：

出参：TextTaskResult

TextTask：

GetText

接口说明：查看文案

入参：

出参：TextResult

Text：

ListTexts

接口说明：列举文案

入参：

出参：

ListTextThemes

接口说明：查询文案主题列表

入参：

出参：TextThemeListResult

TextTheme：

GetTextTemplate

接口说明：查询文本模板

入参：

出参：TextTemplateOpenResult

AvailableIndustryOpen：

AvailableTextModeTypeOpen：

AvailableTextStyleOpen：

{
        "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

接口说明：添加文案反馈

入参：

出参

CountText

接口说明：统计文案数量

入参：

出参

ListAgents

接口说明：查询智能体列表

入参：

出参：

AgentResult说明

配图接口详情

TransferPortraitStyle

接口说明：人物风格变化

入参

出参

CreateRealisticPortrait

接口说明：写实人像创作

入参

出参

SelectImageTask

接口说明：查询图片任务详情

入参

出参

图片信息

GetOssUploadToken

接口说明：获取oss上传签名

入参：GetOssUploadRequest

出参：UploadInfo

CreateIllustrationTask

接口说明：创建配图任务

入参：

IllustrationTaskCreateCmd：

出参：IllustrationTaskResult

IllustrationTask：

GetIllustrationTask

接口说明：查询配图任务

入参：

出参：IllustrationTaskResult

GetIllustration

接口说明：查询配图

入参：

出参：IllustrationResult

illustration：

个性化文案接口详情

1. 创建项目

API: CreateIndividuationProject

1.1. 入参

1.2. 出参

2. 删除项目

API: DeleteIndividuationProject

2.1. 入参

2.2. 出参

3. 创建文案任务

API: CreateIndividuationTextTask

3.1. 入参

同时进行中的任务，不能超过5个

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. 出参

4. 查询文案任务

API: QueryIndividuationTextTask

4.1. 入参

4.2. 出参

text

5. 批量查询文案内容

API: BatchQueryIndividuationText

5.1. 入参

5.2. 出参

Text对象

6. 删除文案

API: DeleteIndividuationText

6.1. 入参

6.2. 出参

附录

行业信息枚举

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