Openai.ex

ExOpenAI is an Elixir SDK for interacting with the OpenAI APIs

This SDK is auto-generated using metaprogramming and should reflect the latest state of the OpenAI API.

Note: Due to the nature of auto-generating something, you may encounter stuff that isn't working yet. Make sure to report if you find anything acting up.

Features

Up-to-date thanks to metaprogramming
Auto-generated function documentation
Function arguments and opts @spec definitions for dialyzer, for strict parameter typing

Installation

Add :ex_openai as a dependency in your mix.exs file.

def deps do
  [
    {:ex_openai, "~> 0.1.0"}
  ]
end

What's working

Basically everything that uses application/json is working, and everything that requires upload of a stream/file is not. To avoid confusion, everything that expects multipart/form-data has been excluded for now.
Output typespec are not auto-generated yet

answers

/answers

chat

/chat/completions

classifications

/classifications

completions

/completions

edits

/edits

embeddings

/embeddings

engines

/engines/{engine_id}
/engines

files

/files/{file_id}/content

fine-tunes

/fine-tunes/{fine_tune_id}/events
/fine-tunes/{fine_tune_id}/cancel
/fine-tunes/{fine_tune_id}
/fine-tunes

images

/images/generations

models

/models

moderations

/moderations

searches

/engines/{engine_id}/search

What's not working yet

Endpoints that expect a file or stream to upload
Typespecs for return types, currently everything is any()
Typespecs for array and oneOf input types

audio

/audio/translations
/audio/transcriptions

files

/files

images

/images/variations
/images/edits

Configuration

import Config

config :ex_openai,
  api_key: "your-api-key", # find it at https://platform.openai.com/account/api-keys
  organization_key: "your-organization-key", # find it at https://platform.openai.com/account/api-keys
  http_options: [recv_timeout: 30_000] # optional, passed to [HTTPoison.Request](https://hexdocs.pm/httpoison/HTTPoison.Request.html) options

Usage

ExOpenAI.Models.list_models
{:ok,
 %{
   data: [
     %{
       "created" => 1649358449,
       "id" => "babbage",
       "object" => "model",
       "owned_by" => "openai",
       "parent" => nil,
       "permission" => [
         %{
           "allow_create_engine" => false,
           "allow_fine_tuning" => false,
           "allow_logprobs" => true,
           "allow_sampling" => true,
           "allow_search_indices" => false,
           "allow_view" => true,
           "created" => 1669085501,
           "group" => nil,
           "id" => "modelperm-49FUp5v084tBB49tC4z8LPH5",
           "is_blocking" => false,
           "object" => "model_permission",
           "organization" => "*"
         }
       ],
       "root" => "babbage"
     },
	...

Required parameters are converted into function arguments, optional parameters into the opts keyword list:

ExOpenAI.Completions.create_completion "text-davinci-003", prompt: "The sky is"
{:ok,
 %{
   choices: [
     %{
       "finish_reason" => "length",
       "index" => 0,
       "logprobs" => nil,
       "text" => " blue\n\nThe sky is a light blue hue that may have a few white"
     }
   ],
   created: 1677929239,
   id: "cmpl-6qKKllDPsQRtyJ5oHTbkQVS9w7iKM",
   model: "text-davinci-003",
   object: "text_completion",
   usage: %{
     "completion_tokens" => 16,
     "prompt_tokens" => 3,
     "total_tokens" => 19
   }
 }}

How to update once OpenAI chnages something?

Run mix update_docs and commit the new docs.yaml file

License

The package is available as open source under the terms of the MIT License.

Attribution

Inspired by https://github.com/BlakeWilliams/Elixir-Slack
Client/config handling from https://github.com/mgallo/openai.ex