Class ImageGenerator

Class used to generate images using OpenAI's GPT image models

Constructors

constructor

Properties

logger openai

Methods

generateImage generateImages

Constructors

constructor

  • new ImageGenerator(openai, logger): ImageGenerator

  • Creates a new ImageGenerator instance

    Parameters

    • openai: OpenAI

      The authenticated OpenAI client

    • logger: ILogger

      Logger instance for debugging

    Returns ImageGenerator

Properties

Private Readonly logger

logger: ILogger

Logger instance for debugging

Private Readonly openai

openai: OpenAI

The authenticated OpenAI client

Methods

generateImage

  • generateImage(prompt, size?, model?): Promise<string>

  • Generates a single image from a text prompt

    Parameters

    • prompt: string

      The text prompt describing the image to generate

    • size: ImageSize = "1024x1024"

      Optional, the size of the image. Defaults to "1024x1024"

    • model: Model = "gpt-image-1-mini"

      Optional, the GPT image model to use. Defaults to "gpt-image-1-mini"

    Returns Promise<string>

    A Promise that resolves to the PNG data URL of the generated image

generateImages

  • generateImages(prompt, numberOfImages, size?, model?): Promise<string[]>

  • Generates multiple images from a text prompt

    Parameters

    • prompt: string

      The text prompt describing the images to generate

    • numberOfImages: 1 | 2 | 3 | 4 | 5

      The number of images to generate (1-5)

    • size: ImageSize = "1024x1024"

      Optional, the size of the images. Defaults to "1024x1024"

    • model: Model = "gpt-image-1-mini"

      Optional, the GPT image model to use. Defaults to "gpt-image-1-mini"

    Returns Promise<string[]>

    A Promise that resolves to an array of PNG data URLs for the generated images

Settings

Member Visibility

Theme

On This Page

constructorloggeropenaigenerateImagegenerateImages