File size: 30,351 Bytes
cbc00ce | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
from typing import Any, Dict, List, Union
from dashscope.api_entities.dashscope_response import (
DashScopeAPIResponse,
ImageSynthesisResponse,
)
from dashscope.client.base_api import (
BaseAsyncApi,
BaseApi,
BaseAsyncAioApi,
BaseAioApi,
)
from dashscope.common.constants import IMAGES, NEGATIVE_PROMPT, PROMPT
from dashscope.common.error import InputRequired
from dashscope.common.utils import _get_task_group_and_task
from dashscope.utils.oss_utils import check_and_upload_local
class ImageSynthesis(BaseAsyncApi):
task = "text2image"
"""API for image synthesis.
"""
class Models:
wanx_v1 = "wanx-v1"
wanx_sketch_to_image_v1 = "wanx-sketch-to-image-v1"
wanx_2_1_imageedit = "wanx2.1-imageedit"
@classmethod
def call( # type: ignore[override]
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Call image(s) synthesis service and get result.
Args:
model (str): The model, reference ``Models``.
prompt (Any): The prompt for image(s) synthesis.
negative_prompt (Any): The negative_prompt. Defaults to None.
images (List[str]): The input list of images url,
currently not supported.
api_key (str, optional): The api api_key. Defaults to None.
sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1,
can be local file.
Defaults to None.
workspace (str): The dashscope workspace id.
extra_input (Dict): The extra input parameters.
task (str): The task of api, ref doc.
function (str): The specific functions to be achieved. like:
colorization,super_resolution,expand,remove_watermaker,doodle,
description_edit_with_mask,description_edit,stylization_local,stylization_all
base_image_url (str): Enter the URL address of the target edited image.
mask_image_url (str): Provide the URL address of the image of the marked area by the user. It should be consistent with the image resolution of the base_image_url. # pylint: disable=line-too-long
**kwargs:
n(int, `optional`): Number of images to synthesis.
size(str, `optional`): The output image(s) size(width*height).
similarity(float, `optional`): The similarity between the
output image and the input image
sketch_weight(int, optional): How much the input sketch
affects the output image[0-10], only for wanx-sketch-to-image-v1. # noqa E501
Default 10.
realisticness(int, optional): The realisticness of the output
image[0-10], only for wanx-sketch-to-image-v1. Default 5
Raises:
InputRequired: The prompt cannot be empty.
Returns:
ImageSynthesisResponse: The image(s) synthesis result.
"""
return super().call( # type: ignore[return-value]
model,
prompt,
negative_prompt,
images,
api_key=api_key,
sketch_image_url=sketch_image_url,
ref_img=ref_img,
workspace=workspace,
extra_input=extra_input,
task=task,
function=function,
mask_image_url=mask_image_url,
base_image_url=base_image_url,
**kwargs,
)
@classmethod
def sync_call(
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""
Note: This method currently now only supports wan2.2-t2i-flash and wan2.2-t2i-plus. # noqa: E501 # pylint: disable=line-too-long
Using other models will result in an error，More raw image models may be added for use later # pylint: disable=line-too-long
"""
task_group, f = _get_task_group_and_task(__name__)
inputs, kwargs, task = cls._get_input(
model,
prompt,
negative_prompt,
images,
api_key,
sketch_image_url,
ref_img,
extra_input,
task,
function,
mask_image_url,
base_image_url,
**kwargs,
)
response = BaseApi.call(
model,
inputs,
task_group,
task,
f,
api_key,
workspace,
**kwargs,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
def _get_input( # pylint: disable=too-many-branches
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
):
if prompt is None or not prompt:
raise InputRequired("prompt is required!")
inputs = {PROMPT: prompt}
has_upload = False
upload_certificate = None
if negative_prompt is not None:
inputs[NEGATIVE_PROMPT] = negative_prompt
if images is not None and images and len(images) > 0:
new_images = []
for image in images:
(
is_upload,
new_image,
upload_certificate,
) = check_and_upload_local(
model,
image,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload:
has_upload = True
new_images.append(new_image)
inputs[IMAGES] = new_images
if sketch_image_url is not None and sketch_image_url:
(
is_upload,
sketch_image_url,
upload_certificate,
) = check_and_upload_local(
model,
sketch_image_url,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload:
has_upload = True
inputs["sketch_image_url"] = sketch_image_url
if ref_img is not None and ref_img:
is_upload, ref_img, upload_certificate = check_and_upload_local(
model,
ref_img,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload:
has_upload = True
inputs["ref_img"] = ref_img
if function is not None and function:
inputs["function"] = function
if mask_image_url is not None and mask_image_url:
(
is_upload,
res_mask_image_url,
upload_certificate,
) = check_and_upload_local(
model,
mask_image_url,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload:
has_upload = True
inputs["mask_image_url"] = res_mask_image_url
if base_image_url is not None and base_image_url:
(
is_upload,
res_base_image_url,
upload_certificate,
) = check_and_upload_local(
model,
base_image_url,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload:
has_upload = True
inputs["base_image_url"] = res_base_image_url
if extra_input is not None and extra_input:
inputs = {**inputs, **extra_input}
if has_upload:
headers = kwargs.pop("headers", {})
headers["X-DashScope-OssResourceResolve"] = "enable"
kwargs["headers"] = headers
def __get_i2i_task(task, model) -> str:
# 处理task参数：优先使用有效的task值
if task is not None and task != "":
return task
# 根据model确定任务类型
if model is not None and model != "":
if "imageedit" in model or "wan2.5-i2i" in model:
return "image2image"
# 默认返回文本到图像任务
return ImageSynthesis.task
task = __get_i2i_task(task, model)
return inputs, kwargs, task
@classmethod
# type: ignore[override]
def async_call( # pylint: disable=arguments-renamed # type: ignore[override] # noqa: E501
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Create a image(s) synthesis task, and return task information.
Args:
model (str): The model, reference ``Models``.
prompt (Any): The prompt for image(s) synthesis.
negative_prompt (Any): The negative_prompt. Defaults to None.
images (List[str]): The input list of images url.
api_key (str, optional): The api api_key. Defaults to None.
sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1.
Defaults to None.
workspace (str): The dashscope workspace id.
extra_input (Dict): The extra input parameters.
task (str): The task of api, ref doc.
function (str): The specific functions to be achieved. like:
colorization,super_resolution,expand,remove_watermaker,doodle,
description_edit_with_mask,description_edit,stylization_local,stylization_all
base_image_url (str): Enter the URL address of the target edited image.
mask_image_url (str): Provide the URL address of the image of the marked area by the user. It should be consistent with the image resolution of the base_image_url. # pylint: disable=line-too-long
**kwargs(wanx-v1):
n(int, `optional`): Number of images to synthesis.
size: The output image(s) size, Default 1024*1024
similarity(float, `optional`): The similarity between the
output image and the input image.
sketch_weight(int, optional): How much the input sketch
affects the output image[0-10], only for wanx-sketch-to-image-v1. # noqa E501
Default 10.
realisticness(int, optional): The realisticness of the output
image[0-10], only for wanx-sketch-to-image-v1. Default 5
Raises:
InputRequired: The prompt cannot be empty.
Returns:
DashScopeAPIResponse: The image synthesis
task id in the response.
"""
task_group, f = _get_task_group_and_task(__name__)
inputs, kwargs, task = cls._get_input(
model,
prompt,
negative_prompt,
images,
api_key,
sketch_image_url,
ref_img,
extra_input,
task,
function,
mask_image_url,
base_image_url,
**kwargs,
)
response = super().async_call(
model=model,
task_group=task_group,
task=task,
function=f,
api_key=api_key,
input=inputs,
workspace=workspace,
**kwargs,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
def fetch( # type: ignore[override]
cls,
task: Union[str, ImageSynthesisResponse],
api_key: str = None,
workspace: str = None,
) -> ImageSynthesisResponse:
"""Fetch image(s) synthesis task status or result.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
ImageSynthesisResponse: The task status or result.
"""
response = super().fetch(task, api_key=api_key, workspace=workspace)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
def wait( # type: ignore[override]
cls,
task: Union[str, ImageSynthesisResponse],
api_key: str = None,
workspace: str = None,
) -> ImageSynthesisResponse:
"""Wait for image(s) synthesis task to complete, and return the result.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
ImageSynthesisResponse: The task result.
"""
response = super().wait(task, api_key, workspace=workspace)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
def cancel( # type: ignore[override]
cls,
task: Union[str, ImageSynthesisResponse],
api_key: str = None,
workspace: str = None,
) -> DashScopeAPIResponse:
"""Cancel image synthesis task.
Only tasks whose status is PENDING can be canceled.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The response data.
"""
return super().cancel(task, api_key, workspace=workspace)
@classmethod
def list(
cls,
start_time: str = None,
end_time: str = None,
model_name: str = None,
api_key_id: str = None,
region: str = None,
status: str = None,
page_no: int = 1,
page_size: int = 10,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""List async tasks.
Args:
start_time (str, optional): The tasks start time,
for example: 20230420000000. Defaults to None.
end_time (str, optional): The tasks end time,
for example: 20230420000000. Defaults to None.
model_name (str, optional): The tasks model name. Defaults to None.
api_key_id (str, optional): The tasks api-key-id. Defaults to None.
region (str, optional): The service region,
for example: cn-beijing. Defaults to None.
status (str, optional): The status of tasks[PENDING,
RUNNING, SUCCEEDED, FAILED, CANCELED]. Defaults to None.
page_no (int, optional): The page number. Defaults to 1.
page_size (int, optional): The page size. Defaults to 10.
api_key (str, optional): The user api-key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The response data.
"""
return super().list(
start_time=start_time,
end_time=end_time,
model_name=model_name,
api_key_id=api_key_id,
region=region,
status=status,
page_no=page_no,
page_size=page_size,
api_key=api_key,
workspace=workspace,
**kwargs,
)
class AioImageSynthesis(BaseAsyncAioApi):
# type: ignore[override]
@classmethod
async def call( # type: ignore[override] # pylint: disable=arguments-renamed # noqa: E501
# type: ignore[override]
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Call image(s) synthesis service and get result.
Args:
model (str): The model, reference ``Models``.
prompt (Any): The prompt for image(s) synthesis.
negative_prompt (Any): The negative_prompt. Defaults to None.
images (List[str]): The input list of images url,
currently not supported.
api_key (str, optional): The api api_key. Defaults to None.
sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1,
can be local file.
Defaults to None.
workspace (str): The dashscope workspace id.
extra_input (Dict): The extra input parameters.
task (str): The task of api, ref doc.
function (str): The specific functions to be achieved. like:
colorization,super_resolution,expand,remove_watermaker,doodle,
description_edit_with_mask,description_edit,stylization_local,stylization_all
base_image_url (str): Enter the URL address of the target edited image.
mask_image_url (str): Provide the URL address of the image of the marked area by the user. It should be consistent with the image resolution of the base_image_url. # pylint: disable=line-too-long
**kwargs:
n(int, `optional`): Number of images to synthesis.
size(str, `optional`): The output image(s) size(width*height).
similarity(float, `optional`): The similarity between the
output image and the input image
sketch_weight(int, optional): How much the input sketch
affects the output image[0-10], only for wanx-sketch-to-image-v1. # noqa E501
Default 10.
realisticness(int, optional): The realisticness of the output
image[0-10], only for wanx-sketch-to-image-v1. Default 5
Raises:
InputRequired: The prompt cannot be empty.
Returns:
ImageSynthesisResponse: The image(s) synthesis result.
"""
task_group, f = _get_task_group_and_task(__name__)
# pylint: disable=protected-access
inputs, kwargs, task = ImageSynthesis._get_input(
model,
prompt,
negative_prompt,
images,
api_key,
sketch_image_url,
ref_img,
extra_input,
task,
function,
mask_image_url,
base_image_url,
**kwargs,
)
response = await super().call(
model,
inputs,
task_group,
task,
f,
api_key,
workspace,
**kwargs,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
async def sync_call(
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""
Note: This method currently now only supports wan2.2-t2i-flash and wan2.2-t2i-plus. # noqa: E501 # pylint: disable=line-too-long
Using other models will result in an error，More raw image models may be added for use later # pylint: disable=line-too-long
"""
task_group, f = _get_task_group_and_task(__name__)
# pylint: disable=protected-access
inputs, kwargs, task = ImageSynthesis._get_input(
model,
prompt,
negative_prompt,
images,
api_key,
sketch_image_url,
ref_img,
extra_input,
task,
function,
mask_image_url,
base_image_url,
**kwargs,
)
response = await BaseAioApi.call(
model,
inputs,
task_group,
task,
f,
api_key,
workspace,
**kwargs,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
async def async_call( # type: ignore[override] # pylint: disable=arguments-renamed # noqa: E501
cls,
model: str,
prompt: Any,
negative_prompt: Any = None,
images: List[str] = None,
api_key: str = None,
sketch_image_url: str = None,
ref_img: str = None,
workspace: str = None,
extra_input: Dict = None,
task: str = None,
function: str = None,
mask_image_url: str = None,
base_image_url: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Create a image(s) synthesis task, and return task information.
Note: This method overrides BaseAsyncAioApi.async_call() with
renamed parameters to provide a more user-friendly API. The
generic parameters (input_data, task_group) are replaced with
domain-specific ones (prompt, negative_prompt, images, etc.).
Pylint's arguments-renamed warning is disabled for this reason.
Args:
model (str): The model, reference ``Models``.
prompt (Any): The prompt for image(s) synthesis.
negative_prompt (Any): The negative_prompt. Defaults to None.
images (List[str]): The input list of images url.
api_key (str, optional): The api api_key. Defaults to None.
sketch_image_url (str, optional): Only for wanx-sketch-to-image-v1.
Defaults to None.
workspace (str): The dashscope workspace id.
extra_input (Dict): The extra input parameters.
task (str): The task of api, ref doc.
function (str): The specific functions to be achieved. like:
colorization,super_resolution,expand,remove_watermaker,doodle,
description_edit_with_mask,description_edit,stylization_local,stylization_all
base_image_url (str): Enter the URL address of the target edited image.
mask_image_url (str): Provide the URL address of the image of the marked area by the user. It should be consistent with the image resolution of the base_image_url. # pylint: disable=line-too-long
**kwargs(wanx-v1):
n(int, `optional`): Number of images to synthesis.
size: The output image(s) size, Default 1024*1024
similarity(float, `optional`): The similarity between the
output image and the input image.
sketch_weight(int, optional): How much the input sketch
affects the output image[0-10], only for wanx-sketch-to-image-v1. # noqa E501
Default 10.
realisticness(int, optional): The realisticness of the output
image[0-10], only for wanx-sketch-to-image-v1. Default 5
Raises:
InputRequired: The prompt cannot be empty.
Returns:
DashScopeAPIResponse: The image synthesis
task id in the response.
"""
task_group, f = _get_task_group_and_task(__name__)
# pylint: disable=protected-access
inputs, kwargs, task = ImageSynthesis._get_input(
model,
prompt,
negative_prompt,
images,
api_key,
sketch_image_url,
ref_img,
extra_input,
task,
function,
mask_image_url,
base_image_url,
**kwargs,
)
response = await super().async_call(
model,
inputs,
task_group,
task,
f,
api_key,
workspace,
**kwargs,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
async def fetch(
cls,
task: Union[str, ImageSynthesisResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Fetch image(s) synthesis task status or result.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
ImageSynthesisResponse: The task status or result.
"""
response = await super().fetch(
task,
api_key=api_key,
workspace=workspace,
)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
async def wait(
cls,
task: Union[str, ImageSynthesisResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> ImageSynthesisResponse:
"""Wait for image(s) synthesis task to complete, and return the result.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
ImageSynthesisResponse: The task result.
"""
response = await super().wait(task, api_key, workspace=workspace)
return ImageSynthesisResponse.from_api_response(response)
@classmethod
async def cancel(
cls,
task: Union[str, ImageSynthesisResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Cancel image synthesis task.
Only tasks whose status is PENDING can be canceled.
Args:
task (Union[str, ImageSynthesisResponse]): The task_id or
ImageSynthesisResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The response data.
"""
return await super().cancel(task, api_key, workspace=workspace)
@classmethod
async def list(
cls,
start_time: str = None,
end_time: str = None,
model_name: str = None,
api_key_id: str = None,
region: str = None,
status: str = None,
page_no: int = 1,
page_size: int = 10,
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""List async tasks.
Args:
start_time (str, optional): The tasks start time,
for example: 20230420000000. Defaults to None.
end_time (str, optional): The tasks end time,
for example: 20230420000000. Defaults to None.
model_name (str, optional): The tasks model name. Defaults to None.
api_key_id (str, optional): The tasks api-key-id. Defaults to None.
region (str, optional): The service region,
for example: cn-beijing. Defaults to None.
status (str, optional): The status of tasks[PENDING,
RUNNING, SUCCEEDED, FAILED, CANCELED]. Defaults to None.
page_no (int, optional): The page number. Defaults to 1.
page_size (int, optional): The page size. Defaults to 10.
api_key (str, optional): The user api-key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The response data.
"""
return await super().list(
start_time=start_time,
end_time=end_time,
model_name=model_name,
api_key_id=api_key_id,
region=region,
status=status,
page_no=page_no,
page_size=page_size,
api_key=api_key,
workspace=workspace,
**kwargs,
)
|