openai-servant-gen 0.1.0.0 → 0.1.0.1

raw patch · 2 files changed

+130/−1 lines, 2 files

Files

• README.md +128/−0
• openai-servant-gen.cabal +2/−1

@@ -0,0 +1,128 @@+# Auto-Generated OpenAPI Bindings to `OpenAI`++The library in `lib` provides auto-generated-from-OpenAPI bindings to the OpenAI API.++## Installation++Installation follows the standard approach to installing Stack-based projects.++1. Install the [Haskell `stack` tool](http://docs.haskellstack.org/en/stable/README).+2. Run `stack install` to install this package.++Otherwise, if you already have a Stack project, you can include this package under the `packages` key in your `stack.yaml`:+```yaml+packages:+- location:+    git: https://github.com/yourGitOrg/yourGitRepo+    commit: somecommit+```++## Main Interface++The main interface to this library is in the `OpenAI.API` module, which exports the OpenAIBackend type. The OpenAIBackend+type can be used to create and define servers and clients for the API.++## Creating a Client++A client can be created via the `createOpenAIClient` function, which will generate a function for every endpoint of the API.+Then these functions can be invoked with `runOpenAIClientWithManager` or more conveniently with `callOpenAIClient`+(depending if you want an `Either` back or you want to catch) to access the API endpoint they refer to, if the API is served+at the `url` you specified.++For example, if `localhost:8080` is serving the OpenAI API, you can write:++```haskell+{-# LANGUAGE RecordWildCards #-}++import OpenAI.API as API++import           Network.HTTP.Client     (newManager)+import           Network.HTTP.Client.TLS (tlsManagerSettings)+import           Servant.Client          (ClientEnv, mkClientEnv, parseBaseUrl)+++main :: IO ()+main = do+  -- Configure the BaseUrl for the client+  url <- parseBaseUrl "http://localhost:8080/"++  -- You probably want to reuse the Manager across calls, for performance reasons+  manager <- newManager tlsManagerSettings++  -- Create the client (all endpoint functions will be available)+  OpenAIBackend{..} <- API.createOpenAIClient++  -- Any OpenAI API call can go here, e.g. here we call `getSomeEndpoint`+  API.callOpenAI (mkClientEnv manager url) getSomeEndpoint+```++## Creating a Server++In order to create a server, you must use the `runOpenAIMiddlewareServer` function. However, you unlike the client, in which case you *got* a `OpenAIBackend`+from the library, you must instead *provide* a `OpenAIBackend`. For example, if you have defined handler functions for all the+functions in `OpenAI.Handlers`, you can write:++```haskell+{-# LANGUAGE RecordWildCards #-}++import OpenAI.API+-- required dependency: wai+import Network.Wai (Middleware)+-- required dependency: wai-extra+import Network.Wai.Middleware.RequestLogger (logStdout)++-- A module you wrote yourself, containing all handlers needed for the OpenAIBackend type.+import OpenAI.Handlers++-- If you would like to not use any middlewares you could use runOpenAIServer instead++-- Combined middlewares+requestMiddlewares :: Middleware+requestMiddlewares = logStdout++-- Run a OpenAI server on localhost:8080+main :: IO ()+main = do+  let server = OpenAIBackend{..}+      config = Config "http://localhost:8080/"+  runOpenAIMiddlewareServer config requestMiddlewares server+```++## Authentication++Currently basic, bearer and API key authentication is supported. The API key must be provided+in the request header.++For clients authentication the function `clientAuth` is generated automatically. For basic+authentication the argument is of type `BasicAuthData` provided by `Servant.API.BasicAuth`.+For bearer and API key authentication the argument is the key/token and is of type `Text`.+Protected endpoints on the client will receive an extra argument. The value returned by+`clientAuth keyTokenOrBasic` can then be used to make authenticated requests.++For the server you are free to choose a custom data type. After you specified an instance of+`AuthServerData` it is automatically added as a first argument to protected endpoints:++```+newtype Account = Account {unAccount :: Text}+type instance AuthServerData Protected = Account+```++Additionally, you have to provide value for the `OpenAIAuth` type provided by the+`OpenAI.API` module:++```+auth :: OpenAIAuth+auth =+  OpenAIAuth+    { lookupUser = lookupAccount,+      authError = \request -> err401 {errBody = "Missing header"}+    }+```++`lookupAccount` is a user defined function used to verify the key, token or basic auth data.+`authError` takes a `Request` and returns a `ServerError`. The value is used by the server+functions:++```+runOpenAIMiddlewareServer config requestMiddlewares auth server+```

@@ -1,6 +1,6 @@ cabal-version:       3.0 name:                openai-servant-gen-version:             0.1.0.0+version:             0.1.0.1 synopsis:            Auto-generated API bindings for openai description:         This repository provides openai APIs of haskell via openapi-generator. It's just generating. It's intended to provide latest APIs. homepage:            https://github.com/junjihashimoto/intelli-monad@@ -12,6 +12,7 @@ license:             MIT license-file:        LICENSE extra-doc-files:     CHANGELOG.md+                     README.md                        library