Class ImageGenerator

Class used to generate images using OpenAI's DALL-E

Index

Constructors

Properties

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
- Defined in image.ts:16

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 = "512x512"
  Optional, the size of the image. Defaults to "512x512"
- model: Model = "dall-e-3"
  Optional, the DALL-E model to use. Defaults to "dall-e-3"
Returns Promise<string>
A Promise that resolves to the URL of the generated image
- Defined in image.ts:26

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 = "512x512"
  Optional, the size of the images. Defaults to "512x512"
- model: Model = "dall-e-3"
  Optional, the DALL-E model to use. Defaults to "dall-e-3"
Returns Promise<string[]>
A Promise that resolves to an array of URLs for the generated images
- Defined in image.ts:39