Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Usage

Contents

Main types
Other types

Description

The Usage type

Synopsis

data Usage completionTokensDetails promptTokensDetails = Usage {
- completion_tokens :: Natural
- prompt_tokens :: Natural
- total_tokens :: Natural
- completion_tokens_details :: Maybe completionTokensDetails
- prompt_tokens_details :: Maybe promptTokensDetails
}
data CompletionTokensDetails = CompletionTokensDetails {
- accepted_prediction_tokens :: Maybe Natural
- audio_tokens :: Maybe Natural
- reasoning_tokens :: Maybe Natural
- rejected_prediction_tokens :: Maybe Natural
}
data PromptTokensDetails = PromptTokensDetails {
- audio_tokens :: Maybe Natural
- cached_tokens :: Maybe Natural
}

Main types

data Usage completionTokensDetails promptTokensDetails Source #

Usage statistics for the completion request

Constructors

Usage
Fields completion_tokens :: Natural prompt_tokens :: Natural total_tokens :: Natural completion_tokens_details :: Maybe completionTokensDetails prompt_tokens_details :: Maybe promptTokensDetails

Instances

Instances details

FromJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage CompletionTokensDetails PromptTokensDetails) # parseJSONList :: Value -> Parser [Usage CompletionTokensDetails PromptTokensDetails] # omittedField :: Maybe (Usage CompletionTokensDetails PromptTokensDetails) #
FromJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) # parseJSONList :: Value -> Parser [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] # omittedField :: Maybe (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) #
ToJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage CompletionTokensDetails PromptTokensDetails -> Value # toEncoding :: Usage CompletionTokensDetails PromptTokensDetails -> Encoding # toJSONList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Value # toEncodingList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Encoding # omitField :: Usage CompletionTokensDetails PromptTokensDetails -> Bool #
ToJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Value # toEncoding :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Encoding # toJSONList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Value # toEncodingList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Encoding # omitField :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Bool #
Generic (Usage completionTokensDetails promptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Associated Types type Rep (Usage completionTokensDetails promptTokensDetails) :: Type -> Type # Methods from :: Usage completionTokensDetails promptTokensDetails -> Rep (Usage completionTokensDetails promptTokensDetails) x # to :: Rep (Usage completionTokensDetails promptTokensDetails) x -> Usage completionTokensDetails promptTokensDetails #
(Show completionTokensDetails, Show promptTokensDetails) => Show (Usage completionTokensDetails promptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods showsPrec :: Int -> Usage completionTokensDetails promptTokensDetails -> ShowS # show :: Usage completionTokensDetails promptTokensDetails -> String # showList :: [Usage completionTokensDetails promptTokensDetails] -> ShowS #
type Rep (Usage completionTokensDetails promptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage type Rep (Usage completionTokensDetails promptTokensDetails) = D1 ('MetaData "Usage" "OpenAI.V1.Usage" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "completion_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: S1 ('MetaSel ('Just "prompt_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "total_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: (S1 ('MetaSel ('Just "completion_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe completionTokensDetails)) :: S1 ('MetaSel ('Just "prompt_tokens_details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe promptTokensDetails))))))

Other types

data CompletionTokensDetails Source #

Breakdown of tokens used in a completion

Constructors

CompletionTokensDetails
Fields accepted_prediction_tokens :: Maybe Natural audio_tokens :: Maybe Natural reasoning_tokens :: Maybe Natural rejected_prediction_tokens :: Maybe Natural

Instances

Instances details

FromJSON CompletionTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser CompletionTokensDetails # parseJSONList :: Value -> Parser [CompletionTokensDetails] # omittedField :: Maybe CompletionTokensDetails #
ToJSON CompletionTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: CompletionTokensDetails -> Value # toEncoding :: CompletionTokensDetails -> Encoding # toJSONList :: [CompletionTokensDetails] -> Value # toEncodingList :: [CompletionTokensDetails] -> Encoding # omitField :: CompletionTokensDetails -> Bool #
Generic CompletionTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Associated Types type Rep CompletionTokensDetails :: Type -> Type # Methods from :: CompletionTokensDetails -> Rep CompletionTokensDetails x # to :: Rep CompletionTokensDetails x -> CompletionTokensDetails #
Show CompletionTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods showsPrec :: Int -> CompletionTokensDetails -> ShowS # show :: CompletionTokensDetails -> String # showList :: [CompletionTokensDetails] -> ShowS #
FromJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage CompletionTokensDetails PromptTokensDetails) # parseJSONList :: Value -> Parser [Usage CompletionTokensDetails PromptTokensDetails] # omittedField :: Maybe (Usage CompletionTokensDetails PromptTokensDetails) #
FromJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) # parseJSONList :: Value -> Parser [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] # omittedField :: Maybe (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) #
ToJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage CompletionTokensDetails PromptTokensDetails -> Value # toEncoding :: Usage CompletionTokensDetails PromptTokensDetails -> Encoding # toJSONList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Value # toEncodingList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Encoding # omitField :: Usage CompletionTokensDetails PromptTokensDetails -> Bool #
ToJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Value # toEncoding :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Encoding # toJSONList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Value # toEncodingList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Encoding # omitField :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Bool #
type Rep CompletionTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage type Rep CompletionTokensDetails = D1 ('MetaData "CompletionTokensDetails" "OpenAI.V1.Usage" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "CompletionTokensDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accepted_prediction_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "audio_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "reasoning_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "rejected_prediction_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))))

data PromptTokensDetails Source #

Breakdown of tokens used in the prompt

Constructors

PromptTokensDetails
Fields audio_tokens :: Maybe Natural cached_tokens :: Maybe Natural

Instances

Instances details

FromJSON PromptTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser PromptTokensDetails # parseJSONList :: Value -> Parser [PromptTokensDetails] # omittedField :: Maybe PromptTokensDetails #
ToJSON PromptTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: PromptTokensDetails -> Value # toEncoding :: PromptTokensDetails -> Encoding # toJSONList :: [PromptTokensDetails] -> Value # toEncodingList :: [PromptTokensDetails] -> Encoding # omitField :: PromptTokensDetails -> Bool #
Generic PromptTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Associated Types type Rep PromptTokensDetails :: Type -> Type # Methods from :: PromptTokensDetails -> Rep PromptTokensDetails x # to :: Rep PromptTokensDetails x -> PromptTokensDetails #
Show PromptTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage Methods showsPrec :: Int -> PromptTokensDetails -> ShowS # show :: PromptTokensDetails -> String # showList :: [PromptTokensDetails] -> ShowS #
FromJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage CompletionTokensDetails PromptTokensDetails) # parseJSONList :: Value -> Parser [Usage CompletionTokensDetails PromptTokensDetails] # omittedField :: Maybe (Usage CompletionTokensDetails PromptTokensDetails) #
FromJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods parseJSON :: Value -> Parser (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) # parseJSONList :: Value -> Parser [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] # omittedField :: Maybe (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) #
ToJSON (Usage CompletionTokensDetails PromptTokensDetails) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage CompletionTokensDetails PromptTokensDetails -> Value # toEncoding :: Usage CompletionTokensDetails PromptTokensDetails -> Encoding # toJSONList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Value # toEncodingList :: [Usage CompletionTokensDetails PromptTokensDetails] -> Encoding # omitField :: Usage CompletionTokensDetails PromptTokensDetails -> Bool #
ToJSON (Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)) Source #
Instance details Defined in OpenAI.V1.Usage Methods toJSON :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Value # toEncoding :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Encoding # toJSONList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Value # toEncodingList :: [Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails)] -> Encoding # omitField :: Usage (Maybe CompletionTokensDetails) (Maybe PromptTokensDetails) -> Bool #
type Rep PromptTokensDetails Source #
Instance details Defined in OpenAI.V1.Usage type Rep PromptTokensDetails = D1 ('MetaData "PromptTokensDetails" "OpenAI.V1.Usage" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "PromptTokensDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "audio_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "cached_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))))