openai-2.2.1: Servant bindings to OpenAI

Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Moderations

Contents

Main types
Other types
Servant

Description

/v1/moderations

Synopsis

data CreateModeration = CreateModeration {
- input :: Text
- model :: Maybe Model
}
_CreateModeration :: CreateModeration
data Moderation = Moderation {
- id :: Text
- model :: Model
- results :: Vector Result
}
data InputType
- = Text
- | Image
data Result = Result {
- flagged :: Bool
- categories :: Map Text Bool
- category_scores :: Map Text Double
- category_applied_input_types :: Maybe (Map Text [InputType])
}
type API = "moderations" :> (ReqBody '[JSON] CreateModeration :> Post '[JSON] Moderation)

Main types

data CreateModeration Source #

Request body for /v1/moderations

Constructors

CreateModeration
Fields input :: Text model :: Maybe Model

Instances

Instances details

FromJSON CreateModeration Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

parseJSON :: Value -> Parser CreateModeration #

parseJSONList :: Value -> Parser [CreateModeration] #

omittedField :: Maybe CreateModeration #

ToJSON CreateModeration Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

toJSON :: CreateModeration -> Value #

toEncoding :: CreateModeration -> Encoding #

toJSONList :: [CreateModeration] -> Value #

toEncodingList :: [CreateModeration] -> Encoding #

omitField :: CreateModeration -> Bool #

Generic CreateModeration Source #

Instance details

Defined in OpenAI.V1.Moderations

Associated Types

type Rep CreateModeration

Instance details

Defined in OpenAI.V1.Moderations

type Rep CreateModeration = D1 ('MetaData "CreateModeration" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateModeration" 'PrefixI 'True) (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Model))))

Methods

from :: CreateModeration -> Rep CreateModeration x #

to :: Rep CreateModeration x -> CreateModeration #

Show CreateModeration Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

showsPrec :: Int -> CreateModeration -> ShowS #

show :: CreateModeration -> String #

showList :: [CreateModeration] -> ShowS #

type Rep CreateModeration Source #

Instance details

Defined in OpenAI.V1.Moderations

type Rep CreateModeration = D1 ('MetaData "CreateModeration" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateModeration" 'PrefixI 'True) (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Model))))

_CreateModeration :: CreateModeration Source #

Default CreateModeration

data Moderation Source #

Represents if a given text input is potentially harmful.

Constructors

Moderation
Fields id :: Text model :: Model results :: Vector Result

Instances

Instances details

FromJSON Moderation Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

parseJSON :: Value -> Parser Moderation #

parseJSONList :: Value -> Parser [Moderation] #

omittedField :: Maybe Moderation #

ToJSON Moderation Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

toJSON :: Moderation -> Value #

toEncoding :: Moderation -> Encoding #

toJSONList :: [Moderation] -> Value #

toEncodingList :: [Moderation] -> Encoding #

omitField :: Moderation -> Bool #

Generic Moderation Source #

Instance details

Defined in OpenAI.V1.Moderations

Associated Types

type Rep Moderation

Instance details

Defined in OpenAI.V1.Moderations

type Rep Moderation = D1 ('MetaData "Moderation" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Moderation" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Result)))))

Methods

from :: Moderation -> Rep Moderation x #

to :: Rep Moderation x -> Moderation #

Show Moderation Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

showsPrec :: Int -> Moderation -> ShowS #

show :: Moderation -> String #

showList :: [Moderation] -> ShowS #

type Rep Moderation Source #

Instance details

Defined in OpenAI.V1.Moderations

type Rep Moderation = D1 ('MetaData "Moderation" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Moderation" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Result)))))

Other types

data InputType Source #

The input type that the score applies to

Constructors

Text
Image

Instances

Instances details

FromJSON InputType Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

parseJSON :: Value -> Parser InputType #

parseJSONList :: Value -> Parser [InputType] #

omittedField :: Maybe InputType #

ToJSON InputType Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

toJSON :: InputType -> Value #

toEncoding :: InputType -> Encoding #

toJSONList :: [InputType] -> Value #

toEncodingList :: [InputType] -> Encoding #

omitField :: InputType -> Bool #

Generic InputType Source #

Instance details

Defined in OpenAI.V1.Moderations

Associated Types

type Rep InputType
Instance details Defined in OpenAI.V1.Moderations type Rep InputType = D1 ('MetaData "InputType" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Image" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: InputType -> Rep InputType x #

to :: Rep InputType x -> InputType #

Show InputType Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

showsPrec :: Int -> InputType -> ShowS #

show :: InputType -> String #

showList :: [InputType] -> ShowS #

type Rep InputType Source #

Instance details

Defined in OpenAI.V1.Moderations

type Rep InputType = D1 ('MetaData "InputType" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Image" 'PrefixI 'False) (U1 :: Type -> Type))

data Result Source #

A moderation result

Constructors

Result
Fields flagged :: Bool categories :: Map Text Bool category_scores :: Map Text Double category_applied_input_types :: Maybe (Map Text [InputType])

Instances

Instances details

FromJSON Result Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

parseJSON :: Value -> Parser Result #

parseJSONList :: Value -> Parser [Result] #

omittedField :: Maybe Result #

ToJSON Result Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

toJSON :: Result -> Value #

toEncoding :: Result -> Encoding #

toJSONList :: [Result] -> Value #

toEncodingList :: [Result] -> Encoding #

omitField :: Result -> Bool #

Generic Result Source #

Instance details

Defined in OpenAI.V1.Moderations

Associated Types

type Rep Result

Instance details

Defined in OpenAI.V1.Moderations

type Rep Result = D1 ('MetaData "Result" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Result" 'PrefixI 'True) ((S1 ('MetaSel ('Just "flagged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "categories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Bool))) :*: (S1 ('MetaSel ('Just "category_scores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Double)) :*: S1 ('MetaSel ('Just "category_applied_input_types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text [InputType]))))))

Methods

from :: Result -> Rep Result x #

to :: Rep Result x -> Result #

Show Result Source #

Instance details

Defined in OpenAI.V1.Moderations

Methods

showsPrec :: Int -> Result -> ShowS #

show :: Result -> String #

showList :: [Result] -> ShowS #

type Rep Result Source #

Instance details

Defined in OpenAI.V1.Moderations

type Rep Result = D1 ('MetaData "Result" "OpenAI.V1.Moderations" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Result" 'PrefixI 'True) ((S1 ('MetaSel ('Just "flagged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "categories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Bool))) :*: (S1 ('MetaSel ('Just "category_scores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Double)) :*: S1 ('MetaSel ('Just "category_applied_input_types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text [InputType]))))))

Servant

type API = "moderations" :> (ReqBody '[JSON] CreateModeration :> Post '[JSON] Moderation) Source #

Servant API