Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.Resources

Contents

Core Types
Models
Completion
Chat
Edits
Images
Embeddings
Audio
Fine tuning (out of date)
File API (out of date)
Engine (deprecated)
Engine text completion (deprecated)
Engine Embeddings (deprecated)

Synopsis

newtype TimeStamp = TimeStamp {
- unTimeStamp :: UTCTime
}
newtype OpenAIList a = OpenAIList {
- olData :: Vector a
}
data Usage = Usage {
- usPromptTokens :: Int
- usCompletionTokens :: Int
- usTotalTokens :: Int
}
data Model = Model {
- mId :: ModelId
- mObject :: Text
- mOwnedBy :: Text
- mPermission :: [Object]
}
newtype ModelId = ModelId {
- unModelId :: Text
}
data CompletionCreate = CompletionCreate {
- ccrModel :: ModelId
- ccrPrompt :: Maybe Text
- ccrSuffix :: Maybe Text
- ccrMaxTokens :: Maybe Int
- ccrTemperature :: Maybe Double
- ccrTopP :: Maybe Double
- ccrN :: Maybe Int
- ccrStream :: Maybe Bool
- ccrLogprobs :: Maybe Int
- ccrEcho :: Maybe Bool
- ccrStop :: Maybe (Vector Text)
- ccrPresencePenalty :: Maybe Double
- ccrFrequencyPenalty :: Maybe Double
- ccrBestOf :: Maybe Int
- ccrLogitBias :: Maybe (Vector Double)
- ccrUser :: Maybe String
}
data CompletionChoice = CompletionChoice {
- cchText :: Text
- cchIndex :: Int
- cchLogprobs :: Maybe (Vector Double)
- cchFinishReason :: Maybe Text
}
data CompletionResponse = CompletionResponse {
- crId :: Text
- crObject :: Text
- crCreated :: Int
- crModel :: ModelId
- crChoices :: [CompletionChoice]
- crUsage :: Object
}
defaultCompletionCreate :: ModelId -> Text -> CompletionCreate
data ChatFunction = ChatFunction {
- chfName :: Text
- chfDescription :: Text
- chfParameters :: Value
}
data ChatFunctionCall = ChatFunctionCall {
- chfcName :: Text
- chfcArguments :: Value
}
data ChatMessage = ChatMessage {
- chmContent :: Maybe Text
- chmRole :: Text
- chmFunctionCall :: Maybe ChatFunctionCall
- chmName :: Maybe Text
}
data ChatCompletionRequest = ChatCompletionRequest {
- chcrModel :: ModelId
- chcrMessages :: [ChatMessage]
- chcrFunctions :: Maybe [ChatFunction]
- chcrTemperature :: Maybe Double
- chcrTopP :: Maybe Double
- chcrN :: Maybe Int
- chcrStream :: Maybe Bool
- chcrStop :: Maybe (Vector Text)
- chcrMaxTokens :: Maybe Int
- chcrPresencePenalty :: Maybe Double
- chcrFrequencyPenalty :: Maybe Double
- chcrLogitBias :: Maybe (Vector Double)
- chcrUser :: Maybe String
}
data ChatChoice = ChatChoice {
- chchIndex :: Int
- chchMessage :: ChatMessage
- chchFinishReason :: Maybe Text
}
data ChatResponse = ChatResponse {
- chrId :: Text
- chrObject :: Text
- chrCreated :: Int
- chrChoices :: [ChatChoice]
- chrUsage :: Usage
}
defaultChatCompletionRequest :: ModelId -> [ChatMessage] -> ChatCompletionRequest
data EditCreate = EditCreate {
- edcrModel :: ModelId
- edcrInput :: Maybe Text
- edcrInstruction :: Text
- edcrN :: Maybe Int
- edcrTemperature :: Maybe Double
- edcrTopP :: Maybe Double
}
data EditChoice = EditChoice {
- edchText :: Text
- edchIndex :: Int
}
data EditResponse = EditResponse {
- edrObject :: Text
- edrCreated :: Int
- edrChoices :: [EditChoice]
- edrUsage :: Usage
}
defaultEditCreate :: ModelId -> Text -> Text -> EditCreate
data ImageResponse = ImageResponse {
- irCreated :: TimeStamp
- irData :: [ImageResponseData]
}
data ImageResponseData = ImageResponseData {
- irdUrl :: Text
}
data ImageCreate = ImageCreate {
- icPrompt :: Text
- icN :: Maybe Int
- icSize :: Maybe Text
- icResponseFormat :: Maybe Text
- icUser :: Maybe Text
}
data ImageEditRequest = ImageEditRequest {
- ierImage :: Text
- ierMask :: Maybe Text
- ierPrompt :: Text
- ierN :: Maybe Int
- ierSize :: Maybe Text
- ierResponseFormat :: Maybe Text
- ierUser :: Maybe Text
}
data ImageVariationRequest = ImageVariationRequest {
- ivrImage :: Text
- ivrN :: Maybe Int
- ivrSize :: Maybe Text
- ivrResponseFormat :: Maybe Text
- ivrUser :: Maybe Text
}
data EmbeddingCreate = EmbeddingCreate {
- embcModel :: ModelId
- embcInput :: Text
- embcUser :: Maybe Text
}
data EmbeddingResponseData = EmbeddingResponseData {
- embdObject :: Text
- embdEmbedding :: Vector Double
- embdIndex :: Int
}
data EmbeddingUsage = EmbeddingUsage {
- embuPromptTokens :: Int
- embuTotalTokens :: Int
}
data EmbeddingResponse = EmbeddingResponse {
- embrObject :: Text
- embrData :: [EmbeddingResponseData]
- embrModel :: ModelId
- embrUsage :: EmbeddingUsage
}
data AudioResponseData = AudioResponseData {
- audrdText :: Text
}
data AudioTranscriptionRequest = AudioTranscriptionRequest {
- audtsrFile :: FilePath
- audtsrModel :: ModelId
- audtsrPrompt :: Maybe Text
- audtsrResponseFormat :: Maybe Text
- audtsrTemperature :: Maybe Double
- audtsrLanguage :: Maybe Text
}
data AudioTranslationRequest = AudioTranslationRequest {
- audtlrFile :: FilePath
- audtlrModel :: ModelId
- audtlrPrompt :: Maybe Text
- audtlrResponseFormat :: Maybe Text
- audtlrTemperature :: Maybe Double
}
newtype FineTuneId = FineTuneId {
- unFineTuneId :: Text
}
data FineTuneCreate = FineTuneCreate {
- ftcTrainingFile :: FileId
- ftcValidationFile :: Maybe FileId
- ftcModel :: Maybe Text
- ftcBatchSize :: Maybe Int
- ftcNEpochs :: Maybe Text
- ftcLearningRateMultiplier :: Maybe Double
- ftcPromptLossWeight :: Maybe Double
- ftcComputeClassificationMetrics :: Maybe Bool
- ftcClassificationNClasses :: Maybe Int
- ftcClassificationPositiveClass :: Maybe Text
}
defaultFineTuneCreate :: FileId -> FineTuneCreate
data FineTune = FineTune {
- ftId :: FineTuneId
- ftModel :: Text
- ftCreatedAt :: Int
- ftEvents :: Vector FineTuneEvent
- ftTunedModel :: Maybe Text
- ftStatus :: Text
}
data FineTuneEvent = FineTuneEvent {
- fteCreatedAt :: Int
- fteLevel :: Text
- fteMessage :: Text
}
data FileCreate = FileCreate {
- fcPurpose :: Text
- fcDocuments :: [FileHunk]
}
newtype FileId = FileId {
- unFileId :: Text
}
data File = File {
- fId :: FileId
- fObject :: Text
- fBytes :: Int
- fCreatedAt :: TimeStamp
- fFilename :: Text
- fPurpose :: Text
}
data FileHunk = FhFineTune FineTuneHunk
data FineTuneHunk = FineTuneHunk {
- fthPrompt :: Text
- fthCompletion :: Text
}
data FileDeleteConfirmation = FileDeleteConfirmation {
- fdcId :: FileId
}
newtype EngineId = EngineId {
- unEngineId :: Text
}
data Engine = Engine {
- eId :: EngineId
- eOwner :: Text
- eReady :: Bool
}
newtype TextCompletionId = TextCompletionId {
- unTextCompletionId :: Text
}
data TextCompletionChoice = TextCompletionChoice {
- tccText :: Text
- tccIndex :: Int
- tccLogProps :: Maybe Int
- tccFinishReason :: Text
}
data TextCompletion = TextCompletion {
- tcId :: TextCompletionId
- tcCreated :: TimeStamp
- tcModel :: Text
- tcChoices :: Vector TextCompletionChoice
}
data TextCompletionCreate = TextCompletionCreate {
- tccrPrompt :: Text
- tccrMaxTokens :: Maybe Int
- tccrTemperature :: Maybe Double
- tccrTopP :: Maybe Double
- tccrN :: Maybe Int
- tccrLogprobs :: Maybe Int
- tccrEcho :: Maybe Bool
- tccrStop :: Maybe (Vector Text)
- tccrPresencePenalty :: Maybe Double
- tccrFrequencyPenalty :: Maybe Double
- tccrBestOf :: Maybe Int
}
defaultEngineTextCompletionCreate :: Text -> TextCompletionCreate
data EngineEmbeddingCreate = EngineEmbeddingCreate {
- enecInput :: Text
}
data EngineEmbedding = EngineEmbedding {
- eneEmbedding :: Vector Double
- eneIndex :: Int
}

