openai-hs: Unofficial OpenAI client

[ bsd3, library, web ] [ Propose Tags ]

Unofficial OpenAI client


[Skip to Readme]
Versions [RSS] [faq] 0.1.1.0, 0.2.0.0
Dependencies aeson, base (>=4.7 && <5), bytestring, casing, cpphs, http-client, http-types, openai-servant, servant, servant-client, servant-multipart, text [details]
License BSD-3-Clause
Copyright 2021 Alexander Thiemann <mail@thiemann.at>
Author Alexander Thiemann <mail@thiemann.at>
Maintainer Alexander Thiemann <mail@thiemann.at>
Category Web
Home page https://github.com/agrafix/openai-hs#readme
Bug tracker https://github.com/agrafix/openai-hs/issues
Source repo head: git clone https://github.com/agrafix/openai-hs
Uploaded by AlexanderThiemann at 2021-03-27T05:39:33Z
Distributions NixOS:0.2.0.0
Downloads 110 total (9 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-03-27 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for openai-hs-0.2.0.0

[back to package description]

openai-hs

Unofficial OpenAI SDK/client for Haskell. It's generated via servant-client from openai-servant with a small amount of hand-written code. Contributions are welcome!

Install

# stack
stack install openai-hs

# cabal
cabal install openai-hs

Example

{-# LANGUAGE OverloadedStrings #-}
import OpenAI.Client

import Network.HTTP.Client
import Network.HTTP.Client.TLS
import System.Environment (getEnv)
import qualified Data.Vector as V

main :: IO ()
main =
  do manager <- newManager tlsManagerSettings
     apiKey <- T.pack <$> getEnv "OPENAI_KEY"
     -- create a openai client that automatically retries up to 4 times on network
     -- errors
     let client = makeOpenAIClient apiKey manager 4
     result <-
         searchDocuments cli (eId firstEngine) $
         SearchResultCreate
         { sccrDocuments = V.fromList ["pool", "gym", "night club"]
         , sccrQuery = "swimmer"
         }
     print result

Features

Supported actions:

  • List engines
  • Retrieve engine
  • Create text completion
  • Run semantic search

Running the tests

You can run all tests with stack test. You'll need an OpenAI API Key assigned to the OPENAI_KEY environment variable.