| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
OpenAI.V1
Description
/v1
Example usage:
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE OverloadedLists #-}
module Main where
import Data.Foldable (traverse_)
import OpenAI.V1
import OpenAI.V1.Chat.Completions
import qualified Data.Text as Text
import qualified Data.Text.IO as Text.IO
import qualified System.Environment as Environment
main :: IO ()
main = do
key <- Environment.getEnv "OPENAI_KEY"
clientEnv <- getClientEnv "https://api.openai.com"
let Methods{ createChatCompletion } = makeMethods clientEnv (Text.pack key)
text <- Text.IO.getLine
ChatCompletionObject{ choices } <- createChatCompletion _CreateChatCompletion
{ messages = [ User{ content = [ Text{ text } ], name = Nothing } ]
, model = "gpt-4o-mini"
}
let display Choice{ message } = Text.IO.putStrLn (messageToContent message)
traverse_ display choices
Synopsis
- getClientEnv :: Text -> IO ClientEnv
- makeMethods :: ClientEnv -> Text -> Methods
- data Methods = Methods {
- createSpeech :: CreateSpeech -> IO ByteString
- createTranscription :: CreateTranscription -> IO TranscriptionObject
- createTranslation :: CreateTranslation -> IO TranslationObject
- createChatCompletion :: CreateChatCompletion -> IO ChatCompletionObject
- createEmbeddings :: CreateEmbeddings -> IO (Vector EmbeddingObject)
- createFineTuningJob :: CreateFineTuningJob -> IO JobObject
- listFineTuningJobs :: Maybe Text -> Maybe Natural -> IO (Vector JobObject)
- listFineTuningEvents :: FineTuningJobID -> Maybe Text -> Maybe Natural -> IO (Vector EventObject)
- listFineTuningCheckpoints :: FineTuningJobID -> Maybe Text -> Maybe Natural -> IO (Vector CheckpointObject)
- retrieveFineTuningJob :: FineTuningJobID -> IO JobObject
- cancelFineTuning :: FineTuningJobID -> IO JobObject
- createBatch :: CreateBatch -> IO BatchObject
- retrieveBatch :: BatchID -> IO BatchObject
- cancelBatch :: BatchID -> IO BatchObject
- listBatch :: Maybe Text -> Maybe Natural -> IO (Vector BatchObject)
- uploadFile :: UploadFile -> IO FileObject
- listFiles :: Maybe Purpose -> Maybe Natural -> Maybe Order -> Maybe Text -> IO (Vector FileObject)
- retrieveFile :: FileID -> IO FileObject
- deleteFile :: FileID -> IO DeletionStatus
- retrieveFileContent :: FileID -> IO ByteString
- createUpload :: CreateUpload -> IO (UploadObject (Maybe Void))
- addUploadPart :: UploadID -> AddUploadPart -> IO PartObject
- completeUpload :: UploadID -> CompleteUpload -> IO (UploadObject FileObject)
- cancelUpload :: UploadID -> IO (UploadObject (Maybe Void))
- createImage :: CreateImage -> IO (Vector ImageObject)
- createImageEdit :: CreateImageEdit -> IO (Vector ImageObject)
- createImageVariation :: CreateImageVariation -> IO (Vector ImageObject)
- listModels :: IO (Vector ModelObject)
- retrieveModel :: Model -> IO ModelObject
- deleteModel :: Model -> IO DeletionStatus
- createModeration :: CreateModeration -> IO Moderation
- createAssistant :: CreateAssistant -> IO AssistantObject
- listAssistants :: Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> IO (Vector AssistantObject)
- retrieveAssistant :: AssistantID -> IO AssistantObject
- modifyAssistant :: AssistantID -> ModifyAssistant -> IO AssistantObject
- deleteAssistant :: AssistantID -> IO DeletionStatus
- createThread :: Thread -> IO ThreadObject
- retrieveThread :: ThreadID -> IO ThreadObject
- modifyThread :: ThreadID -> ModifyThread -> IO ThreadObject
- deleteThread :: ThreadID -> IO DeletionStatus
- createMessage :: ThreadID -> Message -> IO MessageObject
- listMessages :: ThreadID -> IO (Vector MessageObject)
- retrieveMessage :: ThreadID -> MessageID -> IO MessageObject
- modifyMessage :: ThreadID -> MessageID -> ModifyMessage -> IO MessageObject
- deleteMessage :: ThreadID -> MessageID -> IO DeletionStatus
- createRun :: ThreadID -> Maybe Text -> CreateRun -> IO RunObject
- createThreadAndRun :: CreateThreadAndRun -> IO RunObject
- listRuns :: ThreadID -> Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> IO (Vector RunObject)
- retrieveRun :: ThreadID -> RunID -> IO RunObject
- modifyRun :: ThreadID -> RunID -> ModifyRun -> IO RunObject
- submitToolOutputsToRun :: ThreadID -> RunID -> SubmitToolOutputsToRun -> IO RunObject
- cancelRun :: ThreadID -> RunID -> IO RunObject
- listRunSteps :: ThreadID -> RunID -> Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> Maybe Text -> IO (Vector RunStepObject)
- retrieveRunStep :: ThreadID -> RunID -> StepID -> Maybe Text -> IO RunStepObject
- createVectorStore :: CreateVectorStore -> IO VectorStoreObject
- listVectorStores :: Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> IO (Vector VectorStoreObject)
- retrieveVectorStore :: VectorStoreID -> IO VectorStoreObject
- modifyVectorStore :: VectorStoreID -> ModifyVectorStore -> IO VectorStoreObject
- deleteVectorStore :: VectorStoreID -> IO DeletionStatus
- createVectorStoreFile :: VectorStoreID -> CreateVectorStoreFile -> IO VectorStoreFileObject
- listVectorStoreFiles :: VectorStoreID -> Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> Maybe Status -> IO (Vector VectorStoreFileObject)
- retrieveVectorStoreFile :: VectorStoreID -> VectorStoreFileID -> IO VectorStoreFileObject
- deleteVectorStoreFile :: VectorStoreID -> VectorStoreFileID -> IO DeletionStatus
- createVectorStoreFileBatch :: VectorStoreID -> CreateVectorStoreFileBatch -> IO VectorStoreFilesBatchObject
- retrieveVectorStoreFileBatch :: VectorStoreID -> VectorStoreFileBatchID -> IO VectorStoreFilesBatchObject
- cancelVectorStoreFileBatch :: VectorStoreID -> VectorStoreFileBatchID -> IO VectorStoreFilesBatchObject
- listVectorStoreFilesInABatch :: VectorStoreID -> VectorStoreFileBatchID -> Maybe Natural -> Maybe Order -> Maybe Text -> Maybe Text -> Maybe Status -> IO (Vector VectorStoreFilesBatchObject)
- type API = Header' [Required, Strict] "Authorization" Text :> ("v1" :> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> (API :<|> API))))))))))))))))))
Methods
Convenient utility to get a ClientEnv for the most common use case
Get a record of API methods after providing an API token
API methods
Constructors