README.md

instructor-clj

instructor-clj is a Clojure lib inspired by instructor It makes it easy to have structured output from LLMs.

Built on top of Malli for defining schemas.

Examples

(require '[instructor-clj.core :as ic])

(def User
  [:map
   [:name :string]
   [:age :int]])

(ic/instruct "John Doe is 30 years old."
             User
             :api-key "<API-KEY>")
; => {:name "John Doe", :age 30}

(def Meeting
  [:map
   [:action [:and {:description "What action is needed"}
             [:enum "call" "followup"]]]
   [:person [:and {:description "Person involved in the action"}
             [:string]]]
   [:time [:and {:description "Time of the day"}
           [:string]]]
   [:day [:and {:description "Day of the week"}
          [:string]]]])

; With retries:
(ic/instruct "Call Kapil on Saturday at 12pm"
             Meeting
             :api-key api-key
             :model "gpt-4"
             :max-retries 2)
; => {:action "call", :person "Kapil", :time "12pm", :day "Saturday"}

Use with a OpenAI API compatible custom client like openai-clojure

(require '[wkok.openai-clojure.api :as client])

Basic usage with client

(ic/create-chat-completion client/create-chat-completion
                           {:messages [{:role "user" :content "Call Kapil on Saturday at 12pm"}]
                            :response-model Meeting}
                           {:api-key api-key})
; => {:action "call", :person "Kapil", :time "12pm", :day "Saturday"}

Some of the customization options provided by the client

(ic/create-chat-completion client/create-chat-completion
                           {;; Model related parameters
                            :model "gpt-4"
                            :temprature 0.5
                            :messages [{:role "user" :content "Call Kapil on Saturday at 12pm"}]
                            :response-model Meeting}
                           {:api-key api-key
                            ;; HTTP request parameters
                            :request {:timeout 60000}})

License

This project is licensed under the terms of the MIT License.