openai-2.2.1: Servant bindings to OpenAI
Safe HaskellNone
LanguageHaskell2010

OpenAI.V1.Images.Edits

Description

/v1/images/edits
Synopsis

Main types

data CreateImageEdit Source #

Request body for /v1/images/edits

Constructors

CreateImageEdit 

Fields

Instances

Instances details
FromJSON CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

Methods

parseJSON :: Value -> Parser CreateImageEdit #

parseJSONList :: Value -> Parser [CreateImageEdit] #

omittedField :: Maybe CreateImageEdit #

ToJSON CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

Methods

toJSON :: CreateImageEdit -> Value #

toEncoding :: CreateImageEdit -> Encoding #

toJSONList :: [CreateImageEdit] -> Value #

toEncodingList :: [CreateImageEdit] -> Encoding #

omitField :: CreateImageEdit -> Bool #

Generic CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

Associated Types

type Rep CreateImageEdit 
Instance details

Defined in OpenAI.V1.Images.Edits

type Rep CreateImageEdit = D1 ('MetaData "CreateImageEdit" "OpenAI.V1.Images.Edits" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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))))))

Methods

from :: CreateImageEdit -> Rep CreateImageEdit x #

to :: Rep CreateImageEdit x -> CreateImageEdit #

Show CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

Methods

showsPrec :: Int -> CreateImageEdit -> ShowS #

show :: CreateImageEdit -> String #

showList :: [CreateImageEdit] -> ShowS #

ToMultipart Tmp CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

Methods

toMultipart :: CreateImageEdit -> MultipartData Tmp #

type Rep CreateImageEdit Source # 
Instance details

Defined in OpenAI.V1.Images.Edits

type Rep CreateImageEdit = D1 ('MetaData "CreateImageEdit" "OpenAI.V1.Images.Edits" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

Default CreateImageEdit

Other types

data ResponseFormat Source #

The format in which the generated images are returned

Constructors

URL 
B64_JSON 

Instances

Instances details
FromJSON ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

Methods

parseJSON :: Value -> Parser ResponseFormat #

parseJSONList :: Value -> Parser [ResponseFormat] #

omittedField :: Maybe ResponseFormat #

ToJSON ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

Methods

toJSON :: ResponseFormat -> Value #

toEncoding :: ResponseFormat -> Encoding #

toJSONList :: [ResponseFormat] -> Value #

toEncodingList :: [ResponseFormat] -> Encoding #

omitField :: ResponseFormat -> Bool #

Generic ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

Associated Types

type Rep ResponseFormat 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

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

Methods

from :: ResponseFormat -> Rep ResponseFormat x #

to :: Rep ResponseFormat x -> ResponseFormat #

Show ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

Methods

showsPrec :: Int -> ResponseFormat -> ShowS #

show :: ResponseFormat -> String #

showList :: [ResponseFormat] -> ShowS #

ToHttpApiData ResponseFormat Source # 
Instance details

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 Source # 
Instance details

Defined in OpenAI.V1.Images.ResponseFormat

type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "OpenAI.V1.Images.ResponseFormat" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)) Source #

Servant API