forked from openai/openai-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathimage_edit_params.py
More file actions
60 lines (41 loc) · 1.66 KB
/
Copy pathimage_edit_params.py
File metadata and controls
60 lines (41 loc) · 1.66 KB
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
# File generated from our OpenAPI spec by Stainless.
from __future__ import annotations
from typing import Union, Optional
from typing_extensions import Literal, Required, TypedDict
from .._types import FileTypes
__all__ = ["ImageEditParams"]
class ImageEditParams(TypedDict, total=False):
image: Required[FileTypes]
"""The image to edit.
Must be a valid PNG file, less than 4MB, and square. If mask is not provided,
image must have transparency, which will be used as the mask.
"""
prompt: Required[str]
"""A text description of the desired image(s).
The maximum length is 1000 characters.
"""
mask: FileTypes
"""An additional image whose fully transparent areas (e.g.
where alpha is zero) indicate where `image` should be edited. Must be a valid
PNG file, less than 4MB, and have the same dimensions as `image`.
"""
model: Union[str, Literal["dall-e-2"], None]
"""The model to use for image generation.
Only `dall-e-2` is supported at this time.
"""
n: Optional[int]
"""The number of images to generate. Must be between 1 and 10."""
response_format: Optional[Literal["url", "b64_json"]]
"""The format in which the generated images are returned.
Must be one of `url` or `b64_json`.
"""
size: Optional[Literal["256x256", "512x512", "1024x1024"]]
"""The size of the generated images.
Must be one of `256x256`, `512x512`, or `1024x1024`.
"""
user: str
"""
A unique identifier representing your end-user, which can help OpenAI to monitor
and detect abuse.
[Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
"""