View Source ExOpenAi

ExOpenAi is an elixir wrapper for the OpenAI API. All resources return a struct of the resource that was called.

installation

Installation

The package can be installed by adding ex_open_ai to your list of dependencies in mix.exs:

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

configuration

Configuration

To access the OpenAI API you will need to set the following environment or runtime variables in your config/config.exs file:

config :ex_open_ai, 
  api_key: "YOUR_API_KEY_FROM_OPEN_AI"
  organization: "OPTIONAL_ORGANIZATION" # optional

You can also use the {:system, "VARIABLE_NAME"} format.

usage

Usage

ExOpenAi has modules for the supported OpenAI API resource. At the time of release not all endpoints are supported, there will be more coming soon. For example the "Completion" resource is available through the ExOpenAi.Completion module. Almost every single resource can be called with the create function.

iex> ExOpenAi.Completion.create(%{model: "text-davinci-003", prompt: "Tell me a funny story"})

{:ok, %ExOpenAi.Completion{object: "text_completion", id: "cmpl-id", choices: [%{text: "funny story"}], created: 1234567890, usage: %{completion_tokens: 25, prompt_tokens: 50, total_tokens: 75}}}

Will return a ExOpenAi.Completion struct with all the information that the API returns.

All the resources support a simple boolean that will extract just the data from the response and return that.

iex> ExOpenAi.Completion.create(%{model: "text-davinci-003", prompt: "Tell me a funny story", n: 3}, simple: true)

{:ok, ["funny story one", "funny story 2", "funny story 3"]}

requests

Requests

Introducing ExOpenAi.Requests.

These are modules to help you prepare and make requests that return resources. ChatRequest has the do_append/2 function to add messages to the Chat resource. All resources have a .create/1 function that will take in a map and validate that the required fields are present as well as remove any fields that OpenAi API will not like.

ExOpenAi.ChatRequest.create(%{model: "gpt-3.5-turbo", messages: [%{role: "system", content: "You are a good bot"}]})
>> %ExOpenAi.Chat{id: "cmpl-123451234", choices: ...}

supported-resources

Supported Resources

As of initial release the following resources are supported with more to come:

Copyright (c) 2023 David Astor

ExOpenAi is licensed under the MIT license. For more details see the LICENSE file at the root of the repo. Elixir is licensed under the Apache 2 license.

OpenAI is a trademark of OpenAI