restlessronin
Openai_ex - OpenAI API client library
The repo is at GitHub - cyberchitta/openai_ex: Community maintained Elixir library for OpenAI API.
Docs are at OpenaiEx User Guide — openai_ex v0.9.18.
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.18. 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.18 which can be deployed as a Livebook app. The deployed app displays 2 forms, one for normal completions and another for streaming completions.
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.
Most Liked
restlessronin
I have just published v0.4.0 with all the new and updated API features announced at the OpenAI DevDay.
In particular the beta Assistants API is implemented, although examples have not as yet made it into the user guide and the documentation is incomplete in places. I hope to have some examples soon, and perhaps more complete documentation as the beta stabilizes.
In addition the deprecated ‘function’ calls parameters in the chat completion api have been replaced with the new ‘tool’ based parameters (shoutout to @TomBers for doing that and helping out with the documentation and testing, and generally being on the ball).
Enjoy playing with the new functionality!
restlessronin
No deep reason. I liked the Req design a little better, but it doesn’t support multi part form uploads. Tesla does. And some of the API endpoints require it.
hubertlepicki
FYR, there’s a stand-alone multipart building library that can be used with HTTP clients that don’t have it built in, at least one, I think I used a different one back in the day but can’t find it now:
neilberkman
restlessronin
Just published. v0.1.9 - File uploads from local paths are now streamed.
Popular in Announcing
Other popular topics
Latest Livebook Threads
Latest on Elixir Forum
Sponsor Spotlight
Build Elixir applications with speed and confidence.
Categories:
Sub Categories:
Forums
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Develop your skills with books, videos, and courses.
Producing high quality Elixir screencasts since 2017.
The deployment platform built for Elixir: PaaS ease, VPS control.
Courses that'll move you from confusion to "Aha, now I get it!"