Merge pull request #32 from wkok/override-openai-api-endpoint

Added ability to override the OpenAI API endpoint

Author: wkok

doc/01-usage-openai.md

@@ -30,15 +30,20 @@ An API key can be generated in your [OpenAI account](https://platform.openai.com
 
 *Optional* - If your OpenAI account uses multiple organizations, set the environment variable `OPENAI_ORGANIZATION` to the one used for your app.
 
+### Endpoint
+
+It is not necessary to specify the endpoint url if using the default OpenAI service. If you do need to point to a different endpoint set the environment variable `OPENAI_API_ENDPOINT` for example: *https://myendpoint.my-openai.com*
+
 ### Options
 
-Alternatively the `api-key` and/or `organization` can be passed in the `options` argument of each api function
+Alternatively the `api-key` and/or `organization` and/or `api-endpoint` can be passed in the `options` argument of each api function
 
 ```
 (api/create-completion {:model "text-davinci-003"
                         :prompt "Say this is a test"}
                        {:api-key "xxxxx"
-                        :organization "abcd"})
+                        :organization "abcd"
+                        :api-endpoint "https://myendpoint.my-openai.com"})
 ```
 
 ## Quickstart

src/wkok/openai_clojure/openai.clj

@@ -8,7 +8,8 @@
      [wkok.openai-clojure.sse :as sse]
      [martian.encoders :as encoders]
      [martian.interceptors :as interceptors]
-     [schema.core :as s]))
+     [schema.core :as s]
+     [clojure.string :as string]))
 
 (def add-headers
   {:name ::add-headers
@@ -23,6 +24,17 @@
                              (not-empty api-key) (assoc "Authorization" (str "Bearer " api-key))
                              (not-empty organization) (assoc "OpenAI-Organization" organization))))))})
 
+(defn override-api-endpoint
+  [base-url]
+  {:name ::override-api-endpoint
+   :enter (fn [ctx]
+            (update-in ctx [:request :url]
+                       (fn [url]
+                         (let [endpoint (or (-> ctx :params :wkok.openai-clojure.core/options :api-endpoint)
+                                            (System/getenv "OPENAI_API_ENDPOINT")
+                                            base-url)]
+                           (str endpoint (subs url (count base-url)))))))})
+
 (defn- multipart-form-data?
   [handler]
   (-> handler :openapi-definition :requestBody :content :multipart/form-data))
@@ -72,6 +84,7 @@
                                      (-> (remove #(#{:martian.hato/perform-request} (:name %))
                                                  interceptors)
                                          (concat [add-headers
+                                                  (override-api-endpoint base-url)
                                                   (interceptors/encode-body encoders)
                                                   multipart-form-data
                                                   sse/perform-sse-capable-request]))))]

test/wkok/openai_clojure/openai_test.clj

@@ -42,3 +42,18 @@
                                                                               :organization "my-company"}}})
                  :request
                  :headers))))))
+
+(deftest override-api-endpoint-test
+  (let [base-url "https://api.openai.com/v2"
+        override-api-endpoint-fn (-> base-url openai/override-api-endpoint :enter)]
+    (testing "api endpoint gets correctly overridden"
+
+      (let [api-endpoint "https://myendpoint.my-openai.com/v2"
+            path "/some/chat/prompt"
+            test-fn (fn [url]
+                      (is (= (str api-endpoint path)
+                             (-> (override-api-endpoint-fn {:request {:url url}
+                                                            :params {:wkok.openai-clojure.core/options {:api-endpoint api-endpoint}}})
+                                 :request
+                                 :url))))]
+        (test-fn (str base-url "/some/chat/prompt"))))))