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

Interface: ImageEditParams

OpenAI.Images.ImageEditParams

Table of contents

Properties

• image
• mask
• model
• n
• prompt
• response_format
• size
• user

Properties

image

• image: Uploadable

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

Defined in

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

---

mask

• Optional mask: Uploadable

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

Defined in

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

---

model

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

The model to use for image generation. Only dall-e-2 is supported at this time.

Defined in

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

---

n

• Optional n: null | number

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

Defined in

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

---

prompt

• prompt: string

A text description of the desired image(s). The maximum length is 1000 characters.

Defined in

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

---

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:105

---

size

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

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

Defined in

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

---

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:116