Skip to content

Request-ImageEdit.md

Latest commit

 

History

History
334 lines (275 loc) · 9.35 KB

Request-ImageEdit.md

File metadata and controls

334 lines (275 loc) · 9.35 KB
external help file PSOpenAI-help.xml
Module Name PSOpenAI
online version https://github.com/mkht/PSOpenAI/blob/main/Docs/Request-ImageEdit.md
schema 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>
    [-Model <String>]
    [-Mask <String>]
    [-NumberOfImages <UInt16>]
    [-Size <String>]
    [-Quality <String>]
    [-Background <String>]
    [-InputFidelity <String>]
    [-OutputCompression <UInt16>]
    [-OutputFormat <String>]
    [-ResponseFormat <String>]
    [-OutputRawResponse]
    [-Stream]
    [-PartialImages <UInt16>]
    [-User <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <Object>]
    [-Organization <String>]
    [<CommonParameters>]

Request-ImageEdit
    -Image <String[]>
    -Prompt <String>
    -OutFile <String>
    [-Model <String>]
    [-Mask <String>]
    [-NumberOfImages <UInt16>]
    [-Size <String>]
    [-Quality <String>]
    [-Background <String>]
    [-InputFidelity <String>]
    [-OutputCompression <UInt16>]
    [-OutputFormat <String>]
    [-Stream]
    [-PartialImages <UInt16>]
    [-User <String>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <Object>]
    [<CommonParameters>]

DESCRIPTION

Creates an edited or extended image given an original image and a prompt.
https://developers.openai.com/api/reference/resources/images/methods/edit

EXAMPLES

Example 1: Edit an image with a prompt.

Request-ImageEdit -Model 'gpt-image-1.5' -Prompt 'A bird on the desert' -Image 'C:\sand_with_fether.png' -OutFile 'C:\bird_on_desert.png' -Size 1024x1024
Original Generated
original edited

Example 2: Create variation image from source and mask.

Request-ImageEdit -Model 'gpt-image-1.5' -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)
masked mask restored

PARAMETERS

-Image

(Required) The image(s) to edit. Must be a supported image file or an array of images. For the GPT image models, each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images. For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

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

-Prompt

(Required) A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

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. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

Type: String
Required: False
Position: Named

-Model

The model to use for image generation. Only dall-e-2 and the GPT image models are supported. Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

Type: String
Required: False
Position: Named

-NumberOfImages

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

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

-Quality

The quality of the image that will be generated.

  • auto (default value) will automatically select the best quality for the given model.
  • high, medium and low are supported for the GPT image models.
  • hd and standard are supported for dall-e-3.
  • standard is the only option for dall-e-2.
Type: String
Required: False
Position: Named
Default value: auto

-Size

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for the GPT image models, and one of 256x256, 512x512, or 1024x1024 for dall-e-2, and one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3.

Type: String
Required: False
Position: Named
Default value: auto

-Background

Background behavior for generated image output.
Accepts one of the following: transparent, opaque, and auto (default).

Type: String
Required: False
Position: Named
Default value: auto

-InputFidelity

Controls fidelity to the original input image(s). This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

Type: String
Aliases: input_fidelity
Required: False
Position: Named
Default value: low

-OutputCompression

The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.

Type: UInt16
Aliases: output_compression
Required: False
Position: Named
Default value: 100

-OutputFormat

The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp. The default value is png.

Type: String
Aliases: output_format
Required: False
Position: Named
Default value: png

-ResponseFormat

The format in which the generated images are returned. Must be one of url, base64 or byte. This parameter is only supported for dall-e-2, as the GPT image models always return images in base64 format.

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

-OutputRawResponse

If specifies this switch, an output of this function to be a raw response value from the API. (Normally JSON formatted string.)

Type: SwitchParameter
Parameter Sets: Format
Required: False
Position: Named

-OutFile

Specify the file path where the generated images will be saved. This cannot be specified with the ResponseFormat parameter.

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

-Stream

Edit the image in streaming mode. Defaults to false.

Type: SwitchParameter
Required: False
Position: Named

-PartialImages

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

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

-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

NOTES

RELATED LINKS

https://developers.openai.com/api/docs/guides/image-generation/

https://developers.openai.com/api/reference/resources/images/methods/edit