-- | The `Usage` type
module OpenAI.V1.Usage
    ( -- * Main types
      Usage(..)

      -- * Other types
    , CompletionTokensDetails(..)
    , PromptTokensDetails(..)
    ) where

import OpenAI.Prelude

-- | Breakdown of tokens used in a completion
data CompletionTokensDetails = CompletionTokensDetails
    { CompletionTokensDetails -> Maybe Natural
accepted_prediction_tokens :: Maybe Natural
    , CompletionTokensDetails -> Maybe Natural
audio_tokens :: Maybe Natural
    , CompletionTokensDetails -> Maybe Natural
reasoning_tokens :: Maybe Natural
    , CompletionTokensDetails -> Maybe Natural
rejected_prediction_tokens :: Maybe Natural
    } deriving stock ((forall x.
 CompletionTokensDetails -> Rep CompletionTokensDetails x)
-> (forall x.
    Rep CompletionTokensDetails x -> CompletionTokensDetails)
-> Generic CompletionTokensDetails
forall x. Rep CompletionTokensDetails x -> CompletionTokensDetails
forall x. CompletionTokensDetails -> Rep CompletionTokensDetails x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. CompletionTokensDetails -> Rep CompletionTokensDetails x
from :: forall x. CompletionTokensDetails -> Rep CompletionTokensDetails x
$cto :: forall x. Rep CompletionTokensDetails x -> CompletionTokensDetails
to :: forall x. Rep CompletionTokensDetails x -> CompletionTokensDetails
Generic, Int -> CompletionTokensDetails -> ShowS
[CompletionTokensDetails] -> ShowS
CompletionTokensDetails -> String
(Int -> CompletionTokensDetails -> ShowS)
-> (CompletionTokensDetails -> String)
-> ([CompletionTokensDetails] -> ShowS)
-> Show CompletionTokensDetails
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> CompletionTokensDetails -> ShowS
showsPrec :: Int -> CompletionTokensDetails -> ShowS
$cshow :: CompletionTokensDetails -> String
show :: CompletionTokensDetails -> String
$cshowList :: [CompletionTokensDetails] -> ShowS
showList :: [CompletionTokensDetails] -> ShowS
Show)
      deriving anyclass (Maybe CompletionTokensDetails
Value -> Parser [CompletionTokensDetails]
Value -> Parser CompletionTokensDetails
(Value -> Parser CompletionTokensDetails)
-> (Value -> Parser [CompletionTokensDetails])
-> Maybe CompletionTokensDetails
-> FromJSON CompletionTokensDetails
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser CompletionTokensDetails
parseJSON :: Value -> Parser CompletionTokensDetails
$cparseJSONList :: Value -> Parser [CompletionTokensDetails]
parseJSONList :: Value -> Parser [CompletionTokensDetails]
$comittedField :: Maybe CompletionTokensDetails
omittedField :: Maybe CompletionTokensDetails
FromJSON, [CompletionTokensDetails] -> Value
[CompletionTokensDetails] -> Encoding
CompletionTokensDetails -> Bool
CompletionTokensDetails -> Value
CompletionTokensDetails -> Encoding
(CompletionTokensDetails -> Value)
-> (CompletionTokensDetails -> Encoding)
-> ([CompletionTokensDetails] -> Value)
-> ([CompletionTokensDetails] -> Encoding)
-> (CompletionTokensDetails -> Bool)
-> ToJSON CompletionTokensDetails
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: CompletionTokensDetails -> Value
toJSON :: CompletionTokensDetails -> Value
$ctoEncoding :: CompletionTokensDetails -> Encoding
toEncoding :: CompletionTokensDetails -> Encoding
$ctoJSONList :: [CompletionTokensDetails] -> Value
toJSONList :: [CompletionTokensDetails] -> Value
$ctoEncodingList :: [CompletionTokensDetails] -> Encoding
toEncodingList :: [CompletionTokensDetails] -> Encoding
$comitField :: CompletionTokensDetails -> Bool
omitField :: CompletionTokensDetails -> Bool
ToJSON)