Core Types

newtype TimeStamp Source #

A UTCTime wrapper that has unix timestamp JSON representation

Constructors

TimeStamp
Fields unTimeStamp :: UTCTime

Instances

Instances details

FromJSON TimeStamp Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser TimeStamp # parseJSONList :: Value -> Parser [TimeStamp] #
ToJSON TimeStamp Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: TimeStamp -> Value # toEncoding :: TimeStamp -> Encoding # toJSONList :: [TimeStamp] -> Value # toEncodingList :: [TimeStamp] -> Encoding #
Show TimeStamp Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> TimeStamp -> ShowS # show :: TimeStamp -> String # showList :: [TimeStamp] -> ShowS #
Eq TimeStamp Source #
Instance details Defined in OpenAI.Resources Methods (==) :: TimeStamp -> TimeStamp -> Bool # (/=) :: TimeStamp -> TimeStamp -> Bool #
ToHttpApiData TimeStamp Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: TimeStamp -> Text # toEncodedUrlPiece :: TimeStamp -> Builder # toHeader :: TimeStamp -> ByteString # toQueryParam :: TimeStamp -> Text #

newtype OpenAIList a Source #

A Vector wrapper.

Constructors

OpenAIList
Fields olData :: Vector a

Instances

Instances details

Applicative OpenAIList Source #
Instance details Defined in OpenAI.Resources Methods pure :: a -> OpenAIList a # (<>) :: OpenAIList (a -> b) -> OpenAIList a -> OpenAIList b # liftA2 :: (a -> b -> c) -> OpenAIList a -> OpenAIList b -> OpenAIList c # (>) :: OpenAIList a -> OpenAIList b -> OpenAIList b # (<*) :: OpenAIList a -> OpenAIList b -> OpenAIList a #
Functor OpenAIList Source #
Instance details Defined in OpenAI.Resources Methods fmap :: (a -> b) -> OpenAIList a -> OpenAIList b # (<$) :: a -> OpenAIList b -> OpenAIList a #
FromJSON a => FromJSON (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser (OpenAIList a) # parseJSONList :: Value -> Parser [OpenAIList a] #
ToJSON a => ToJSON (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: OpenAIList a -> Value # toEncoding :: OpenAIList a -> Encoding # toJSONList :: [OpenAIList a] -> Value # toEncodingList :: [OpenAIList a] -> Encoding #
Monoid (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods mempty :: OpenAIList a # mappend :: OpenAIList a -> OpenAIList a -> OpenAIList a # mconcat :: [OpenAIList a] -> OpenAIList a #
Semigroup (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods (<>) :: OpenAIList a -> OpenAIList a -> OpenAIList a # sconcat :: NonEmpty (OpenAIList a) -> OpenAIList a # stimes :: Integral b => b -> OpenAIList a -> OpenAIList a #
Show a => Show (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> OpenAIList a -> ShowS # show :: OpenAIList a -> String # showList :: [OpenAIList a] -> ShowS #
Eq a => Eq (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods (==) :: OpenAIList a -> OpenAIList a -> Bool # (/=) :: OpenAIList a -> OpenAIList a -> Bool #

data Usage Source #

Constructors

Usage
Fields usPromptTokens :: Int usCompletionTokens :: Int usTotalTokens :: Int

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] #
ToJSON Usage Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: Usage -> Value # toEncoding :: Usage -> Encoding # toJSONList :: [Usage] -> Value # toEncodingList :: [Usage] -> Encoding #
Show Usage Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
Eq Usage Source #
Instance details Defined in OpenAI.Resources Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #

Models

data Model Source #

Constructors

Model
Fields mId :: ModelId mObject :: Text mOwnedBy :: Text mPermission :: [Object]

Instances

Instances details

FromJSON Model Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
ToJSON Model Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: Model -> Value # toEncoding :: Model -> Encoding # toJSONList :: [Model] -> Value # toEncodingList :: [Model] -> Encoding #
Show Model Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
Eq Model Source #
Instance details Defined in OpenAI.Resources Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #

newtype ModelId Source #

Constructors

ModelId
Fields unModelId :: Text

Instances

Instances details

FromJSON ModelId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ModelId # parseJSONList :: Value -> Parser [ModelId] #
ToJSON ModelId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ModelId -> Value # toEncoding :: ModelId -> Encoding # toJSONList :: [ModelId] -> Value # toEncodingList :: [ModelId] -> Encoding #
Show ModelId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ModelId -> ShowS # show :: ModelId -> String # showList :: [ModelId] -> ShowS #
Eq ModelId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ModelId -> ModelId -> Bool # (/=) :: ModelId -> ModelId -> Bool #
ToHttpApiData ModelId Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: ModelId -> Text # toEncodedUrlPiece :: ModelId -> Builder # toHeader :: ModelId -> ByteString # toQueryParam :: ModelId -> Text #

Completion

data CompletionCreate Source #

Constructors

CompletionCreate

Fields

Instances

Instances details

FromJSON CompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser CompletionCreate # parseJSONList :: Value -> Parser [CompletionCreate] #
ToJSON CompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: CompletionCreate -> Value # toEncoding :: CompletionCreate -> Encoding # toJSONList :: [CompletionCreate] -> Value # toEncodingList :: [CompletionCreate] -> Encoding #
Show CompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> CompletionCreate -> ShowS # show :: CompletionCreate -> String # showList :: [CompletionCreate] -> ShowS #
Eq CompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: CompletionCreate -> CompletionCreate -> Bool # (/=) :: CompletionCreate -> CompletionCreate -> Bool #

data CompletionChoice Source #

Constructors

CompletionChoice
Fields cchText :: Text cchIndex :: Int cchLogprobs :: Maybe (Vector Double) cchFinishReason :: Maybe Text

Instances

Instances details

FromJSON CompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser CompletionChoice # parseJSONList :: Value -> Parser [CompletionChoice] #
ToJSON CompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: CompletionChoice -> Value # toEncoding :: CompletionChoice -> Encoding # toJSONList :: [CompletionChoice] -> Value # toEncodingList :: [CompletionChoice] -> Encoding #
Show CompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> CompletionChoice -> ShowS # show :: CompletionChoice -> String # showList :: [CompletionChoice] -> ShowS #
Eq CompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods (==) :: CompletionChoice -> CompletionChoice -> Bool # (/=) :: CompletionChoice -> CompletionChoice -> Bool #

data CompletionResponse Source #

Constructors

CompletionResponse
Fields crId :: Text crObject :: Text crCreated :: Int crModel :: ModelId crChoices :: [CompletionChoice] crUsage :: Object

Instances

Instances details

FromJSON CompletionResponse Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser CompletionResponse # parseJSONList :: Value -> Parser [CompletionResponse] #
ToJSON CompletionResponse Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: CompletionResponse -> Value # toEncoding :: CompletionResponse -> Encoding # toJSONList :: [CompletionResponse] -> Value # toEncodingList :: [CompletionResponse] -> Encoding #
Show CompletionResponse Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> CompletionResponse -> ShowS # show :: CompletionResponse -> String # showList :: [CompletionResponse] -> ShowS #
Eq CompletionResponse Source #
Instance details Defined in OpenAI.Resources Methods (==) :: CompletionResponse -> CompletionResponse -> Bool # (/=) :: CompletionResponse -> CompletionResponse -> Bool #

defaultCompletionCreate :: ModelId -> Text -> CompletionCreate Source #

Chat

data ChatFunction Source #

Constructors

ChatFunction
Fields chfName :: Text chfDescription :: Text chfParameters :: Value

Instances

Instances details

FromJSON ChatFunction Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatFunction # parseJSONList :: Value -> Parser [ChatFunction] #
ToJSON ChatFunction Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatFunction -> Value # toEncoding :: ChatFunction -> Encoding # toJSONList :: [ChatFunction] -> Value # toEncodingList :: [ChatFunction] -> Encoding #
Show ChatFunction Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ChatFunction -> ShowS # show :: ChatFunction -> String # showList :: [ChatFunction] -> ShowS #
Eq ChatFunction Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ChatFunction -> ChatFunction -> Bool # (/=) :: ChatFunction -> ChatFunction -> Bool #

data ChatFunctionCall Source #

Constructors

ChatFunctionCall
Fields chfcName :: Text chfcArguments :: Value

Instances

Instances details

FromJSON ChatFunctionCall Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatFunctionCall # parseJSONList :: Value -> Parser [ChatFunctionCall] #
ToJSON ChatFunctionCall Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatFunctionCall -> Value # toEncoding :: ChatFunctionCall -> Encoding # toJSONList :: [ChatFunctionCall] -> Value # toEncodingList :: [ChatFunctionCall] -> Encoding #
Show ChatFunctionCall Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ChatFunctionCall -> ShowS # show :: ChatFunctionCall -> String # showList :: [ChatFunctionCall] -> ShowS #
Eq ChatFunctionCall Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ChatFunctionCall -> ChatFunctionCall -> Bool # (/=) :: ChatFunctionCall -> ChatFunctionCall -> Bool #

data ChatMessage Source #

Constructors

ChatMessage
Fields chmContent :: Maybe Text chmRole :: Text chmFunctionCall :: Maybe ChatFunctionCall chmName :: Maybe Text

Instances

Instances details

FromJSON ChatMessage Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatMessage # parseJSONList :: Value -> Parser [ChatMessage] #
ToJSON ChatMessage Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatMessage -> Value # toEncoding :: ChatMessage -> Encoding # toJSONList :: [ChatMessage] -> Value # toEncodingList :: [ChatMessage] -> Encoding #
Show ChatMessage Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ChatMessage -> ShowS # show :: ChatMessage -> String # showList :: [ChatMessage] -> ShowS #
Eq ChatMessage Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ChatMessage -> ChatMessage -> Bool # (/=) :: ChatMessage -> ChatMessage -> Bool #

data ChatCompletionRequest Source #

Constructors

ChatCompletionRequest

Fields

Instances

Instances details

FromJSON ChatCompletionRequest Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatCompletionRequest # parseJSONList :: Value -> Parser [ChatCompletionRequest] #
ToJSON ChatCompletionRequest Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatCompletionRequest -> Value # toEncoding :: ChatCompletionRequest -> Encoding # toJSONList :: [ChatCompletionRequest] -> Value # toEncodingList :: [ChatCompletionRequest] -> Encoding #
Show ChatCompletionRequest Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ChatCompletionRequest -> ShowS # show :: ChatCompletionRequest -> String # showList :: [ChatCompletionRequest] -> ShowS #
Eq ChatCompletionRequest Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ChatCompletionRequest -> ChatCompletionRequest -> Bool # (/=) :: ChatCompletionRequest -> ChatCompletionRequest -> Bool #

data ChatChoice Source #

Constructors

ChatChoice
Fields chchIndex :: Int chchMessage :: ChatMessage chchFinishReason :: Maybe Text

Instances

Instances details

FromJSON ChatChoice Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatChoice # parseJSONList :: Value -> Parser [ChatChoice] #
ToJSON ChatChoice Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatChoice -> Value # toEncoding :: ChatChoice -> Encoding # toJSONList :: [ChatChoice] -> Value # toEncodingList :: [ChatChoice] -> Encoding #
Show ChatChoice Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ChatChoice -> ShowS # show :: ChatChoice -> String # showList :: [ChatChoice] -> ShowS #
Eq ChatChoice Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ChatChoice -> ChatChoice -> Bool # (/=) :: ChatChoice -> ChatChoice -> Bool #

data ChatResponse Source #

Constructors

ChatResponse
Fields chrId :: Text chrObject :: Text chrCreated :: Int chrChoices :: [ChatChoice] chrUsage :: Usage

Instances

Instances details

FromJSON ChatResponse Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ChatResponse # parseJSONList :: Value -> Parser [ChatResponse] #
ToJSON ChatResponse Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ChatResponse -> Value # toEncoding :: ChatResponse -> Encoding # toJSONList :: [ChatResponse] -> Value # toEncodingList :: [ChatResponse] -> Encoding #

defaultChatCompletionRequest :: ModelId -> [ChatMessage] -> ChatCompletionRequest Source #

Edits

data EditCreate Source #

Constructors

EditCreate
Fields edcrModel :: ModelId edcrInput :: Maybe Text edcrInstruction :: Text edcrN :: Maybe Int edcrTemperature :: Maybe Double edcrTopP :: Maybe Double

Instances

Instances details

FromJSON EditCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EditCreate # parseJSONList :: Value -> Parser [EditCreate] #
ToJSON EditCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EditCreate -> Value # toEncoding :: EditCreate -> Encoding # toJSONList :: [EditCreate] -> Value # toEncodingList :: [EditCreate] -> Encoding #
Show EditCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EditCreate -> ShowS # show :: EditCreate -> String # showList :: [EditCreate] -> ShowS #
Eq EditCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EditCreate -> EditCreate -> Bool # (/=) :: EditCreate -> EditCreate -> Bool #

data EditChoice Source #

Constructors

EditChoice
Fields edchText :: Text edchIndex :: Int

Instances

Instances details

FromJSON EditChoice Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EditChoice # parseJSONList :: Value -> Parser [EditChoice] #
ToJSON EditChoice Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EditChoice -> Value # toEncoding :: EditChoice -> Encoding # toJSONList :: [EditChoice] -> Value # toEncodingList :: [EditChoice] -> Encoding #
Show EditChoice Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EditChoice -> ShowS # show :: EditChoice -> String # showList :: [EditChoice] -> ShowS #
Eq EditChoice Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EditChoice -> EditChoice -> Bool # (/=) :: EditChoice -> EditChoice -> Bool #

data EditResponse Source #

Constructors

EditResponse
Fields edrObject :: Text edrCreated :: Int edrChoices :: [EditChoice] edrUsage :: Usage

Instances

Instances details

FromJSON EditResponse Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EditResponse # parseJSONList :: Value -> Parser [EditResponse] #
ToJSON EditResponse Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EditResponse -> Value # toEncoding :: EditResponse -> Encoding # toJSONList :: [EditResponse] -> Value # toEncodingList :: [EditResponse] -> Encoding #
Show EditResponse Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EditResponse -> ShowS # show :: EditResponse -> String # showList :: [EditResponse] -> ShowS #
Eq EditResponse Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EditResponse -> EditResponse -> Bool # (/=) :: EditResponse -> EditResponse -> Bool #

defaultEditCreate :: ModelId -> Text -> Text -> EditCreate Source #

Images

data ImageResponse Source #

Constructors

ImageResponse
Fields irCreated :: TimeStamp irData :: [ImageResponseData]

Instances

Instances details

FromJSON ImageResponse Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ImageResponse # parseJSONList :: Value -> Parser [ImageResponse] #
ToJSON ImageResponse Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ImageResponse -> Value # toEncoding :: ImageResponse -> Encoding # toJSONList :: [ImageResponse] -> Value # toEncodingList :: [ImageResponse] -> Encoding #
Show ImageResponse Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ImageResponse -> ShowS # show :: ImageResponse -> String # showList :: [ImageResponse] -> ShowS #
Eq ImageResponse Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ImageResponse -> ImageResponse -> Bool # (/=) :: ImageResponse -> ImageResponse -> Bool #

data ImageResponseData Source #

Constructors

ImageResponseData
Fields irdUrl :: Text

Instances

Instances details

FromJSON ImageResponseData Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ImageResponseData # parseJSONList :: Value -> Parser [ImageResponseData] #
ToJSON ImageResponseData Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ImageResponseData -> Value # toEncoding :: ImageResponseData -> Encoding # toJSONList :: [ImageResponseData] -> Value # toEncodingList :: [ImageResponseData] -> Encoding #
Show ImageResponseData Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ImageResponseData -> ShowS # show :: ImageResponseData -> String # showList :: [ImageResponseData] -> ShowS #
Eq ImageResponseData Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ImageResponseData -> ImageResponseData -> Bool # (/=) :: ImageResponseData -> ImageResponseData -> Bool #

data ImageCreate Source #

Image create API

Constructors

ImageCreate
Fields icPrompt :: Text icN :: Maybe Int icSize :: Maybe Text icResponseFormat :: Maybe Text icUser :: Maybe Text

Instances

Instances details

FromJSON ImageCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ImageCreate # parseJSONList :: Value -> Parser [ImageCreate] #
ToJSON ImageCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ImageCreate -> Value # toEncoding :: ImageCreate -> Encoding # toJSONList :: [ImageCreate] -> Value # toEncodingList :: [ImageCreate] -> Encoding #
Show ImageCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ImageCreate -> ShowS # show :: ImageCreate -> String # showList :: [ImageCreate] -> ShowS #
Eq ImageCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ImageCreate -> ImageCreate -> Bool # (/=) :: ImageCreate -> ImageCreate -> Bool #

data ImageEditRequest Source #

Image edit API

Constructors

ImageEditRequest
Fields ierImage :: Text ierMask :: Maybe Text ierPrompt :: Text ierN :: Maybe Int ierSize :: Maybe Text ierResponseFormat :: Maybe Text ierUser :: Maybe Text

Instances

Instances details

FromJSON ImageEditRequest Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ImageEditRequest # parseJSONList :: Value -> Parser [ImageEditRequest] #
ToJSON ImageEditRequest Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ImageEditRequest -> Value # toEncoding :: ImageEditRequest -> Encoding # toJSONList :: [ImageEditRequest] -> Value # toEncodingList :: [ImageEditRequest] -> Encoding #
Show ImageEditRequest Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ImageEditRequest -> ShowS # show :: ImageEditRequest -> String # showList :: [ImageEditRequest] -> ShowS #
Eq ImageEditRequest Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ImageEditRequest -> ImageEditRequest -> Bool # (/=) :: ImageEditRequest -> ImageEditRequest -> Bool #

data ImageVariationRequest Source #

Image variation API

Constructors

ImageVariationRequest
Fields ivrImage :: Text ivrN :: Maybe Int ivrSize :: Maybe Text ivrResponseFormat :: Maybe Text ivrUser :: Maybe Text

Instances

Instances details

FromJSON ImageVariationRequest Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser ImageVariationRequest # parseJSONList :: Value -> Parser [ImageVariationRequest] #
ToJSON ImageVariationRequest Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: ImageVariationRequest -> Value # toEncoding :: ImageVariationRequest -> Encoding # toJSONList :: [ImageVariationRequest] -> Value # toEncodingList :: [ImageVariationRequest] -> Encoding #
Show ImageVariationRequest Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> ImageVariationRequest -> ShowS # show :: ImageVariationRequest -> String # showList :: [ImageVariationRequest] -> ShowS #
Eq ImageVariationRequest Source #
Instance details Defined in OpenAI.Resources Methods (==) :: ImageVariationRequest -> ImageVariationRequest -> Bool # (/=) :: ImageVariationRequest -> ImageVariationRequest -> Bool #

Embeddings

data EmbeddingCreate Source #

Constructors

EmbeddingCreate
Fields embcModel :: ModelId embcInput :: Text embcUser :: Maybe Text

Instances

Instances details

FromJSON EmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EmbeddingCreate # parseJSONList :: Value -> Parser [EmbeddingCreate] #
ToJSON EmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EmbeddingCreate -> Value # toEncoding :: EmbeddingCreate -> Encoding # toJSONList :: [EmbeddingCreate] -> Value # toEncodingList :: [EmbeddingCreate] -> Encoding #
Show EmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EmbeddingCreate -> ShowS # show :: EmbeddingCreate -> String # showList :: [EmbeddingCreate] -> ShowS #
Eq EmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EmbeddingCreate -> EmbeddingCreate -> Bool # (/=) :: EmbeddingCreate -> EmbeddingCreate -> Bool #

data EmbeddingResponseData Source #

Constructors

EmbeddingResponseData
Fields embdObject :: Text embdEmbedding :: Vector Double embdIndex :: Int

Instances

Instances details

FromJSON EmbeddingResponseData Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EmbeddingResponseData # parseJSONList :: Value -> Parser [EmbeddingResponseData] #
ToJSON EmbeddingResponseData Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EmbeddingResponseData -> Value # toEncoding :: EmbeddingResponseData -> Encoding # toJSONList :: [EmbeddingResponseData] -> Value # toEncodingList :: [EmbeddingResponseData] -> Encoding #
Show EmbeddingResponseData Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EmbeddingResponseData -> ShowS # show :: EmbeddingResponseData -> String # showList :: [EmbeddingResponseData] -> ShowS #
Eq EmbeddingResponseData Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EmbeddingResponseData -> EmbeddingResponseData -> Bool # (/=) :: EmbeddingResponseData -> EmbeddingResponseData -> Bool #

data EmbeddingUsage Source #

Constructors

EmbeddingUsage
Fields embuPromptTokens :: Int embuTotalTokens :: Int

Instances

Instances details

FromJSON EmbeddingUsage Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EmbeddingUsage # parseJSONList :: Value -> Parser [EmbeddingUsage] #
ToJSON EmbeddingUsage Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EmbeddingUsage -> Value # toEncoding :: EmbeddingUsage -> Encoding # toJSONList :: [EmbeddingUsage] -> Value # toEncodingList :: [EmbeddingUsage] -> Encoding #
Show EmbeddingUsage Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EmbeddingUsage -> ShowS # show :: EmbeddingUsage -> String # showList :: [EmbeddingUsage] -> ShowS #
Eq EmbeddingUsage Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EmbeddingUsage -> EmbeddingUsage -> Bool # (/=) :: EmbeddingUsage -> EmbeddingUsage -> Bool #

data EmbeddingResponse Source #

Constructors

EmbeddingResponse
Fields embrObject :: Text embrData :: [EmbeddingResponseData] embrModel :: ModelId embrUsage :: EmbeddingUsage

Instances

Instances details

FromJSON EmbeddingResponse Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EmbeddingResponse # parseJSONList :: Value -> Parser [EmbeddingResponse] #
ToJSON EmbeddingResponse Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EmbeddingResponse -> Value # toEncoding :: EmbeddingResponse -> Encoding # toJSONList :: [EmbeddingResponse] -> Value # toEncodingList :: [EmbeddingResponse] -> Encoding #
Show EmbeddingResponse Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EmbeddingResponse -> ShowS # show :: EmbeddingResponse -> String # showList :: [EmbeddingResponse] -> ShowS #
Eq EmbeddingResponse Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EmbeddingResponse -> EmbeddingResponse -> Bool # (/=) :: EmbeddingResponse -> EmbeddingResponse -> Bool #

Audio

data AudioResponseData Source #

Constructors

AudioResponseData
Fields audrdText :: Text

Instances

Instances details

FromJSON AudioResponseData Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser AudioResponseData # parseJSONList :: Value -> Parser [AudioResponseData] #
ToJSON AudioResponseData Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: AudioResponseData -> Value # toEncoding :: AudioResponseData -> Encoding # toJSONList :: [AudioResponseData] -> Value # toEncodingList :: [AudioResponseData] -> Encoding #
Show AudioResponseData Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> AudioResponseData -> ShowS # show :: AudioResponseData -> String # showList :: [AudioResponseData] -> ShowS #
Eq AudioResponseData Source #
Instance details Defined in OpenAI.Resources Methods (==) :: AudioResponseData -> AudioResponseData -> Bool # (/=) :: AudioResponseData -> AudioResponseData -> Bool #

data AudioTranscriptionRequest Source #

Audio create API

Constructors

AudioTranscriptionRequest
Fields audtsrFile :: FilePath audtsrModel :: ModelId audtsrPrompt :: Maybe Text audtsrResponseFormat :: Maybe Text audtsrTemperature :: Maybe Double audtsrLanguage :: Maybe Text

Instances

Instances details

FromJSON AudioTranscriptionRequest Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser AudioTranscriptionRequest # parseJSONList :: Value -> Parser [AudioTranscriptionRequest] #
ToJSON AudioTranscriptionRequest Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: AudioTranscriptionRequest -> Value # toEncoding :: AudioTranscriptionRequest -> Encoding # toJSONList :: [AudioTranscriptionRequest] -> Value # toEncodingList :: [AudioTranscriptionRequest] -> Encoding #
Show AudioTranscriptionRequest Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> AudioTranscriptionRequest -> ShowS # show :: AudioTranscriptionRequest -> String # showList :: [AudioTranscriptionRequest] -> ShowS #
Eq AudioTranscriptionRequest Source #
Instance details Defined in OpenAI.Resources Methods (==) :: AudioTranscriptionRequest -> AudioTranscriptionRequest -> Bool # (/=) :: AudioTranscriptionRequest -> AudioTranscriptionRequest -> Bool #
ToMultipart Tmp AudioTranscriptionRequest Source #
Instance details Defined in OpenAI.Resources Methods toMultipart :: AudioTranscriptionRequest -> MultipartData Tmp #

data AudioTranslationRequest Source #

Audio translation API

Constructors

AudioTranslationRequest
Fields audtlrFile :: FilePath audtlrModel :: ModelId audtlrPrompt :: Maybe Text audtlrResponseFormat :: Maybe Text audtlrTemperature :: Maybe Double

Instances

Instances details

FromJSON AudioTranslationRequest Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser AudioTranslationRequest # parseJSONList :: Value -> Parser [AudioTranslationRequest] #
ToJSON AudioTranslationRequest Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: AudioTranslationRequest -> Value # toEncoding :: AudioTranslationRequest -> Encoding # toJSONList :: [AudioTranslationRequest] -> Value # toEncodingList :: [AudioTranslationRequest] -> Encoding #
Show AudioTranslationRequest Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> AudioTranslationRequest -> ShowS # show :: AudioTranslationRequest -> String # showList :: [AudioTranslationRequest] -> ShowS #
Eq AudioTranslationRequest Source #
Instance details Defined in OpenAI.Resources Methods (==) :: AudioTranslationRequest -> AudioTranslationRequest -> Bool # (/=) :: AudioTranslationRequest -> AudioTranslationRequest -> Bool #
ToMultipart Tmp AudioTranslationRequest Source #
Instance details Defined in OpenAI.Resources Methods toMultipart :: AudioTranslationRequest -> MultipartData Tmp #

Fine tuning (out of date)

newtype FineTuneId Source #

Constructors

FineTuneId
Fields unFineTuneId :: Text

Instances

Instances details

FromJSON FineTuneId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FineTuneId # parseJSONList :: Value -> Parser [FineTuneId] #
ToJSON FineTuneId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FineTuneId -> Value # toEncoding :: FineTuneId -> Encoding # toJSONList :: [FineTuneId] -> Value # toEncodingList :: [FineTuneId] -> Encoding #
Show FineTuneId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FineTuneId -> ShowS # show :: FineTuneId -> String # showList :: [FineTuneId] -> ShowS #
Eq FineTuneId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FineTuneId -> FineTuneId -> Bool # (/=) :: FineTuneId -> FineTuneId -> Bool #
ToHttpApiData FineTuneId Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: FineTuneId -> Text # toEncodedUrlPiece :: FineTuneId -> Builder # toHeader :: FineTuneId -> ByteString # toQueryParam :: FineTuneId -> Text #

data FineTuneCreate Source #

Constructors

FineTuneCreate
Fields ftcTrainingFile :: FileId ftcValidationFile :: Maybe FileId ftcModel :: Maybe Text ftcBatchSize :: Maybe Int ftcNEpochs :: Maybe Text ftcLearningRateMultiplier :: Maybe Double ftcPromptLossWeight :: Maybe Double ftcComputeClassificationMetrics :: Maybe Bool ftcClassificationNClasses :: Maybe Int ftcClassificationPositiveClass :: Maybe Text

Instances

Instances details

FromJSON FineTuneCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FineTuneCreate # parseJSONList :: Value -> Parser [FineTuneCreate] #
ToJSON FineTuneCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FineTuneCreate -> Value # toEncoding :: FineTuneCreate -> Encoding # toJSONList :: [FineTuneCreate] -> Value # toEncodingList :: [FineTuneCreate] -> Encoding #
Show FineTuneCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FineTuneCreate -> ShowS # show :: FineTuneCreate -> String # showList :: [FineTuneCreate] -> ShowS #
Eq FineTuneCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FineTuneCreate -> FineTuneCreate -> Bool # (/=) :: FineTuneCreate -> FineTuneCreate -> Bool #

defaultFineTuneCreate :: FileId -> FineTuneCreate Source #

data FineTune Source #

Constructors

FineTune
Fields ftId :: FineTuneId ftModel :: Text ftCreatedAt :: Int ftEvents :: Vector FineTuneEvent ftTunedModel :: Maybe Text ftStatus :: Text

Instances

Instances details

FromJSON FineTune Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FineTune # parseJSONList :: Value -> Parser [FineTune] #
ToJSON FineTune Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FineTune -> Value # toEncoding :: FineTune -> Encoding # toJSONList :: [FineTune] -> Value # toEncodingList :: [FineTune] -> Encoding #
Show FineTune Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FineTune -> ShowS # show :: FineTune -> String # showList :: [FineTune] -> ShowS #
Eq FineTune Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FineTune -> FineTune -> Bool # (/=) :: FineTune -> FineTune -> Bool #

data FineTuneEvent Source #

Constructors

FineTuneEvent
Fields fteCreatedAt :: Int fteLevel :: Text fteMessage :: Text

Instances

Instances details

FromJSON FineTuneEvent Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FineTuneEvent # parseJSONList :: Value -> Parser [FineTuneEvent] #
ToJSON FineTuneEvent Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FineTuneEvent -> Value # toEncoding :: FineTuneEvent -> Encoding # toJSONList :: [FineTuneEvent] -> Value # toEncodingList :: [FineTuneEvent] -> Encoding #
Show FineTuneEvent Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FineTuneEvent -> ShowS # show :: FineTuneEvent -> String # showList :: [FineTuneEvent] -> ShowS #
Eq FineTuneEvent Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FineTuneEvent -> FineTuneEvent -> Bool # (/=) :: FineTuneEvent -> FineTuneEvent -> Bool #

File API (out of date)

data FileCreate Source #

File upload API

Constructors

FileCreate
Fields fcPurpose :: Text fcDocuments :: [FileHunk]

Instances

Instances details

Show FileCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileCreate -> ShowS # show :: FileCreate -> String # showList :: [FileCreate] -> ShowS #
Eq FileCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileCreate -> FileCreate -> Bool # (/=) :: FileCreate -> FileCreate -> Bool #
ToMultipart Mem FileCreate Source #
Instance details Defined in OpenAI.Resources Methods toMultipart :: FileCreate -> MultipartData Mem #

newtype FileId Source #

Constructors

FileId
Fields unFileId :: Text

Instances

Instances details

FromJSON FileId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FileId # parseJSONList :: Value -> Parser [FileId] #
ToJSON FileId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FileId -> Value # toEncoding :: FileId -> Encoding # toJSONList :: [FileId] -> Value # toEncodingList :: [FileId] -> Encoding #
Show FileId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileId -> ShowS # show :: FileId -> String # showList :: [FileId] -> ShowS #
Eq FileId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileId -> FileId -> Bool # (/=) :: FileId -> FileId -> Bool #
ToHttpApiData FileId Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: FileId -> Text # toEncodedUrlPiece :: FileId -> Builder # toHeader :: FileId -> ByteString # toQueryParam :: FileId -> Text #

data File Source #

Constructors

File
Fields fId :: FileId fObject :: Text fBytes :: Int fCreatedAt :: TimeStamp fFilename :: Text fPurpose :: Text

Instances

Instances details

FromJSON File Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser File # parseJSONList :: Value -> Parser [File] #
ToJSON File Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: File -> Value # toEncoding :: File -> Encoding # toJSONList :: [File] -> Value # toEncodingList :: [File] -> Encoding #
Show File Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> File -> ShowS # show :: File -> String # showList :: [File] -> ShowS #
Eq File Source #
Instance details Defined in OpenAI.Resources Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #

data FileHunk Source #

Constructors

FhFineTune FineTuneHunk

Instances

Instances details

Show FileHunk Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileHunk -> ShowS # show :: FileHunk -> String # showList :: [FileHunk] -> ShowS #
Eq FileHunk Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileHunk -> FileHunk -> Bool # (/=) :: FileHunk -> FileHunk -> Bool #

data FineTuneHunk Source #

Constructors

FineTuneHunk
Fields fthPrompt :: Text fthCompletion :: Text

Instances

Instances details

FromJSON FineTuneHunk Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FineTuneHunk # parseJSONList :: Value -> Parser [FineTuneHunk] #
ToJSON FineTuneHunk Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FineTuneHunk -> Value # toEncoding :: FineTuneHunk -> Encoding # toJSONList :: [FineTuneHunk] -> Value # toEncodingList :: [FineTuneHunk] -> Encoding #
Show FineTuneHunk Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FineTuneHunk -> ShowS # show :: FineTuneHunk -> String # showList :: [FineTuneHunk] -> ShowS #
Eq FineTuneHunk Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FineTuneHunk -> FineTuneHunk -> Bool # (/=) :: FineTuneHunk -> FineTuneHunk -> Bool #

data FileDeleteConfirmation Source #

File delete API

Constructors

FileDeleteConfirmation
Fields fdcId :: FileId

Instances

Instances details

FromJSON FileDeleteConfirmation Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FileDeleteConfirmation # parseJSONList :: Value -> Parser [FileDeleteConfirmation] #
ToJSON FileDeleteConfirmation Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FileDeleteConfirmation -> Value # toEncoding :: FileDeleteConfirmation -> Encoding # toJSONList :: [FileDeleteConfirmation] -> Value # toEncodingList :: [FileDeleteConfirmation] -> Encoding #
Show FileDeleteConfirmation Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileDeleteConfirmation -> ShowS # show :: FileDeleteConfirmation -> String # showList :: [FileDeleteConfirmation] -> ShowS #
Eq FileDeleteConfirmation Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileDeleteConfirmation -> FileDeleteConfirmation -> Bool # (/=) :: FileDeleteConfirmation -> FileDeleteConfirmation -> Bool #

Engine (deprecated)

newtype EngineId Source #

File retrieve API TODO

File retrieve content API TODO

Constructors

EngineId
Fields unEngineId :: Text

Instances

Instances details

FromJSON EngineId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EngineId # parseJSONList :: Value -> Parser [EngineId] #
ToJSON EngineId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EngineId -> Value # toEncoding :: EngineId -> Encoding # toJSONList :: [EngineId] -> Value # toEncodingList :: [EngineId] -> Encoding #
Show EngineId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EngineId -> ShowS # show :: EngineId -> String # showList :: [EngineId] -> ShowS #
Eq EngineId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EngineId -> EngineId -> Bool # (/=) :: EngineId -> EngineId -> Bool #
ToHttpApiData EngineId Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: EngineId -> Text # toEncodedUrlPiece :: EngineId -> Builder # toHeader :: EngineId -> ByteString # toQueryParam :: EngineId -> Text #

data Engine Source #

Constructors

Engine
Fields eId :: EngineId eOwner :: Text eReady :: Bool

Instances

Instances details

FromJSON Engine Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser Engine # parseJSONList :: Value -> Parser [Engine] #
ToJSON Engine Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: Engine -> Value # toEncoding :: Engine -> Encoding # toJSONList :: [Engine] -> Value # toEncodingList :: [Engine] -> Encoding #
Show Engine Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> Engine -> ShowS # show :: Engine -> String # showList :: [Engine] -> ShowS #
Eq Engine Source #
Instance details Defined in OpenAI.Resources Methods (==) :: Engine -> Engine -> Bool # (/=) :: Engine -> Engine -> Bool #

Engine text completion (deprecated)

newtype TextCompletionId Source #

Constructors

TextCompletionId
Fields unTextCompletionId :: Text

Instances

Instances details

FromJSON TextCompletionId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser TextCompletionId # parseJSONList :: Value -> Parser [TextCompletionId] #
ToJSON TextCompletionId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: TextCompletionId -> Value # toEncoding :: TextCompletionId -> Encoding # toJSONList :: [TextCompletionId] -> Value # toEncodingList :: [TextCompletionId] -> Encoding #
Show TextCompletionId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> TextCompletionId -> ShowS # show :: TextCompletionId -> String # showList :: [TextCompletionId] -> ShowS #
Eq TextCompletionId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: TextCompletionId -> TextCompletionId -> Bool # (/=) :: TextCompletionId -> TextCompletionId -> Bool #
ToHttpApiData TextCompletionId Source #
Instance details Defined in OpenAI.Resources Methods toUrlPiece :: TextCompletionId -> Text # toEncodedUrlPiece :: TextCompletionId -> Builder # toHeader :: TextCompletionId -> ByteString # toQueryParam :: TextCompletionId -> Text #

data TextCompletionChoice Source #

Constructors

TextCompletionChoice
Fields tccText :: Text tccIndex :: Int tccLogProps :: Maybe Int tccFinishReason :: Text

Instances

Instances details

FromJSON TextCompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser TextCompletionChoice # parseJSONList :: Value -> Parser [TextCompletionChoice] #
ToJSON TextCompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: TextCompletionChoice -> Value # toEncoding :: TextCompletionChoice -> Encoding # toJSONList :: [TextCompletionChoice] -> Value # toEncodingList :: [TextCompletionChoice] -> Encoding #
Show TextCompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> TextCompletionChoice -> ShowS # show :: TextCompletionChoice -> String # showList :: [TextCompletionChoice] -> ShowS #
Eq TextCompletionChoice Source #
Instance details Defined in OpenAI.Resources Methods (==) :: TextCompletionChoice -> TextCompletionChoice -> Bool # (/=) :: TextCompletionChoice -> TextCompletionChoice -> Bool #

data TextCompletion Source #

Constructors

TextCompletion
Fields tcId :: TextCompletionId tcCreated :: TimeStamp tcModel :: Text tcChoices :: Vector TextCompletionChoice

Instances

Instances details

FromJSON TextCompletion Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser TextCompletion # parseJSONList :: Value -> Parser [TextCompletion] #
ToJSON TextCompletion Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: TextCompletion -> Value # toEncoding :: TextCompletion -> Encoding # toJSONList :: [TextCompletion] -> Value # toEncodingList :: [TextCompletion] -> Encoding #
Show TextCompletion Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> TextCompletion -> ShowS # show :: TextCompletion -> String # showList :: [TextCompletion] -> ShowS #
Eq TextCompletion Source #
Instance details Defined in OpenAI.Resources Methods (==) :: TextCompletion -> TextCompletion -> Bool # (/=) :: TextCompletion -> TextCompletion -> Bool #

data TextCompletionCreate Source #

Constructors

TextCompletionCreate
Fields tccrPrompt :: Text tccrMaxTokens :: Maybe Int tccrTemperature :: Maybe Double tccrTopP :: Maybe Double tccrN :: Maybe Int tccrLogprobs :: Maybe Int tccrEcho :: Maybe Bool tccrStop :: Maybe (Vector Text) tccrPresencePenalty :: Maybe Double tccrFrequencyPenalty :: Maybe Double tccrBestOf :: Maybe Int

Instances

Instances details

FromJSON TextCompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser TextCompletionCreate # parseJSONList :: Value -> Parser [TextCompletionCreate] #
ToJSON TextCompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: TextCompletionCreate -> Value # toEncoding :: TextCompletionCreate -> Encoding # toJSONList :: [TextCompletionCreate] -> Value # toEncodingList :: [TextCompletionCreate] -> Encoding #
Show TextCompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> TextCompletionCreate -> ShowS # show :: TextCompletionCreate -> String # showList :: [TextCompletionCreate] -> ShowS #
Eq TextCompletionCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: TextCompletionCreate -> TextCompletionCreate -> Bool # (/=) :: TextCompletionCreate -> TextCompletionCreate -> Bool #

defaultEngineTextCompletionCreate :: Text -> TextCompletionCreate Source #

Applies API defaults, only passing a prompt.

Engine Embeddings (deprecated)

data EngineEmbeddingCreate Source #

Constructors

EngineEmbeddingCreate
Fields enecInput :: Text

Instances

Instances details

FromJSON EngineEmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EngineEmbeddingCreate # parseJSONList :: Value -> Parser [EngineEmbeddingCreate] #
ToJSON EngineEmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EngineEmbeddingCreate -> Value # toEncoding :: EngineEmbeddingCreate -> Encoding # toJSONList :: [EngineEmbeddingCreate] -> Value # toEncodingList :: [EngineEmbeddingCreate] -> Encoding #
Show EngineEmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EngineEmbeddingCreate -> ShowS # show :: EngineEmbeddingCreate -> String # showList :: [EngineEmbeddingCreate] -> ShowS #
Eq EngineEmbeddingCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EngineEmbeddingCreate -> EngineEmbeddingCreate -> Bool # (/=) :: EngineEmbeddingCreate -> EngineEmbeddingCreate -> Bool #

data EngineEmbedding Source #

Constructors

EngineEmbedding
Fields eneEmbedding :: Vector Double eneIndex :: Int

Instances

Instances details

FromJSON EngineEmbedding Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser EngineEmbedding # parseJSONList :: Value -> Parser [EngineEmbedding] #
ToJSON EngineEmbedding Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: EngineEmbedding -> Value # toEncoding :: EngineEmbedding -> Encoding # toJSONList :: [EngineEmbedding] -> Value # toEncodingList :: [EngineEmbedding] -> Encoding #
Show EngineEmbedding Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> EngineEmbedding -> ShowS # show :: EngineEmbedding -> String # showList :: [EngineEmbedding] -> ShowS #
Eq EngineEmbedding Source #
Instance details Defined in OpenAI.Resources Methods (==) :: EngineEmbedding -> EngineEmbedding -> Bool # (/=) :: EngineEmbedding -> EngineEmbedding -> Bool #