openai-2.2.1: Servant bindings to OpenAI
Safe HaskellNone
LanguageHaskell2010

OpenAI.V1.ResponseFormat

Contents

Description

The ResponseFormat type

Synopsis

Types

data ResponseFormat Source #

An object specifying the format that the model must output

Constructors

ResponseFormat_Text 
JSON_Object 
JSON_Schema 

Fields

Instances

Instances details
FromJSON ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Methods

parseJSON :: Value -> Parser ResponseFormat #

parseJSONList :: Value -> Parser [ResponseFormat] #

omittedField :: Maybe ResponseFormat #

ToJSON ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.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.ResponseFormat

Associated Types

type Rep ResponseFormat 
Instance details

Defined in OpenAI.V1.ResponseFormat

type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "OpenAI.V1.ResponseFormat" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ResponseFormat_Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JSON_Object" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JSON_Schema" 'PrefixI 'True) (S1 ('MetaSel ('Just "json_schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONSchema))))

Methods

from :: ResponseFormat -> Rep ResponseFormat x #

to :: Rep ResponseFormat x -> ResponseFormat #

Show ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Methods

showsPrec :: Int -> ResponseFormat -> ShowS #

show :: ResponseFormat -> String #

showList :: [ResponseFormat] -> ShowS #

type Rep ResponseFormat Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "OpenAI.V1.ResponseFormat" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "ResponseFormat_Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JSON_Object" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JSON_Schema" 'PrefixI 'True) (S1 ('MetaSel ('Just "json_schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONSchema))))

data JSONSchema Source #

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide

Constructors

JSONSchema 

Fields

Instances

Instances details
FromJSON JSONSchema Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Methods

parseJSON :: Value -> Parser JSONSchema #

parseJSONList :: Value -> Parser [JSONSchema] #

omittedField :: Maybe JSONSchema #

ToJSON JSONSchema Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Methods

toJSON :: JSONSchema -> Value #

toEncoding :: JSONSchema -> Encoding #

toJSONList :: [JSONSchema] -> Value #

toEncodingList :: [JSONSchema] -> Encoding #

omitField :: JSONSchema -> Bool #

Generic JSONSchema Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Associated Types

type Rep JSONSchema 
Instance details

Defined in OpenAI.V1.ResponseFormat

type Rep JSONSchema = D1 ('MetaData "JSONSchema" "OpenAI.V1.ResponseFormat" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "JSONSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: JSONSchema -> Rep JSONSchema x #

to :: Rep JSONSchema x -> JSONSchema #

Show JSONSchema Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

Methods

showsPrec :: Int -> JSONSchema -> ShowS #

show :: JSONSchema -> String #

showList :: [JSONSchema] -> ShowS #

type Rep JSONSchema Source # 
Instance details

Defined in OpenAI.V1.ResponseFormat

type Rep JSONSchema = D1 ('MetaData "JSONSchema" "OpenAI.V1.ResponseFormat" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "JSONSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))