-- | Breakdown of tokens used in the prompt
data PromptTokensDetails = PromptTokensDetails
    { PromptTokensDetails -> Maybe Natural
audio_tokens :: Maybe Natural
    , PromptTokensDetails -> Maybe Natural
cached_tokens :: Maybe Natural
    } deriving stock ((forall x. PromptTokensDetails -> Rep PromptTokensDetails x)
-> (forall x. Rep PromptTokensDetails x -> PromptTokensDetails)
-> Generic PromptTokensDetails
forall x. Rep PromptTokensDetails x -> PromptTokensDetails
forall x. PromptTokensDetails -> Rep PromptTokensDetails x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. PromptTokensDetails -> Rep PromptTokensDetails x
from :: forall x. PromptTokensDetails -> Rep PromptTokensDetails x
$cto :: forall x. Rep PromptTokensDetails x -> PromptTokensDetails
to :: forall x. Rep PromptTokensDetails x -> PromptTokensDetails
Generic, Int -> PromptTokensDetails -> ShowS
[PromptTokensDetails] -> ShowS
PromptTokensDetails -> String
(Int -> PromptTokensDetails -> ShowS)
-> (PromptTokensDetails -> String)
-> ([PromptTokensDetails] -> ShowS)
-> Show PromptTokensDetails
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> PromptTokensDetails -> ShowS
showsPrec :: Int -> PromptTokensDetails -> ShowS
$cshow :: PromptTokensDetails -> String
show :: PromptTokensDetails -> String
$cshowList :: [PromptTokensDetails] -> ShowS
showList :: [PromptTokensDetails] -> ShowS
Show)
      deriving anyclass (Maybe PromptTokensDetails
Value -> Parser [PromptTokensDetails]
Value -> Parser PromptTokensDetails
(Value -> Parser PromptTokensDetails)
-> (Value -> Parser [PromptTokensDetails])
-> Maybe PromptTokensDetails
-> FromJSON PromptTokensDetails
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser PromptTokensDetails
parseJSON :: Value -> Parser PromptTokensDetails
$cparseJSONList :: Value -> Parser [PromptTokensDetails]
parseJSONList :: Value -> Parser [PromptTokensDetails]
$comittedField :: Maybe PromptTokensDetails
omittedField :: Maybe PromptTokensDetails
FromJSON, [PromptTokensDetails] -> Value
[PromptTokensDetails] -> Encoding
PromptTokensDetails -> Bool
PromptTokensDetails -> Value
PromptTokensDetails -> Encoding
(PromptTokensDetails -> Value)
-> (PromptTokensDetails -> Encoding)
-> ([PromptTokensDetails] -> Value)
-> ([PromptTokensDetails] -> Encoding)
-> (PromptTokensDetails -> Bool)
-> ToJSON PromptTokensDetails
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: PromptTokensDetails -> Value
toJSON :: PromptTokensDetails -> Value
$ctoEncoding :: PromptTokensDetails -> Encoding
toEncoding :: PromptTokensDetails -> Encoding
$ctoJSONList :: [PromptTokensDetails] -> Value
toJSONList :: [PromptTokensDetails] -> Value
$ctoEncodingList :: [PromptTokensDetails] -> Encoding
toEncodingList :: [PromptTokensDetails] -> Encoding
$comitField :: PromptTokensDetails -> Bool
omitField :: PromptTokensDetails -> Bool
ToJSON)

