Unreal OpenAI API 1.0.0
Loading...
Searching...
No Matches
FOpenAIImage Struct Reference

Public Attributes

FString Prompt
FOptionalString Background
FString Model {"gpt-image-1"}
FOptionalString Moderation
int32 N {1}
FOptionalInt Output_Compression {100}
FOptionalString Output_Format {}
FOptionalString Quality {}
FString Size {"1024x1024"}
FOptionalInt Partial_Images {}
FOptionalBool Stream {}
FOptionalString User

Member Data Documentation

◆ Background

FOptionalString FOpenAIImage::Background

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image. If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

◆ Model

FString FOpenAIImage::Model {"gpt-image-1"}

The model to use for image generation. One of gpt-image-1, gpt-image-1-mini, gpt-image-1.5, or chatgpt-image-latest.

◆ Moderation

FOptionalString FOpenAIImage::Moderation

Control the content-moderation level for images generated by gpt-image-1. Must be either low for less restrictive filtering or auto (default value).

◆ N

int32 FOpenAIImage::N {1}

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

◆ Output_Compression

FOptionalInt FOpenAIImage::Output_Compression {100}

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

◆ Output_Format

FOptionalString FOpenAIImage::Output_Format {}

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp.

◆ Partial_Images

FOptionalInt FOpenAIImage::Partial_Images {}

The number of partial images to generate during streaming. Value must be between 0 and 3. This parameter is only supported for the GPT image models.

◆ Prompt

FString FOpenAIImage::Prompt

A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models.

◆ Quality

FOptionalString FOpenAIImage::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.

◆ Size

FString FOpenAIImage::Size {"1024x1024"}

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for the GPT image models.

◆ Stream

FOptionalBool FOpenAIImage::Stream {}

Generate the image in streaming mode. Defaults to false. This parameter is only supported for the GPT image models.

◆ User

FOptionalString FOpenAIImage::User

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


The documentation for this struct was generated from the following file: