Safe Haskell	None
Language	Haskell2010

OpenAI.Client

Contents

Basics
Helper types
Engine
Text completion
Searching

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 SearchResult = SearchResult {
- srDocument :: Int
- srScore :: Double
}
data SearchResultCreate = SearchResultCreate {
- sccrDocuments :: Vector Text
- sccrQuery :: Text
}
searchDocuments :: OpenAIClient -> EngineId -> SearchResultCreate -> IO (Either ClientError (OpenAIList SearchResult))

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.2-erujaapP7r3HLqFPWrybq" '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 #

Searching

data SearchResult #

Constructors

SearchResult
Fields srDocument :: Int srScore :: Double

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 sccrDocuments :: Vector Text sccrQuery :: Text

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 #