-- | Usage statistics for the completion request
data Usage completionTokensDetails promptTokensDetails = Usage
    { forall completionTokensDetails promptTokensDetails.
Usage completionTokensDetails promptTokensDetails -> Natural
completion_tokens :: Natural
    , forall completionTokensDetails promptTokensDetails.
Usage completionTokensDetails promptTokensDetails -> Natural
prompt_tokens :: Natural
    , forall completionTokensDetails promptTokensDetails.
Usage completionTokensDetails promptTokensDetails -> Natural
total_tokens :: Natural
    , forall completionTokensDetails promptTokensDetails.
Usage completionTokensDetails promptTokensDetails
-> Maybe completionTokensDetails
completion_tokens_details :: Maybe completionTokensDetails
    , forall completionTokensDetails promptTokensDetails.
Usage completionTokensDetails promptTokensDetails
-> Maybe promptTokensDetails
prompt_tokens_details :: Maybe promptTokensDetails
    } deriving stock ((forall x.
 Usage completionTokensDetails promptTokensDetails
 -> Rep (Usage completionTokensDetails promptTokensDetails) x)
-> (forall x.
    Rep (Usage completionTokensDetails promptTokensDetails) x
    -> Usage completionTokensDetails promptTokensDetails)
-> Generic (Usage completionTokensDetails promptTokensDetails)
forall x.
Rep (Usage completionTokensDetails promptTokensDetails) x
-> Usage completionTokensDetails promptTokensDetails
forall x.
Usage completionTokensDetails promptTokensDetails
-> Rep (Usage completionTokensDetails promptTokensDetails) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall completionTokensDetails promptTokensDetails x.
Rep (Usage completionTokensDetails promptTokensDetails) x
-> Usage completionTokensDetails promptTokensDetails
forall completionTokensDetails promptTokensDetails x.
Usage completionTokensDetails promptTokensDetails
-> Rep (Usage completionTokensDetails promptTokensDetails) x
$cfrom :: forall completionTokensDetails promptTokensDetails x.
Usage completionTokensDetails promptTokensDetails
-> Rep (Usage completionTokensDetails promptTokensDetails) x
from :: forall x.
Usage completionTokensDetails promptTokensDetails
-> Rep (Usage completionTokensDetails promptTokensDetails) x
$cto :: forall completionTokensDetails promptTokensDetails x.
Rep (Usage completionTokensDetails promptTokensDetails) x
-> Usage completionTokensDetails promptTokensDetails
to :: forall x.
Rep (Usage completionTokensDetails promptTokensDetails) x
-> Usage completionTokensDetails promptTokensDetails
Generic, Int -> Usage completionTokensDetails promptTokensDetails -> ShowS
[Usage completionTokensDetails promptTokensDetails] -> ShowS
Usage completionTokensDetails promptTokensDetails -> String
(Int -> Usage completionTokensDetails promptTokensDetails -> ShowS)
-> (Usage completionTokensDetails promptTokensDetails -> String)
-> ([Usage completionTokensDetails promptTokensDetails] -> ShowS)
-> Show (Usage completionTokensDetails promptTokensDetails)
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
Int -> Usage completionTokensDetails promptTokensDetails -> ShowS
forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
[Usage completionTokensDetails promptTokensDetails] -> ShowS
forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
Usage completionTokensDetails promptTokensDetails -> String
$cshowsPrec :: forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
Int -> Usage completionTokensDetails promptTokensDetails -> ShowS
showsPrec :: Int -> Usage completionTokensDetails promptTokensDetails -> ShowS
$cshow :: forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
Usage completionTokensDetails promptTokensDetails -> String
show :: Usage completionTokensDetails promptTokensDetails -> String
$cshowList :: forall completionTokensDetails promptTokensDetails.
(Show completionTokensDetails, Show promptTokensDetails) =>
[Usage completionTokensDetails promptTokensDetails] -> ShowS
showList :: [Usage completionTokensDetails promptTokensDetails] -> ShowS
Show)

instance FromJSON (Usage CompletionTokensDetails PromptTokensDetails)
instance FromJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails))
instance ToJSON (Usage CompletionTokensDetails PromptTokensDetails)
instance ToJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails))