Class Images

Hierarchy

APIResource
- Images

Index

Constructors

Properties

Methods

createVariation edit generate

Constructors

constructor

new Images(client): Images
Parameters
- client: openai.OpenAI
Returns Images
Inherited from APIResource.constructor
- Defined in node_modules/openai/resource.d.ts:4

Properties

`Protected` _client

_client: openai.OpenAI

Methods

createVariation

createVariation(body, options?): APIPromise<ImagesResponse>
Creates a variation of a given image.
Parameters
- body: ImageCreateVariationParams
- Optional options: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:9

edit

edit(body, options?): APIPromise<ImagesResponse>
Creates an edited or extended image given an original image and a prompt.
Parameters
- body: ImageEditParams
- Optional options: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:13

generate

generate(body, options?): APIPromise<ImagesResponse>
Creates an image given a prompt.
Parameters
- body: ImageGenerateParams
- Optional options: RequestOptions<unknown>
Returns APIPromise<ImagesResponse>
- Defined in node_modules/openai/resources/images.d.ts:17

Generated using TypeDoc