Request-ImageEdit.md

external help file	Module Name	online version	schema
PSOpenAI-help.xml	PSOpenAI	https://github.com/mkht/PSOpenAI/blob/main/Docs/Request-ImageEdit.md	2.0.0

Request-ImageEdit

SYNOPSIS

Creates an edited or extended image given an original image and a prompt.

SYNTAX

Request-ImageEdit
    -Image <String>
    -Prompt <String>
    [-Mask <String>]
    [-NumberOfImages <UInt16>]
    [-Size <String>]
    [-Format <String>]
    [-User <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <Object>]
    [-Organization <String>]
    [<CommonParameters>]

Request-ImageEdit
    -Image <String>
    -Prompt <String>
    [-Mask <String>]
    [-NumberOfImages <UInt16>]
    [-Size <String>]
    -OutFile <String>
    [-User <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiKey <Object>]
    [<CommonParameters>]

DESCRIPTION

Creates an edited or extended image given an original image and a prompt.
https://platform.openai.com/docs/guides/images/image-generation

EXAMPLES

Example 1: Restore masked image.

Request-ImageEdit -Image C:\sunflower_mask.png -Prompt "sunflower" -OutFile C:\edit.png -Size 256x256

Source (sunflower_mask.png)	Generated (edit.png)

Example 2: Create variation image from source and mask.

Request-ImageEdit -Image C:\sand_with_feather.png -Mask C:\fether_mask.png -Prompt "A bird on the desert" -OutFile C:\edit2.png

Source (sand_with_feather.png)	Mask (fether_mask.png)	Generated (edit2.png)

PARAMETERS

-Image

(Required) 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.

Type: String
Aliases: File
Required: True
Position: Named

-Prompt

(Required) A text description of the desired image(s).
The maximum length is 1000 characters.

Type: String
Required: True
Position: Named

-Mask

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.

Type: String
Required: False
Position: Named

-NumberOfImages

The number of images to generate.
Must be between 1 and 10. The default value is 1.

Type: UInt16
Aliases: n
Required: False
Position: Named
Default value: 1

-Size

The size of the generated images.
Must be one of 256x256, 512x512, or 1024x1024. The default value is 1024x1024.

Type: String
Required: False
Position: Named
Default value: 1024x1024

-Format

The format in which the generated images are returned.
Must be one of url, base64 or byte.

Type: String
Parameter Sets: Format
Aliases: response_format
Required: False
Position: Named
Default value: url

-OutFile

Specify the file path where the generated images will be saved.
This cannot be specified with the Format parameter. Also, NumberOfImages must be 1.

Type: String
Parameter Sets: OutFile
Required: True
Position: Named

-User

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Type: String
Required: False
Position: Named

-TimeoutSec

Specifies how long the request can be pending before it times out. The default value is 0 (infinite).

Type: Int32
Required: False
Position: Named
Default value: 0

-MaxRetryCount

Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.

Type: Int32
Required: False
Position: Named
Default value: 0

-ApiBase

Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1

Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1

-ApiKey

Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY

Type: Object
Required: False
Position: Named

-Organization

Specifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION

Type: string
Aliases: OrgId
Required: False
Position: Named

INPUTS

OUTPUTS

Format = url : string or array of string

Format = base64 : Generated image data represented in base64 string.

Format = byte : Byte array of generated image.

OutFile : Nothing.

NOTES

RELATED LINKS

https://platform.openai.com/docs/guides/images/image-generation

https://platform.openai.com/docs/api-reference/images/create-edit