defmodule ExOpenAi.Api do @moduledoc """ The main module for the ExOpenAi API client. Provides a wrapper around Httpoison for making requests to the OpenAI API. """ use HTTPoison.Base alias ExOpenAi.Config alias ExOpenAi.Parser alias ExOpenAi.URLGenerator, as: URL alias ExOpenAi.StreamProcessor alias __MODULE__ @type data :: map | list @doc """ Create a new resource in the OpenAI API with a POST request. ## Examples ExOpenAi.Api.create(ExOpenAi.Completion, [prompt: "tell me a joke", max_tokens: 500]) {:ok, %Completion{ ... }} ExOpenAi.Api.create(ExOpenAi.Completion, []) {:error, %{"model" => "model is required"}, 400} """ @spec create(atom, data :: list | map, list) :: Parser.success() | Parser.error() def create(module, data, options \\ []) do data = format_data(data) module |> URL.infer_url() |> Api.post!(data, options, recv_timeout: Config.timeout()) |> Parser.parse(module, options[:simple]) end @doc """ Creates a stream using the provided module, data, and options. The stream is created using the `Stream.resource/3` function, where the initial function posts the data with `Api.post!/4`, the intermediate function processes the async response with `StreamProcessor.handle_async_response/2`, and the after function closes the async response with `StreamProcessor.close_async_response/1`. ## Parameters * `module` - The module to be used for handling the data stream. * `data` - A keyword list containing the data to be sent in the request. * `options` - An optional keyword list of additional options for the request. ## Returns * A stream that is created using the `Stream.resource/3` function, allowing processing of the data as it is received. ## Usage This function is used to create a stream with the specified module, process ID, data, and options. This enables efficient handling of streaming data from the OpenAI API. """ @spec create_stream(atom, data :: list | map, list) :: any() def create_stream(module, data, options \\ []) do data = cond do is_list(data) -> data |> Keyword.put(:stream, true) is_map(data) -> data |> Map.put(:stream, true) end |> format_data() url = module |> URL.infer_url() Stream.resource( fn -> Api.post!(url, data, options, stream_to: self(), async: :once, recv_timeout: Config.timeout() ) end, &StreamProcessor.handle_async_response(&1, module), &StreamProcessor.close_async_response/1 ) end @doc """ Create with a file upload. """ @spec create_audio(atom, data :: list | map, list) :: Parser.success() | Parser.error() def create_audio(module, data, options \\ []) do file = Keyword.get(data, :file) additional_data = data |> Keyword.delete(:file) |> Enum.map(fn {k, v} -> {"#{k}", v} end) data = {:multipart, [ {:file, file, {"form-data", [{:name, "file"}, {:filename, Path.basename(ensure_valid_filename(file))}]}, []} ] ++ additional_data} module |> URL.infer_url() |> Api.post!(data, options, recv_timeout: Config.timeout()) |> Parser.parse(module, options[:simple]) end @doc """ Builds the authorization header for the request. """ @spec auth_header(options :: list) :: list def auth_header(options \\ []) do auth_header([], {options[:api_key], options[:organization]}) end @doc """ Builds the actual authorization header for the request. ## Examples iex> ExOpenAi.Api.auth_header([], {"api123", "org345"}) [{"Authorization", "Bearer api123"}, {"OpenAI-Organization", "org345"}] iex> ExOpenAi.Api.auth_header([], {"api123", nil}) [{"Authorization", "Bearer api123"}] """ @spec auth_header(header :: list, tuple()) :: list def auth_header(headers, {api_key, organzation}) do headers |> put_header("Authorization", "Bearer #{api_key}") |> put_header("OpenAI-Organization", organzation) end defp put_header(headers, _key, value) when is_nil(value), do: headers defp put_header(headers, key, value), do: headers ++ [{key, value}] @spec format_data(list | map) :: binary def format_data(data) def format_data(data) when is_list(data) do data |> Map.new() |> Jason.encode!() end def format_data(data) when is_map(data), do: Jason.encode!(data) def ensure_valid_filename(filename) do URI.encode(filename) end ### # HTTPoison API ### def process_request_headers(headers \\ []) do headers |> Keyword.put(:"Content-Type", "application/json") |> auth_header({Config.api_key(), Config.organization()}) end end