Safe Haskell	None
Language	Haskell2010

OpenAI.Resources

Contents

Core Types
Engine
Text completion
Searching
File API
Answers API

Synopsis

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
}
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
data SearchResult = SearchResult {
- srDocument :: Int
- srScore :: Double
- srMetadata :: Maybe Text
}
data SearchResultCreate = SearchResultCreate {
- sccrFile :: Maybe FileId
- sccrDocuments :: Maybe (Vector Text)
- sccrQuery :: Text
- sccrReturnMetadata :: Bool
}
data FileCreate = FileCreate {
- fcPurpose :: Text
- fcDocuments :: [FileHunk]
}
newtype FileId = FileId {
- unFileId :: Text
}
data File = File {
- fId :: FileId
- fCreatedAt :: TimeStamp
- fPurpose :: Text
}
data FileHunk = FileHunk {
- fhContent :: Text
- fhMetadata :: Maybe Text
}
data FileDeleteConfirmation = FileDeleteConfirmation {
- fdcId :: FileId
}
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]
}

Core Types

newtype TimeStamp Source #

A UTCTime wrapper that has unix timestamp JSON representation

Constructors

TimeStamp
Fields unTimeStamp :: UTCTime

Instances

Instances details

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

Functor OpenAIList Source #
Instance details Defined in OpenAI.Resources Methods fmap :: (a -> b) -> OpenAIList a -> OpenAIList b # (<$) :: a -> OpenAIList b -> OpenAIList a #
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 #
Eq a => Eq (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods (==) :: OpenAIList a -> OpenAIList a -> Bool # (/=) :: OpenAIList a -> OpenAIList a -> Bool #
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 #
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 #
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 #
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 #
FromJSON a => FromJSON (OpenAIList a) Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser (OpenAIList a) # parseJSONList :: Value -> Parser [OpenAIList a] #

Engine

newtype EngineId Source #

Constructors

EngineId
Fields unEngineId :: Text

Instances

Instances details

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

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

Text completion

newtype TextCompletionId Source #

Constructors

TextCompletionId
Fields unTextCompletionId :: Text

Instances

Instances details

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

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

data TextCompletion Source #

Constructors

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

Instances

Instances details

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

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

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

defaultTextCompletionCreate :: Text -> TextCompletionCreate Source #

Applies API defaults, only passing a prompt.

Searching

data SearchResult Source #

Constructors

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

Instances

Instances details

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

data SearchResultCreate Source #

Constructors

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

Instances

Instances details

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

File API

data FileCreate Source #

Constructors

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

Instances

Instances details

Eq FileCreate Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileCreate -> FileCreate -> Bool # (/=) :: FileCreate -> FileCreate -> Bool #
Show FileCreate Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileCreate -> ShowS # show :: FileCreate -> String # showList :: [FileCreate] -> ShowS #
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

Eq FileId Source #
Instance details Defined in OpenAI.Resources Methods (==) :: FileId -> FileId -> Bool # (/=) :: FileId -> FileId -> Bool #
Show FileId Source #
Instance details Defined in OpenAI.Resources Methods showsPrec :: Int -> FileId -> ShowS # show :: FileId -> String # showList :: [FileId] -> ShowS #
ToJSON FileId Source #
Instance details Defined in OpenAI.Resources Methods toJSON :: FileId -> Value # toEncoding :: FileId -> Encoding # toJSONList :: [FileId] -> Value # toEncodingList :: [FileId] -> Encoding #
FromJSON FileId Source #
Instance details Defined in OpenAI.Resources Methods parseJSON :: Value -> Parser FileId # parseJSONList :: Value -> Parser [FileId] #
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 fCreatedAt :: TimeStamp fPurpose :: Text

Instances

Instances details

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

data FileHunk Source #

Constructors

FileHunk
Fields fhContent :: Text fhMetadata :: Maybe Text

Instances

Instances details

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

data FileDeleteConfirmation Source #

Constructors

FileDeleteConfirmation
Fields fdcId :: FileId

Instances

Instances details

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

Answers API

data AnswerReq Source #

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

data AnswerResp Source #

Constructors

AnswerResp
Fields arsAnswers :: [Text]

Instances

Instances details

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