OpenAI.V1.Images.Edits

/v1/images/edits

Main types

data CreateImageEdit

Request body for /v1/images/edits

Constructors

CreateImageEdit

Fields

• image :: FilePath
• prompt :: Text
• mask :: Maybe FilePath
• model :: Maybe Model
• n :: Maybe Natural
• size :: Maybe Text
• response_format :: Maybe ResponseFormat
• user :: Maybe Text

Instances

Generic CreateImageEdit

Defined in OpenAI.V1.Images.Edits

Associated Types

type Rep CreateImageEdit :: Type -> Type

Methods

from :: CreateImageEdit -> Rep CreateImageEdit x

to :: Rep CreateImageEdit x -> CreateImageEdit

Show CreateImageEdit

Defined in OpenAI.V1.Images.Edits

Methods

showsPrec :: Int -> CreateImageEdit -> ShowS

show :: CreateImageEdit -> String

showList :: [CreateImageEdit] -> ShowS

ToMultipart Tmp CreateImageEdit

Defined in OpenAI.V1.Images.Edits

Methods

toMultipart :: CreateImageEdit -> MultipartData Tmp

type Rep CreateImageEdit

Defined in OpenAI.V1.Images.Edits

type Rep CreateImageEdit = D1 ('MetaData "CreateImageEdit" "OpenAI.V1.Images.Edits" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateImageEdit" 'PrefixI 'True) (((S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "prompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "mask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Model)))) :*: ((S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "response_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResponseFormat)) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

_CreateImageEdit :: CreateImageEdit

Default CreateImageEdit

Other types

data ResponseFormat

The format in which the generated images are returned

Constructors

URL

B64_JSON

Instances

ToJSON ResponseFormat

Defined in OpenAI.V1.Images.ResponseFormat

Methods

toJSON :: ResponseFormat -> Value

toEncoding :: ResponseFormat -> Encoding

toJSONList :: [ResponseFormat] -> Value

toEncodingList :: [ResponseFormat] -> Encoding

omitField :: ResponseFormat -> Bool

Generic ResponseFormat

Defined in OpenAI.V1.Images.ResponseFormat

Associated Types

type Rep ResponseFormat :: Type -> Type

Methods

from :: ResponseFormat -> Rep ResponseFormat x

to :: Rep ResponseFormat x -> ResponseFormat

Show ResponseFormat

Defined in OpenAI.V1.Images.ResponseFormat

Methods

showsPrec :: Int -> ResponseFormat -> ShowS

show :: ResponseFormat -> String

showList :: [ResponseFormat] -> ShowS

ToHttpApiData ResponseFormat

Defined in OpenAI.V1.Images.ResponseFormat

Methods

toUrlPiece :: ResponseFormat -> Text

toEncodedUrlPiece :: ResponseFormat -> Builder

toHeader :: ResponseFormat -> ByteString

toQueryParam :: ResponseFormat -> Text

toEncodedQueryParam :: ResponseFormat -> Builder

type Rep ResponseFormat

Defined in OpenAI.V1.Images.ResponseFormat

type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "OpenAI.V1.Images.ResponseFormat" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "URL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "B64_JSON" 'PrefixI 'False) (U1 :: Type -> Type))

Servant

type API = "edits" :> (MultipartForm Tmp CreateImageEdit :> Post '[JSON] (ListOf ImageObject))

Servant API