@ralphschuler.ai function caller.index.<internal>.OpenAI.Images.ImageGenerateParams

Interface: ImageGenerateParams

OpenAI.Images.ImageGenerateParams

Table of contents

Properties

• model
• n
• prompt
• quality
• response_format
• size
• style
• user

Properties

model

• Optional model: null | string & {} | "dall-e-2" | "dall-e-3"

The model to use for image generation.

Defined in

node_modules/openai/resources/images.d.ts:127

---

n

• Optional n: null | number

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

Defined in

node_modules/openai/resources/images.d.ts:132

---

prompt

• prompt: string

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

Defined in

node_modules/openai/resources/images.d.ts:123

---

quality

• Optional quality: "standard" | "hd"

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

Defined in

node_modules/openai/resources/images.d.ts:138

---

response_format

• Optional response_format: null | "url" | "b64_json"

The format in which the generated images are returned. Must be one of url or b64_json.

Defined in

node_modules/openai/resources/images.d.ts:143

---

size

• Optional size: null | "256x256" | "512x512" | "1024x1024" | "1792x1024" | "1024x1792"

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

Defined in

node_modules/openai/resources/images.d.ts:149

---

style

• Optional style: null | "vivid" | "natural"

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

Defined in

node_modules/openai/resources/images.d.ts:156

---

user

• Optional user: string

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

Defined in

node_modules/openai/resources/images.d.ts:162