Safe Haskell	None
Language	Haskell2010

OpenAI.Client

Contents

Basics
Helper types
Engine
Text completion
Embeddings
Fine tunes
Searching
File API
Answer API

Synopsis

type ApiKey = Text
data OpenAIClient
makeOpenAIClient :: ApiKey -> Manager -> Int -> OpenAIClient
data ClientError
- = FailureResponse (RequestF () (BaseUrl, ByteString)) Response
- | DecodeFailure Text Response
- | UnsupportedContentType MediaType Response
- | InvalidContentTypeHeader Response
- | ConnectionError SomeException
newtype TimeStamp = TimeStamp {
- unTimeStamp :: UTCTime
}
newtype OpenAIList a = OpenAIList {
- olData :: Vector a
}
newtype EngineId = EngineId {
- unEngineId :: Text
}
data Engine = Engine {
- eId :: EngineId
- eOwner :: Text
- eReady :: Bool
}
listEngines :: OpenAIClient -> IO (Either ClientError (OpenAIList Engine))
getEngine :: OpenAIClient -> EngineId -> IO (Either ClientError Engine)
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
}
defaultTextCompletionCreate :: Text -> TextCompletionCreate
completeText :: OpenAIClient -> EngineId -> TextCompletionCreate -> IO (Either ClientError TextCompletion)
data EmbeddingCreate = EmbeddingCreate {
- ecInput :: Text
}
data Embedding = Embedding {
- eEmbedding :: Vector Double
- eIndex :: Int
}
createEmbedding :: OpenAIClient -> EngineId -> EmbeddingCreate -> IO (Either ClientError (OpenAIList Embedding))
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
}
createFineTune :: OpenAIClient -> FineTuneCreate -> IO (Either ClientError FineTune)
listFineTunes :: OpenAIClient -> IO (Either ClientError (OpenAIList FineTune))
getFineTune :: OpenAIClient -> FineTuneId -> IO (Either ClientError FineTune)
cancelFineTune :: OpenAIClient -> FineTuneId -> IO (Either ClientError FineTune)
listFineTuneEvents :: OpenAIClient -> FineTuneId -> IO (Either ClientError (OpenAIList FineTuneEvent))
data SearchResult = SearchResult {
- srDocument :: Int
- srScore :: Double
- srMetadata :: Maybe Text
}
data SearchResultCreate = SearchResultCreate {
- sccrFile :: Maybe FileId
- sccrDocuments :: Maybe (Vector Text)
- sccrQuery :: Text
- sccrReturnMetadata :: Bool
}
searchDocuments :: OpenAIClient -> EngineId -> SearchResultCreate -> IO (Either ClientError (OpenAIList SearchResult))
data FileCreate = FileCreate {
- fcPurpose :: Text
- fcDocuments :: [FileHunk]
}
data File = File {
- fId :: FileId
- fCreatedAt :: TimeStamp
- fPurpose :: Text
}
newtype FileId = FileId {
- unFileId :: Text
}
data FileHunk
- = FhSearch SearchHunk
- | FhClassifications ClassificationHunk
- | FhFineTune FineTuneHunk
data SearchHunk = SearchHunk {
- shText :: Text
- shMetadata :: Maybe Text
}
data ClassificationHunk = ClassificationHunk {
- chText :: Text
- chLabel :: Text
}
data FineTuneHunk = FineTuneHunk {
- fthPrompt :: Text
- fthCompletion :: Text
}
data FileDeleteConfirmation = FileDeleteConfirmation {
- fdcId :: FileId
}
createFile :: OpenAIClient -> FileCreate -> IO (Either ClientError File)
deleteFile :: OpenAIClient -> FileId -> IO (Either ClientError FileDeleteConfirmation)
getAnswer :: OpenAIClient -> AnswerReq -> IO (Either ClientError AnswerResp)
data AnswerReq = AnswerReq {
- arFile :: Maybe FileId
- arDocuments :: Maybe (Vector Text)
- arQuestion :: Text
- arSearchModel :: EngineId
- arModel :: EngineId
- arExamplesContext :: Text
- arExamples :: [[Text]]
- arReturnMetadata :: Bool
}
data AnswerResp = AnswerResp {
- arsAnswers :: [Text]
}

Basics

type ApiKey = Text Source #

Your OpenAI API key. Can be obtained from the OpenAI dashboard. Format: sk-redacted

data OpenAIClient Source #

Holds a Manager and your API key.

makeOpenAIClient Source #

Arguments

:: ApiKey
-> Manager
-> Int	Number of automatic retries the library should attempt.
-> OpenAIClient

