使用Python SDK调用AI写真的算法服务接口进行模型训练和写真制作。通过SDK，您可以定制LoRA模型，并根据模板制作写真。本文为您介绍使用Python SDK调用接口之前的准备工作以及使用示例。
前提条件
已准备好Python环境，环境依赖Python 3.4及其以上版本。
已准备好5-20张训练图片和1张模板图片，用于模型训练和写真制作。图片格式支持
.jpg、.jpeg、.png等。如果进行单人写真制作，模板图片中包含单张人脸即可。多张训练图片中的人脸属于同一个人。
如果进行多人写真制作，模板图片中需包含多张人脸，且人脸数量与模型训练的model_id数量一致。
请确保训练图片和模板图片的尺寸大于512×512像素。
准备工作
安装Python SDK，命令如下：
wget https://ai-service-data.oss-cn-beijing.aliyuncs.com/python-sdk/ai_service_python_sdk-1.1.3-py3-none-any.whl pip install ai_service_python_sdk-1.1.3-py3-none-any.whl初始化Client。
使用以下命令，进行环境初始化：
from ai_service_python_sdk.client.api_client import ApiClient client = ApiClient('<HOST>', '<YOUR-APPID>', '<YOUR-TOKEN>')您需要根据实际情况，替换以下参数值。
参数
描述
<HOST>
服务端地址：
http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com。<YOUR-APPID>
开通AI写真后，您可以直接在AI写真页面查看AppId。
<YOUR-TOKEN>
开通AI写真后，您可以直接在AI写真页面查看Token。
调用代码示例
AI写真是一个资源消耗量较大的服务，主要包括模型训练和写真制作两个环节。模型训练通常需要几分钟的响应时间，而写真制作则只需要数十秒即可完成。AI写真的接口调用流程图如下：
各个接口的请求、响应代码示例和端到端的请求代码示例如下：
核验请求（aigc_images_check）
请求代码示例如下：
from ai_service_python_sdk.client.api_client import ApiClient from ai_service_python_sdk.client.api.ai_service_aigc_images_api import AIGCImagesApi host = 'http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com' appId = 'YOUR-APPID' token = 'YOUR-TOKEN' client = ApiClient(host, appId, token) api = AIGCImagesApi(client) # noqa: E501 # 输入训练的图片，以URL形式存在。 images = [ 'https://xxx/0.jpg', 'https://xxx/1.jpg' ] response = api.aigc_images_check(images, <model_name>, <configure>) # 请求流水号。 request_id = response.request_id # 请求状态。 code = response.code # 请求状态具体信息。 message = response.message # 请求返回内容。 data = response.data # 打印返回结果。 print(response)参数说明如下：
参数
描述
appId
配置为在AI写真页面查到的AppId。
token
配置为在AI写真页面查到的Token。
images
配置为图片URL地址，多个URL地址使用半角逗号（,）分隔。
response
请分别为该参数配置下列输入值：
<model_name>：模型名称，默认输入空字符串，例如
''。<configure>：模型返回配置，默认为None，例如：
None。目前没有额外的配置。
响应结果示例如下：
{ "request_id":"07988c97-caa4-4512-a2b2-e9173c1a03c6", "code":"OK", "message":"success", "data":{ "check_results":[ { "code":1, "frontal":true, "message":"success", "url":"https://xxx/0.jpg" },{ "code":1, "frontal":false, "message":"success", "url":"https://xxx/1.jpg" } ], "cost_time":0.47095775604248047, "images":["https://xxx/0.jpg","https://xxx/1.jpg"], "request_id":"07988c97-caa4-4512-a2b2-e9173c1a03c6"}}返回结果中的各字段说明如下：
字段
描述
request_id
请求流水号，STRING类型。
code
请求状态码，STRING类型，取值如下：
OK：表示请求成功。
error：表示请求失败。
message
请求状态的详细信息。如果返回结果为success表示执行成功，对于其他返回结果，请根据具体的返回内容来确定。
data
返回内容详情，JSON Object类型。内部字段说明如下：
check_results：表示输入的每张图片的检测结果。每张图片对应一个字典，该字典一共有三个Key，分别为：
url：图片的URL地址。
message：图片检测详情。可能取值请参见check_results的message字段的可能取值。
frontal：图片中的人脸是否为正面。
cost_time：本次API调用花费的服务端计算时长。
images：核验的图片URL列表，List类型。
request_id：请求流水号，STRING类型。
模型发起训练（aigc_images_train）
请求代码示例如下：
from ai_service_python_sdk.client.api_client import ApiClient from ai_service_python_sdk.client.api.ai_service_aigc_images_api import AIGCImagesApi host = 'http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com' appId = 'YOUR-APPID' token = 'YOUR-TOKEN' client = ApiClient(host, appId, token) api = AIGCImagesApi(client) # noqa: E501 # 输入训练的图片，以URL形式存在。 images = [ 'https://xxx/0.jpg', 'https://xxx/1.jpg', 'https://xxx/2.jpg', 'https://xxx/3.jpg', 'https://xxx/4.jpg', 'https://xxx/5.jpg' ] response = api.aigc_images_train(images, <model_name>, <configure>) # 请求流水号。 request_id = response.request_id # 请求状态。 code = response.code # 请求状态具体信息。 message = response.message # 请求返回内容。 data = response.data # job id job_id = response.data['job_id'] # model_id model_id = response.data['model_id'] # 打印返回结果。 print(response)参数说明如下：
参数
描述
appId
配置为在AI写真页面查到的AppId。
token
配置为在AI写真页面查到的Token。
images
配置为训练模型使用的训练图片的URL地址，多个URL地址之间使用半角逗号（,）分隔。
response
请分别为该参数配置下列输入值：
<model_name>：模型名称，默认输入空字符串，例如
''。<configure>：模型返回配置，默认为None，例如：
None。目前没有额外的配置。
响应结果示例如下：
{'code': 'OK', 'data': {'job_id': 11***, 'model_id': 'fa4ba43a-df55-45a4-9c31-bb0dc1e5****'}, 'message': 'success', 'request_id': 'de314ef5-114d-4db1-b54a-332d5300780b'}返回结果中的各字段说明如下：
字段
描述
request_id
请求流水号，STRING类型。
code
请求状态码，STRING类型，取值如下：
OK：表示请求成功。
error：表示请求失败。
message
请求状态的详细信息。如果返回结果为success表示执行成功，对于其他返回结果，请根据具体的返回内容来确定。
data
返回内容详情，JSON Object类型。内部字段说明如下：
job_id：任务ID，INT类型。
model_id：本次模型训练的模型ID，是长度为36的字符串编码，STRING类型。
您需要将上述返回结果中的job_id和model_id保存到本地。 后续，您可以使用job_id查询训练结果，使用model_id发起写真制作服务请求。
训练结果查询（get_async_job）
请求代码示例如下：
from ai_service_python_sdk.client.api_client import ApiClient from ai_service_python_sdk.client.api.ai_service_job_api import AiServiceJobApi host = 'http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com' appId = 'YOUR-APPID' token = 'YOUR-TOKEN' client = ApiClient(host, appId, token) ai_service_job_api = AiServiceJobApi(client) # 结果查询。 result = ai_service_job_api.get_async_job(<YOUR-JOB-ID>) # 打印返回结果。 print(result)参数说明如下：
参数
描述
appId
配置为在AI写真页面查到的AppId。
token
配置为在AI写真页面查到的Token。
result
需要将<YOUR-JOB-ID>替换为模型发起训练（aigc_images_train）接口返回的job_id。
响应结果示例如下：
当模型训练未执行完成时，响应结果如下：
{'code': 'OK', 'data': {'job': {'Result': '', 'app_id': '2******6', 'create_time': '2023-08-22T16:43:35.36+08:00', 'id': 11***, 'message': 'model requesting', 'state': 1, 'type': 'Image'}}, 'message': 'success', 'request_id': '8639143a-e147-4107-8e25-fcdeae24b0c5'}当模型训练执行完成后，响应结果如下：
{'code': 'OK', 'data': {'job': {'Result': '{"cost_time":1589.0886301994324, "states": [{"code":1,"frontal":false,"message":"success","url":"xxx.jpg"}],"model_id":"fa4ba43a-df55-45a4-9c31-bb0dc1e5****"}', 'app_id': '2******6', 'create_time': '2023-08-22T15:54:41.046+08:00', 'id': 11***, 'message': 'success', 'state': 2, 'type': 'Image'}}, 'message': 'success', 'request_id': '93b77f4b-56cb-4120-b45b-f5c88941bff5'}
返回结果中的各字段说明如下：
参数
描述
request_id
请求流水号，STRING类型。
code
请求状态码，STRING类型。取值如下：
OK：表示请求成功。
error：表示请求失败。
message
请求状态的详细信息。如果返回结果为success，则表示执行成功，对于其他返回结果，请根据具体的返回内容来确定。
data
返回数据详情，JSON Object类型。内部字段说明如下：
训练错误码说明
请求服务错误码如下：
HTTP状态码
code
message
说明
400
PARAMETER_ERROR
not found appid
appId填写错误。
EXCEEDED_QUOTA_ERROR
exceeded quota
该账户的调用次数额度已用完。
401
PARAMETER_ERROR
sign error
token填写错误。
404
PARAMETER_ERROR
model not found
对应的模型服务未部署。
结果查询错误码如下：
HTTP状态码
code
message
说明
462
error
Invalid input data
输⼊数据解析错误。
Image not provided
未提供训练图⽚。
Make dir in oss Error
创建OSS⽂件夹失败，请检查是否挂载OSS。
Image process error
图像预处理出错。
469
error
Training - Not get best template image
训练异常退出导致没有⽣成参考图⽚。
Training - Not get lora weight
训练异常退出导致没有⽣成LoRA的权重。
写真制作
请求代码示例如下：
单人写真制作请求接口（aigc_images_create）
import base64 import cv2 import numpy as np from ai_service_python_sdk.client.api.ai_service_aigc_images_api import \ AIGCImagesApi # noqa: E501 from ai_service_python_sdk.client.api_client import ApiClient def decode_image_from_base64jpeg(base64_image): image_bytes = base64.b64decode(base64_image) np_arr = np.frombuffer(image_bytes, np.uint8) image = cv2.imdecode(np_arr, cv2.IMREAD_COLOR) return image host = "http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com" appId = 'YOUR-APPID' token = 'YOUR-TOKEN' client = ApiClient(host, appId, token) api = AIGCImagesApi(client) # noqa: E501 response = api.aigc_images_create( '<Your-Model-ID>', '<url>', '<model_name>', <configure> ) # 请求流水号。 request_id = response.request_id # 请求状态。 code = response.code # 请求状态具体信息。 message = response.message # 请求返回内容。 data = response.data print(response) image = data['image'] image = decode_image_from_base64jpeg(image) cv2.imwrite("1.jpg", image) print(data['cost_time'])参数说明如下：
参数
描述
appId
配置为在AI写真页面查到的AppId。
token
配置为在AI写真页面查到的Token。
response
请分别为该参数配置下列输入值：
<Your-Model-ID>：替换为模型发起训练（aigc_images_train）接口返回的model_id。
<url>：替换为模板图片的URL路径，该图片包含单张人脸。例如
https://xxx/single_template.jpg。<model_name>：模型名称，默认输入空字符串，例如
''。<configure>：模型返回配置，默认为None，例如：
None。内部字段说明，请参见configure内部字段说明。
多人写真制作请求接口（aigc_images_create_by_multi_model_ids）
import base64 import cv2 import numpy as np from ai_service_python_sdk.client.api.ai_service_aigc_images_api import \ AIGCImagesApi # noqa: E501 from ai_service_python_sdk.client.api_client import ApiClient def decode_image_from_base64jpeg(base64_image): image_bytes = base64.b64decode(base64_image) np_arr = np.frombuffer(image_bytes, np.uint8) image = cv2.imdecode(np_arr, cv2.IMREAD_COLOR) return image host = "http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com" appId = 'YOUR-APPID' token = 'YOUR-TOKEN' client = ApiClient(host, appId, token) api = AIGCImagesApi(client) # noqa: E501 response = api.aigc_images_create_by_multi_model_ids( ['<Your-Model-ID1>', '<Your-Model-ID2>'], '<url>', '<model_name>', <configure> ) # 请求流水号。 request_id = response.request_id # 请求状态。 code = response.code # 请求状态具体信息。 message = response.message # 请求返回内容。 data = response.data print(response) image = data['image'] image = decode_image_from_base64jpeg(image) cv2.imwrite("1.jpg", image) print(data['cost_time'])参数说明如下：
参数
描述
appId
配置为在AI写真页面查到的AppId。
token
配置为在AI写真页面查到的Token。
response
请在该参数中分别配置以下传入的值：
<Your-Model-ID1>和<Your-Model-ID2>：分别替换为模型发起训练（aigc_images_train）接口返回的model_id。
<url>：替换为模板图片的URL路径，该图片包含多张人脸，且人脸数量和所给的Model_id一致。例如
http://xxx/multi_template.jpg。<model_name>：模型名称，默认输入空字符串，例如
''。<configure>：模型返回配置，默认为None，例如：
None。内部字段说明，请参见configure内部字段说明。
响应结果示例如下：
{ 'code': 'OK', 'data': { 'cost_time': 21.705406427383423, 'image': '/9j/4AAQSkZJRgABAQAAAQABAAD/.............2wBDAAgGBgcGBQgHBwcJCQgK', 'model_id': 'fa4ba43a-df55-45a4-9c31-bb0dc1e5****' }, 'message': 'success', 'request_id': 'df5454ca-07ec-4a15-be50-7beaba42f36b' }返回结果中的各字段说明如下：
字段
描述
request_id
请求流水号，STRING类型。
code
请求状态码：
OK：表示请求成功。
error：表示请求失败。
message
请求状态的详细信息。如果返回结果为success表示执行成功，对于其他返回结果，请根据具体的返回内容来确定。
data
返回内容详情，JSON Object类型。内部字段说明如下：
model_id：用户的模型ID。
image：生成AI写真的参考模板图片，Base64编码。
cost_time：写真制作消耗的时间，FLOAT类型。
相关错误码说明
请求服务错误码如下：
HTTP状态码
code
message
说明
400
PARAMETER_ERROR
not found appid
appId填写错误。
EXCEEDED_QUOTA_ERROR
exceeded quota
该账户的调用次数额度已用完。
401
PARAMETER_ERROR
sign error
token填写错误。
404
PARAMETER_ERROR
model not found
对应的模型服务未部署。
结果查询错误码如下：
HTTP状态码
code
message
说明
462
error
Invalid input data. Please check the input dict.
输⼊数据解析错误。
mage not provided. Please check the template_image.
未提供写真制作的模板图⽚。
Prompts get error. Please check the model_id.
请检查提供的model_id格式。
Roop image decord error. Pleace check the user's lora is trained or not.
Roop图片不存在，请检查是否已经完成模型训练。
Template image decord error. Please Give a new template.
模板图片解码错误，请提供⼀张新的模板图片。
There is not face in template. Please Give a new template.
模板图像不存在⼈脸，请提供一个新的模板图片。
Template image process error. Please Give a new template.
模板图⽚预处理错误，请提供⼀张新的模板图片。
469
error
First Face Fusion Error, Can't get face in template image.
第⼀次⼈脸融合出错。
First Stable Diffusion Process error. Check the webui status.
第⼀次Stable Diffusion处理出错。
Second Face Fusion Error, Can't get face in template image.
第⼆次⼈脸融合出错。
Second Stable Diffusion Process error. Check the webui status.
第⼆次Stable Diffusion处理出错。
Please confirm if the number of faces in the template corresponds to the user ID.
请检查所给的model_id数量与人脸数量是否相符。
Third Stable Diffusion Process error. Check the webui status.
背景处理出错，请更换模板。
500
error
Face id image decord error. Pleace check the user's lora is trained or not.
用户上传的图片解码异常，请检查是否已经完成模型训练。
端到端流程示例代码
端到端流程的代码示例如下。当代码执行成功后，会在当前目录生成AI写真制作图片。
from ai_service_python_sdk.client.api_client import ApiClient
from ai_service_python_sdk.client.api.ai_service_aigc_images_api import AIGCImagesApi
from ai_service_python_sdk.client.api.ai_service_job_api import AiServiceJobApi
import logging
import sys
import time
import base64
import cv2
import numpy as np
host = "http://ai-service.ce8cc13b6421545749e7b4605f3d02607.cn-hangzhou.alicontainer.com"
appId = 'YOUR-APPID'
token = 'YOUR-TOKEN'
def decode_image_from_base64jpeg(base64_image):
image_bytes = base64.b64decode(base64_image)
np_arr = np.frombuffer(image_bytes, np.uint8)
image = cv2.imdecode(np_arr, cv2.IMREAD_COLOR)
return image
def Check(client, images):
# 核验请求。
response = api.aigc_images_check(images, '', None)
# 请求流水号。
request_id = response.request_id
# 请求状态。
code = response.code
# 请求状态具体信息。
message = response.message
# 请求返回内容。
data = response.data
# 打印返回结果。
if code != "OK":
logging.error(f"aigc_images_check failed,request id is {request_id}")
logging.error(message)
sys.exit(-1)
else:
for check_result in data['check_results']:
if check_result['code'] != 1:
logging.error(f"check {check_result['url']} failed, message is {check_result['message']}")
sys.exit(-1)
logging.info("check images done")
def Train(client, images):
# 训练请求。
response = api.aigc_images_train(images, '', None)
request_id = response.request_id
code = response.code
message = response.message
data = response.data
# 打印返回结果。
if code != "OK":
logging.error(f"aigc_images_train failed, request id is {request_id}")
logging.error(message)
sys.exit(-1)
else:
# job id
job_id = response.data['job_id']
# model_id
model_id = response.data['model_id']
logging.info(f"train job_id is {job_id}")
logging.info(f"train moded_id is {model_id}")
if isinstance(job_id, int):
while True:
ai_service_job_api = AiServiceJobApi(client)
response = ai_service_job_api.get_async_job(job_id)
request_id = response.request_id
code = response.code
message = response.message
data = response.data
if code != "OK":
logging.error(f"get_async_job failed, request id is {request_id}")
logging.error(message)
sys.exit(-1)
else:
state = data["job"]["state"]
if state == 2:
logging.info(f"model {model_id} trained successfully")
break
elif state != 3:
logging.info(f"training model {model_id}")
time.sleep(10)
else:
logging.error(f"model {model_id} trained failed")
logging.error(f"message: {message}")
break
if state != 2:
sys.exit(-1)
return model_id
def Create(model_id, template_image):
# create image。
response = api.aigc_images_create(model_id, template_image,'', None)
# 请求流水号。
request_id = response.request_id
# 请求状态。
code = response.code
# 请求状态具体信息。
message = response.message
# 请求返回内容。
data = response.data
if code != "OK":
logging.error(f"aigc_images_create failed, model_id is {model_id}")
sys.exit(-1)
else:
image = data['image']
image = decode_image_from_base64jpeg(image)
cv2.imwrite("single_out.jpg", image)
logging.info(f"single create {data['cost_time']}")
def CreateMulti(model_ids, template_image):
response = api.aigc_images_create_by_multi_model_ids(
model_ids,
template_image,
'', None
)
# 请求流水号。
request_id = response.request_id
# 请求状态。
code = response.code
# 请求状态具体信息。
message = response.message
# 请求返回内容。
data = response.data
if code != "OK":
logging.error(f"aigc_images_create_by_multi_model_ids failed, model_id is {model_id}")
sys.exit(-1)
else:
image = data['image']
image = decode_image_from_base64jpeg(image)
cv2.imwrite("multi_out.jpg", image)
logging.info(f"multi create cost time {data['cost_time']}")
if __name__ == "__main__":
client = ApiClient(host, appId, token)
api = AIGCImagesApi(client) # noqa: E501
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
# 输入训练的图片，以URL形式存在。
images = [
'https://xxx/0.jpg',
'https://xxx/1.jpg',
'https://xxx/2.jpeg',
'https://xxx/3.jpeg',
]
#check
Check(client, images)
model_id = Train(client, images)
template_image = 'https://xxx/single_template.jpg'
Create(model_id, template_image)
#read the image single_out.jpg
model_ids = [model_id, model_id]
multi_template_image = 'https://xxx/multi_template.jpg'
CreateMulti(model_ids, multi_template_image)
#read the image multi_out.jpg参数说明如下：
参数 | 描述 |
appId | 配置为在AI写真页面查到的AppId。 |
token | 配置为在AI写真页面查到的Token。 |
images | 配置为训练模型使用的图片URL地址，多个URL地址之间使用半角逗号（,）分隔。 |
template_image | 模板图片的URL地址，包含单张人脸。用于单人写真制作。 |
multi_template_image | 模板图片的URL地址，包含多张人脸，且人脸数量和所给的model_id一致。用于多人写真制作。 |