ImageTypes.h

// OpenAI, Copyright LifeEXE. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Provider/OpenAIOptional.h"
#include "ImageTypes.generated.h"
 
UENUM(BlueprintType)
enum class EImageModelEnum : uint8
{
    DALL_E_2,
    DALL_E_3,
    GPT_Image_1,
    GPT_Image_1_Mini,
    GPT_Image_1_5
};
 
UENUM(BlueprintType)
enum class EImageSizeDalle2 : uint8
{
    Size_256x256,
    Size_512x512,
    Size_1024x1024
};
 
UENUM(BlueprintType)
enum class EImageSizeDalle3 : uint8
{
    Size_1024x1024,
    Size_1792x1024,
    Size_1024x1792
};
 
UENUM(BlueprintType)
enum class EImageSizeGptImage1 : uint8
{
    Auto,
    Size_1024x1024,
    Size_1536x1024,
    Size_1024x1536
};
 
UENUM(BlueprintType)
enum class EOpenAIImageQuality : uint8
{
    Auto,
    Standard,
    HD,
    High,
    Medium,
    Low
};
 
UENUM(BlueprintType)
enum class EOpenAIImageStyle : uint8
{
    // Vivid causes the model to lean towards generating hyper - real and dramatic images.
    Vivid,
    // Natural causes the model to produce more natural, less hyper - real looking images.
    Natural
};
 
UENUM(BlueprintType)
enum class EOpenAIImageFormat : uint8
{
    URL,
    B64_JSON
};
 
UENUM(BlueprintType)
enum class EOpenAIImageBackground : uint8
{
    Auto,
    Transparent,
    Opaque
};
 
UENUM(BlueprintType)
enum class EOpenAIImageModeration : uint8
{
    Auto,
    Low
};
 
UENUM(BlueprintType)
enum class EOpenAIImageOutputFormat : uint8
{
    Png,
    Jpeg,
    Webp
};

//                 REQUEST TYPES
 
USTRUCT(BlueprintType)
struct FOpenAIImage
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Prompt;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Background;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Model{"dall-e-2"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Moderation;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    int32 N{1};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Output_Compression{100};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Output_Format{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Quality{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Response_Format{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Size{"1024x1024"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Partial_Images{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Stream{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Style{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString User;
};
 
USTRUCT(BlueprintType)
struct FOpenAIImageEdit
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    TArray<FString> Image;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Prompt;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Background;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Input_Fidelity{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Mask;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Model{"dall-e-2"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Moderation{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    int32 N{1};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Output_Compression{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString Output_Format{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalInt Partial_Images{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Quality{"auto"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Response_Format{"url"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Size{"1024x1024"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalBool Stream{};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString User;
};
 
USTRUCT(BlueprintType)
struct FOpenAIImageVariation
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Required")
    FString Image;

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Model{"dall-e-2"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    int32 N{1};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Response_Format{"url"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FString Size{"1024x1024"};

    UPROPERTY(BlueprintReadWrite, Category = "OpenAI | Optional")
    FOptionalString User;
};

//                 RESPONSE TYPES

USTRUCT(BlueprintType)
struct FImageObject
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString B64_JSON;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString URL;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Revised_Prompt;
};
 
USTRUCT(BlueprintType)
struct FInputTokensDetails
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Image_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Text_Tokens{};
};
 
USTRUCT(BlueprintType)
struct FOutputTokensDetails
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Image_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Text_Tokens{};
};

USTRUCT(BlueprintType)
struct FImageUsage
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Input_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FInputTokensDetails Input_Tokens_Details{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Output_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Total_Tokens{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FOutputTokensDetails Output_Tokens_Details{};
};
 
USTRUCT(BlueprintType)
struct FImageResponse
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    int32 Created{};

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Background;
 
    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    TArray<FImageObject> Data;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Output_Format;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Quality;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FString Size;

    UPROPERTY(BlueprintReadOnly, Category = "OpenAI")
    FImageUsage Usage;
};
 
USTRUCT(BlueprintType)
struct FImageEditResponse : public FImageResponse
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FImageVariationResponse : public FImageResponse
{
    GENERATED_BODY()
};