OOpenAI: An OCaml Client Library for the OpenAI API

Authors: Shon Feder, Freda Xin

About

This is an unofficial client library for the OpenAI API implemented in OCaml. The library was generated initially by the OCamlClientCodegen code generator for openapi-generator. However, due to various errors in the code generation, a significant portion of this library was manually corrected and implemented.

Project Status

This project carries MIT license.

This project is under active development and improved interfaces and coverage are in the works. That said, the library is fairly well tested, and all supported endpoints have been verified as working.

The current release (V.1.0) covers the following endpoints:

Endpoint	Release V.1.0
Cancel fine tune	✅
Create chat completion
Create completion	✅
Create edit	✅
Create embedding	✅
Create file	✅
Create fine tune	✅
Create image	✅
Create image edit	✅
Create image variation	✅
Create moderation	✅
Create translation
Create transcription
Delete file	✅
Delete model	✅
Download file	✅
List files	✅
List fine tune events	✅
List fine tunes	✅
List models	✅
Retrieve file	✅
Retrieve fine tune	✅
Retrieve model	✅

Installation

opam pin https://github.com/XFFS/oopenai.git

Usage

Obtain your secret key from OpenAI. Set the key as environment variable OPENAI_API_KEY.

open Oopenai

(* Configure autherization thru environment variables *)
module Config : Request.Auth = struct
  let api_key = Sys.getenv "OPENAI_API_KEY"
  let org_id = None
end

module API = Open_ai_api.Make (Config)

(* A utility function *)
let print_option = function
  | Some v -> Lwt_io.printl v
  | None -> Lwt.return_unit

let main () =
  let open Lwt.Syntax in
  (* List models *)
  let* resp = API.list_models () in
  let* () =
    Lwt_list.iter_s (fun (m : Model.t) -> Lwt_io.printl m.id) resp.data
  in

  (* Create completion *)
  let create_completion_request_t =
    let req = Create_completion_request.create "ada" in
    let prompt = Some [ "Give me dogs"; "Give me some cats" ] in
    let n = Some 5l in
    { req with prompt; n }
  in
  let* resp = API.create_completion ~create_completion_request_t in
  let+ () =
    Lwt_list.iter_s
      (fun (choice:Create_completion_response_choices_inner.t) ->
        print_option choice.text)
      resp.choices
  in
  ()

let () = Lwt_main.run (main ())

For more examples of how to use the endpoints, refer to the end-to-end tests.