File size: 23,025 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 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
from typing import Generator, List, Union, AsyncGenerator
from dashscope.api_entities.dashscope_response import (
Message,
DashScopeAPIResponse,
ImageGenerationResponse,
)
from dashscope.client.base_api import (
BaseAioApi,
BaseApi,
BaseAsyncApi,
BaseAsyncAioApi,
)
from dashscope.common.error import InputRequired, ModelRequired
from dashscope.common.utils import _get_task_group_and_task
from dashscope.utils.oss_utils import preprocess_message_element
from dashscope.utils.param_utils import ParamUtil
from dashscope.utils.message_utils import merge_single_response
class ImageGeneration(BaseApi, BaseAsyncApi):
sync_task = "multimodal-generation"
async_task = "image-generation"
function = "generation"
"""API for AI-Generated Content(AIGC) models.
"""
class Models:
wan2_6_image = "wan2.6-image"
wan2_6_t2i = "wan2.6-t2i"
@classmethod
def call( # type: ignore[override]
cls,
model: str,
api_key: str = None,
messages: List[Message] = None,
workspace: str = None,
**kwargs,
) -> Union[
ImageGenerationResponse,
Generator[ImageGenerationResponse, None, None],
]:
"""Call generation model service.
Args:
model (str): The requested model
api_key (str, optional): The api api_key, can be None,
if None, will get by default rule(TODO: api key doc).
messages (list): The generation messages.
examples:
[{'role': 'user',
'content': 'The weather is fine today.'},
{'role': 'assistant', 'content': 'Suitable for outings'}]
**kwargs:
stream(bool, `optional`): Enable server-sent events
(ref: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) # noqa E501 # pylint: disable=line-too-long
the result will back partially[qwen-turbo,bailian-v1].
workspace (str): The dashscope workspace id.
Raises:
InvalidInput: The history and auto_history are mutually exclusive.
Returns:
Union[ImageGenerationResponse,
Generator[ImageGenerationResponse, None, None]]: If
stream is True, return Generator, otherwise ImageGenerationResponse.
"""
if messages is None or not messages:
raise InputRequired("messages is required!")
if model is None or not model:
raise ModelRequired("Model is required!")
task_group, _ = _get_task_group_and_task(__name__)
_input = {}
if messages is not None and messages:
has_upload = cls._preprocess_messages(model, messages, api_key) # type: ignore[arg-type] # pylint: disable=line-too-long # noqa: E501
if has_upload:
headers = kwargs.pop("headers", {})
headers["X-DashScope-OssResourceResolve"] = "enable"
kwargs["headers"] = headers
_input.update({"messages": messages})
# Check if we need to merge incremental output
is_incremental_output = kwargs.get("incremental_output", None)
is_stream = kwargs.get("stream", False)
to_merge_incremental_output = False
if (
ParamUtil.should_modify_incremental_output(model)
and is_stream
and is_incremental_output is not None
and is_incremental_output is False
):
to_merge_incremental_output = True
kwargs["incremental_output"] = True
# Pass incremental_to_full flag via headers user-agent
if "headers" not in kwargs:
kwargs["headers"] = {}
flag = "1" if to_merge_incremental_output else "0"
kwargs["headers"]["user-agent"] = f"incremental_to_full/{flag}"
if kwargs.get("is_async", False):
kwargs["headers"]["X-DashScope-Async"] = "enable"
task = cls.async_task
else:
task = cls.sync_task
response = super().call(
model=model,
task_group=task_group,
task=task,
function=ImageGeneration.function,
api_key=api_key,
input=_input,
workspace=workspace,
**kwargs,
)
if is_stream:
if to_merge_incremental_output:
# Extract n parameter for merge logic
n = kwargs.get("n", 1)
return cls._merge_generation_response(response, n)
else:
return (
ImageGenerationResponse.from_api_response(rsp)
for rsp in response
)
else:
return ImageGenerationResponse.from_api_response(response)
@classmethod
def async_call( # type: ignore[override]
cls,
model: str,
api_key: str = None,
messages: List[Message] = None,
workspace: str = None,
**kwargs,
) -> Union[
ImageGenerationResponse,
Generator[ImageGenerationResponse, None, None],
]:
kwargs["is_async"] = True
return cls.call(model, api_key, messages, workspace, **kwargs)
@classmethod
def fetch(
cls,
task: Union[str, ImageGenerationResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Fetch image(s) synthesis task status or result.
Args:
task (Union[str, ImageGenerationResponse]): The task_id or
ImageGenerationResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The task status or result.
"""
response = super().fetch(task, api_key=api_key, workspace=workspace)
return ImageGenerationResponse.from_api_response(response)
@classmethod
def wait(
cls,
task: Union[str, ImageGenerationResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Wait for image(s) synthesis task to complete, and return the result.
Args:
task (Union[str, ImageGenerationResponse]): The task_id or
ImageGenerationResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The task result.
"""
response = super().wait(task, api_key, workspace=workspace)
return ImageGenerationResponse.from_api_response(response)
@classmethod
def cancel(
cls,
task: Union[str, ImageGenerationResponse], # 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, ImageGenerationResponse]): The task_id or
ImageGenerationResponse 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,
)
@classmethod
def _preprocess_messages(
cls,
model: str,
messages: List[dict],
api_key: str,
):
"""
messages = [
{
"role": "user",
"content": [
{"image": ""},
{"text": ""},
]
}
]
"""
has_upload = False
upload_certificate = None
for message in messages:
if message.get("role", "") == "user":
content = message["content"]
for elem in content:
if not isinstance(
elem,
(int, float, bool, str, bytes, bytearray),
):
(
is_upload,
upload_certificate,
) = preprocess_message_element(
model,
elem,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload and not has_upload:
has_upload = True
return has_upload
@classmethod
def _merge_generation_response(
cls,
response,
n=1,
) -> Generator[ImageGenerationResponse, None, None]:
"""Merge incremental response chunks to simulate non-incremental output.""" # noqa: E501
accumulated_data = {}
for rsp in response:
parsed_response = ImageGenerationResponse.from_api_response(rsp)
result = merge_single_response(
parsed_response,
accumulated_data,
n,
)
if result is True:
yield parsed_response
elif isinstance(result, list):
# Multiple responses to yield (for n>1 non-stop cases)
for resp in result:
yield resp
class AioImageGeneration(BaseAioApi, BaseAsyncAioApi):
sync_task = "multimodal-generation"
async_task = "image-generation"
function = "generation"
"""API for AI-Generated Content(AIGC) models.
"""
class Models:
wan2_6_image = "wan2.6-image"
wan2_6_t2i = "wan2.6-t2i"
@classmethod
async def call( # type: ignore[override]
cls,
model: str,
api_key: str = None,
messages: List[Message] = None,
workspace: str = None,
**kwargs,
) -> Union[
ImageGenerationResponse,
AsyncGenerator[ImageGenerationResponse, None],
]:
"""Call generation model service.
Args:
model (str): The requested model
api_key (str, optional): The api api_key, can be None,
if None, will get by default rule(TODO: api key doc).
messages (list): The generation messages.
examples:
[{'role': 'user',
'content': 'The weather is fine today.'},
{'role': 'assistant', 'content': 'Suitable for outings'}]
**kwargs:
stream(bool, `optional`): Enable server-sent events
(ref: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) # noqa E501 # pylint: disable=line-too-long
the result will back partially[qwen-turbo,bailian-v1].
workspace (str): The dashscope workspace id.
Raises:
InvalidInput: The history and auto_history are mutually exclusive.
Returns:
Union[ImageGenerationResponse,
AsyncGenerator[ImageGenerationResponse, None]]: If
stream is True, return AsyncGenerator, otherwise ImageGenerationResponse.
"""
if messages is None or not messages:
raise InputRequired("messages is required!")
if model is None or not model:
raise ModelRequired("Model is required!")
task_group, _ = _get_task_group_and_task(__name__)
_input = {}
if messages is not None and messages: # type: ignore
has_upload = cls._preprocess_messages(model, messages, api_key) # type: ignore[arg-type] # pylint: disable=line-too-long # noqa: E501
if has_upload:
headers = kwargs.pop("headers", {})
headers["X-DashScope-OssResourceResolve"] = "enable"
kwargs["headers"] = headers
_input.update({"messages": messages})
# Check if we need to merge incremental output
is_incremental_output = kwargs.get("incremental_output", None)
is_stream = kwargs.get("stream", False)
to_merge_incremental_output = False
if (
ParamUtil.should_modify_incremental_output(model)
and is_stream
and is_incremental_output is not None
and is_incremental_output is False
):
to_merge_incremental_output = True
kwargs["incremental_output"] = True
# Pass incremental_to_full flag via headers user-agent
if "headers" not in kwargs:
kwargs["headers"] = {}
flag = "1" if to_merge_incremental_output else "0"
kwargs["headers"]["user-agent"] = f"incremental_to_full/{flag}"
if kwargs.get("is_async", False):
kwargs["headers"]["X-DashScope-Async"] = "enable"
task = cls.async_task
else:
task = cls.sync_task
response = await super().call(
model=model,
task_group=task_group,
task=task,
function=AioImageGeneration.function,
api_key=api_key,
input=_input,
workspace=workspace,
**kwargs,
)
if is_stream:
if to_merge_incremental_output:
# Extract n parameter for merge logic
n = kwargs.get("n", 1)
return cls._merge_generation_response(response, n)
else:
return cls._stream_responses(response)
else:
return ImageGenerationResponse.from_api_response(response)
@classmethod
async def async_call( # type: ignore[override]
cls,
model: str,
api_key: str = None,
messages: List[Message] = None,
workspace: str = None,
**kwargs,
) -> Union[
ImageGenerationResponse,
AsyncGenerator[ImageGenerationResponse, None],
]:
kwargs["is_async"] = True
return await cls.call(model, api_key, messages, workspace, **kwargs)
@classmethod
async def fetch(
cls,
task: Union[str, ImageGenerationResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Fetch image(s) synthesis task status or result.
Args:
task (Union[str, ImageGenerationResponse]): The task_id or
ImageGenerationResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The task status or result.
"""
response = await super().fetch(
task,
api_key=api_key,
workspace=workspace,
)
return ImageGenerationResponse.from_api_response(response)
@classmethod
async def wait(
cls,
task: Union[str, ImageGenerationResponse], # type: ignore[override]
api_key: str = None,
workspace: str = None,
**kwargs,
) -> DashScopeAPIResponse:
"""Wait for image(s) synthesis task to complete, and return the result.
Args:
task (Union[str, ImageGenerationResponse]): The task_id or
ImageGenerationResponse return by async_call().
api_key (str, optional): The api api_key. Defaults to None.
workspace (str): The dashscope workspace id.
Returns:
DashScopeAPIResponse: The task result.
"""
response = await super().wait(task, api_key, workspace=workspace)
return ImageGenerationResponse.from_api_response(response)
@classmethod
async def cancel(
cls,
task: Union[str, ImageGenerationResponse], # 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, ImageGenerationResponse]): The task_id or
ImageGenerationResponse 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,
)
@classmethod
def _preprocess_messages(
cls,
model: str,
messages: List[dict],
api_key: str,
):
"""
messages = [
{
"role": "user",
"content": [
{"image": ""},
{"text": ""},
]
}
]
"""
has_upload = False
upload_certificate = None
for message in messages:
if message.get("role", "") == "user":
content = message["content"]
for elem in content:
if not isinstance(
elem,
(int, float, bool, str, bytes, bytearray),
):
(
is_upload,
upload_certificate,
) = preprocess_message_element(
model,
elem,
api_key,
upload_certificate, # type: ignore[arg-type]
)
if is_upload and not has_upload:
has_upload = True
return has_upload
@classmethod
async def _stream_responses(
cls,
response,
) -> AsyncGenerator[ImageGenerationResponse, None]:
"""Convert async response stream to ImageGenerationResponse stream."""
# Type hint: when stream=True, response is actually an AsyncIterable
async for rsp in response: # type: ignore
yield ImageGenerationResponse.from_api_response(rsp)
@classmethod
async def _merge_generation_response(
cls,
response,
n=1,
) -> AsyncGenerator[ImageGenerationResponse, None]:
"""Async version of merge incremental response chunks."""
accumulated_data = {}
async for rsp in response: # type: ignore
parsed_response = ImageGenerationResponse.from_api_response(rsp)
result = merge_single_response(
parsed_response,
accumulated_data,
n,
)
if result is True:
yield parsed_response
elif isinstance(result, list):
# Multiple responses to yield (for n>1 non-stop cases)
for resp in result:
yield resp
|