Construct a OpenAIClient. Note that the passed Manager must support https (e.g. via http-client-tls)

data ClientError #

A type representing possible errors in a request

Note that this type substantially changed in 0.12.

Constructors

FailureResponse (RequestF () (BaseUrl, ByteString)) Response	The server returned an error response including the failing request. `requestPath` includes the `BaseUrl` and the path of the request.
DecodeFailure Text Response	The body could not be decoded at the expected type
UnsupportedContentType MediaType Response	The content-type of the response is not supported
InvalidContentTypeHeader Response	The content-type header is invalid
ConnectionError SomeException	There was a connection error, and no response was received

Instances

Instances details

Eq ClientError
Instance details Defined in Servant.Client.Core.ClientError Methods (==) :: ClientError -> ClientError -> Bool # (/=) :: ClientError -> ClientError -> Bool #
Show ClientError
Instance details Defined in Servant.Client.Core.ClientError Methods showsPrec :: Int -> ClientError -> ShowS # show :: ClientError -> String # showList :: [ClientError] -> ShowS #
Generic ClientError
Instance details Defined in Servant.Client.Core.ClientError Associated Types type Rep ClientError :: Type -> Type # Methods from :: ClientError -> Rep ClientError x # to :: Rep ClientError x -> ClientError #
Exception ClientError
Instance details Defined in Servant.Client.Core.ClientError Methods toException :: ClientError -> SomeException # fromException :: SomeException -> Maybe ClientError # displayException :: ClientError -> String #
NFData ClientError	Note: an exception in `ConnectionError` might not be evaluated fully, We only `rnf` its `show`ed value.
Instance details Defined in Servant.Client.Core.ClientError Methods rnf :: ClientError -> () #
MonadError ClientError ClientM
Instance details Defined in Servant.Client.Internal.HttpClient Methods throwError :: ClientError -> ClientM a # catchError :: ClientM a -> (ClientError -> ClientM a) -> ClientM a #
type Rep ClientError
Instance details Defined in Servant.Client.Core.ClientError type Rep ClientError = D1 ('MetaData "ClientError" "Servant.Client.Core.ClientError" "servant-client-core-0.18.3-H8wIZPzJ3vpDIKLeq39WcP" 'False) ((C1 ('MetaCons "FailureResponse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RequestF () (BaseUrl, ByteString))) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Response)) :+: C1 ('MetaCons "DecodeFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Response))) :+: (C1 ('MetaCons "UnsupportedContentType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MediaType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Response)) :+: (C1 ('MetaCons "InvalidContentTypeHeader" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Response)) :+: C1 ('MetaCons "ConnectionError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeException)))))

Helper types

newtype TimeStamp #

A UTCTime wrapper that has unix timestamp JSON representation

Constructors

TimeStamp
Fields unTimeStamp :: UTCTime

Instances

Instances details

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

newtype OpenAIList a #

A Vector wrapper.

Constructors

OpenAIList
Fields olData :: Vector a

Instances

Instances details

Functor OpenAIList
Instance details Defined in OpenAI.Resources Methods fmap :: (a -> b) -> OpenAIList a -> OpenAIList b # (<$) :: a -> OpenAIList b -> OpenAIList a #
Applicative OpenAIList
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 #
Eq a => Eq (OpenAIList a)
Instance details Defined in OpenAI.Resources Methods (==) :: OpenAIList a -> OpenAIList a -> Bool # (/=) :: OpenAIList a -> OpenAIList a -> Bool #
Show a => Show (OpenAIList a)
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> OpenAIList a -> ShowS # show :: OpenAIList a -> String # showList :: [OpenAIList a] -> ShowS #
Semigroup (OpenAIList a)
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 #
Monoid (OpenAIList a)
Instance details Defined in OpenAI.Resources Methods mempty :: OpenAIList a # mappend :: OpenAIList a -> OpenAIList a -> OpenAIList a # mconcat :: [OpenAIList a] -> OpenAIList a #
ToJSON a => ToJSON (OpenAIList a)
Instance details Defined in OpenAI.Resources Methods toJSON :: OpenAIList a -> Value # toEncoding :: OpenAIList a -> Encoding # toJSONList :: [OpenAIList a] -> Value # toEncodingList :: [OpenAIList a] -> Encoding #
FromJSON a => FromJSON (OpenAIList a)
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser (OpenAIList a) # parseJSONList :: Value -> Parser [OpenAIList a] #

Engine

newtype EngineId #

Constructors

EngineId
Fields unEngineId :: Text

Instances

Instances details

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

data Engine #

Constructors

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

Instances

Instances details

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

listEngines :: OpenAIClient -> IO (Either ClientError (OpenAIList Engine)) Source #

getEngine :: OpenAIClient -> EngineId -> IO (Either ClientError Engine) Source #

Text completion

newtype TextCompletionId #

Constructors

TextCompletionId
Fields unTextCompletionId :: Text

Instances

Instances details

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

data TextCompletionChoice #

Constructors

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

Instances

Instances details

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

data TextCompletion #

Constructors

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

Instances

Instances details

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

data TextCompletionCreate #

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

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

defaultTextCompletionCreate :: Text -> TextCompletionCreate #

Applies API defaults, only passing a prompt.

completeText :: OpenAIClient -> EngineId -> TextCompletionCreate -> IO (Either ClientError TextCompletion) Source #

Embeddings

data EmbeddingCreate #

Constructors

EmbeddingCreate
Fields ecInput :: Text

Instances

Instances details

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

data Embedding #

Constructors

Embedding
Fields eEmbedding :: Vector Double eIndex :: Int

Instances

Instances details

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

createEmbedding :: OpenAIClient -> EngineId -> EmbeddingCreate -> IO (Either ClientError (OpenAIList Embedding)) Source #

Fine tunes

newtype FineTuneId #

Constructors

FineTuneId
Fields unFineTuneId :: Text

Instances

Instances details

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

data FineTuneCreate #

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

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

defaultFineTuneCreate :: FileId -> FineTuneCreate #

data FineTune #

Constructors

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

Instances

Instances details

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

data FineTuneEvent #

Constructors

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

Instances

Instances details

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

createFineTune :: OpenAIClient -> FineTuneCreate -> IO (Either ClientError FineTune) Source #

listFineTunes :: OpenAIClient -> IO (Either ClientError (OpenAIList FineTune)) Source #

getFineTune :: OpenAIClient -> FineTuneId -> IO (Either ClientError FineTune) Source #

cancelFineTune :: OpenAIClient -> FineTuneId -> IO (Either ClientError FineTune) Source #

listFineTuneEvents :: OpenAIClient -> FineTuneId -> IO (Either ClientError (OpenAIList FineTuneEvent)) Source #

Searching

data SearchResult #

Constructors

SearchResult
Fields srDocument :: Int srScore :: Double srMetadata :: Maybe Text

Instances

Instances details

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

data SearchResultCreate #

Constructors

SearchResultCreate
Fields sccrFile :: Maybe FileId sccrDocuments :: Maybe (Vector Text) sccrQuery :: Text sccrReturnMetadata :: Bool

Instances

Instances details

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

searchDocuments :: OpenAIClient -> EngineId -> SearchResultCreate -> IO (Either ClientError (OpenAIList SearchResult)) Source #

File API

data FileCreate #

Constructors

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

Instances

Instances details

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

data File #

Constructors

File
Fields fId :: FileId fCreatedAt :: TimeStamp fPurpose :: Text

Instances

Instances details

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

newtype FileId #

Constructors

FileId
Fields unFileId :: Text

Instances

Instances details

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

data FileHunk #

Constructors

FhSearch SearchHunk
FhClassifications ClassificationHunk
FhFineTune FineTuneHunk

Instances

Instances details

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

data SearchHunk #

Constructors

SearchHunk
Fields shText :: Text shMetadata :: Maybe Text

Instances

Instances details

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

data ClassificationHunk #

Constructors

ClassificationHunk
Fields chText :: Text chLabel :: Text

Instances

Instances details

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

data FineTuneHunk #

Constructors

FineTuneHunk
Fields fthPrompt :: Text fthCompletion :: Text

Instances

Instances details

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

data FileDeleteConfirmation #

Constructors

FileDeleteConfirmation
Fields fdcId :: FileId

Instances

Instances details

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

createFile :: OpenAIClient -> FileCreate -> IO (Either ClientError File) Source #

deleteFile :: OpenAIClient -> FileId -> IO (Either ClientError FileDeleteConfirmation) Source #

Answer API

getAnswer :: OpenAIClient -> AnswerReq -> IO (Either ClientError AnswerResp) Source #

data AnswerReq #

Constructors

AnswerReq
Fields arFile :: Maybe FileId arDocuments :: Maybe (Vector Text) arQuestion :: Text arSearchModel :: EngineId arModel :: EngineId arExamplesContext :: Text arExamples :: [[Text]] arReturnMetadata :: Bool

Instances

Instances details

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

data AnswerResp #

Constructors

AnswerResp
Fields arsAnswers :: [Text]

Instances

Instances details

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