The repo is at GitHub - cyberchitta/openai_ex: Community maintained Elixir library for OpenAI API · GitHub.

Docs are at OpenaiEx User Guide — openai_ex v0.9.21.

Changelog

The main user guide is a livebook, so you should be able to run everything without any setup. The user guide is also the test suite. It is run before every version release, so it is always up to date with the library.

Portions of this project were developed with assistance from ChatGPT 3.5 and 4, as well as Claude 3 Opus and Claude 3.5 Sonnet. However, every line of code is human curated (by me ).

All API endpoints and features (as of Mar 16, 2025) are supported, including the most recent Responses API (proposed replacement for Chat Completion).

Configuration of Finch pools and API base url are supported.

There are some differences compared to other elixir openai wrappers.

• I tried to faithfully mirror the naming/structure of the official python api. For example, content that is already in memory can be uploaded as part of a request, it doesn’t have to be read from a file at a local path.

• I was developing for a livebook use-case, so I don’t have any config, only environment variables.

• Streaming API versions, with request cancellation, are supported.

• The underlying transport is finch, rather than httpoison

• 3rd Party (including local) LLMs with an OpenAI proxy, as well as the Azure OpenAI API, are considered legitimate use cases.

Documentation is still a work in progress. In addition to the user guide, there are also Livebook examples for

• Streaming Orderbot An example of how to use ChatCompletion streaming in a Chatbot. This is a streaming version of the next Livebook in this list.

• The Deeplearning.AI Order Bot — openai_ex v0.9.21. This notebook is an elixir / Kino translation of the python notebook in Lesson 8, of Deeplearning.AI’s course ChatGPT Prompt Engineering for Developers.

• A Completions Bot (Deprecated API) — openai_ex v0.9.21 which can be deployed as a Livebook app. The deployed app displays 2 forms, one for normal completions and another for streaming completions.

• An Image Generation Kino App — openai_ex v0.9.21

The library is developed in a livebook docker image running in a VS code dev container.

Please try it out and let me know what you think. Happy to receive suggestions (and PRs) for improvement, as well as illustrative sample notebooks.