FQN changes (#86)

* image -> images * file -> files. remove warnings * embedding -> embeddings * match module names * completion -> completions * model -> models * moderation - > moderations * fix fine tuning naming * fqn assistants * fix beta fqn * add on * test userguide
cyberchitta · Apr 26, 2024 · 4664508 · 4664508
1 parent 91092d8
commit 4664508
Show file tree

Hide file tree

Showing 22 changed files with 137 additions and 136 deletions.
diff --git a/lib/openai_ex/beta/assistant.ex → lib/openai_ex/beta/assistants.ex b/lib/openai_ex/beta/assistant.ex → lib/openai_ex/beta/assistants.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Assistant do
+defmodule OpenaiEx.Beta.Assistants do
   @moduledoc """
   This module provides an implementation of the OpenAI assistants API. The API reference can be found at https://platform.openai.com/docs/api-reference/assistants.
 
@@ -43,7 +43,7 @@ defmodule OpenaiEx.Beta.Assistant do
 
   Example usage:
 
-      iex> _request = OpenaiEx.Beta.Assistant.new(model: "gpt-4-turbo")
+      iex> _request = OpenaiEx.Beta.Assistants.new(model: "gpt-4-turbo")
       %{model: "gpt-4-turbo"}
   """
 

diff --git a/lib/openai_ex/beta/assistant_file.ex → lib/openai_ex/beta/assistants_file.ex b/lib/openai_ex/beta/assistant_file.ex → lib/openai_ex/beta/assistants_file.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Assistant.File do
+defmodule OpenaiEx.Beta.Assistants.File do
   @moduledoc """
   This module provides an implementation of the OpenAI assistants files API. The API reference can be found at https://platform.openai.com/docs/api-reference/assistants.
 

diff --git a/lib/openai_ex/beta/thread.ex → lib/openai_ex/beta/threads.ex b/lib/openai_ex/beta/thread.ex → lib/openai_ex/beta/threads.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Thread do
+defmodule OpenaiEx.Beta.Threads do
   @moduledoc """
   This module provides an implementation of the OpenAI threads API. The API reference can be found at https://platform.openai.com/docs/api-reference/threads.
 

diff --git a/lib/openai_ex/beta/message.ex → lib/openai_ex/beta/threads_messages.ex b/lib/openai_ex/beta/message.ex → lib/openai_ex/beta/threads_messages.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Thread.Message do
+defmodule OpenaiEx.Beta.Threads.Messages do
   @moduledoc """
   This module provides an implementation of the OpenAI messages API. The API
   reference can be found at https://platform.openai.com/docs/api-reference/messages.

diff --git a/lib/openai_ex/beta/message_file.ex → lib/openai_ex/beta/threads_messages_file.ex b/lib/openai_ex/beta/message_file.ex → lib/openai_ex/beta/threads_messages_file.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Thread.Message.File do
+defmodule OpenaiEx.Beta.Threads.Messages.File do
   @moduledoc """
   This module provides an implementation of the OpenAI messages files API. The API reference can be found at https://platform.openai.com/docs/api-reference/messages.
   """

diff --git a/lib/openai_ex/beta/run.ex → lib/openai_ex/beta/threads_runs.ex b/lib/openai_ex/beta/run.ex → lib/openai_ex/beta/threads_runs.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Thread.Run do
+defmodule OpenaiEx.Beta.Threads.Runs do
   @moduledoc """
   This module provides an implementation of the OpenAI run API. The API
   reference can be found at https://platform.openai.com/docs/api-reference/runs.
@@ -42,7 +42,7 @@ defmodule OpenaiEx.Beta.Thread.Run do
 
   Example usage:
 
-      iex> _request = OpenaiEx.Beta.Thread.Run.new(thread_id: "thread_foo", assistant_id: "assistant_bar")
+      iex> _request = OpenaiEx.Beta.Threads.Runs.new(thread_id: "thread_foo", assistant_id: "assistant_bar")
       %{assistant_id: "assistant_bar", thread_id: "thread_foo"}
   """
 

diff --git a/lib/openai_ex/beta/run_step.ex → lib/openai_ex/beta/threads_runs_step.ex b/lib/openai_ex/beta/run_step.ex → lib/openai_ex/beta/threads_runs_step.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Beta.Run.Step do
+defmodule OpenaiEx.Beta.Threads.Runs.Steps do
   @moduledoc false
   defp ep_url(thread_id, run_id, step_id \\ nil) do
     "/threads/#{thread_id}/runs/#{run_id}/steps" <>

diff --git a/lib/openai_ex/chat_completion.ex → lib/openai_ex/chat_completions.ex b/lib/openai_ex/chat_completion.ex → lib/openai_ex/chat_completions.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.ChatCompletion do
+defmodule OpenaiEx.Chat.Completions do
   @moduledoc """
   This module provides an implementation of the OpenAI chat completions API. The API reference can be found at https://platform.openai.com/docs/api-reference/chat/completions.
 
@@ -55,10 +55,10 @@ defmodule OpenaiEx.ChatCompletion do
 
   Example usage:
 
-      iex> _request = OpenaiEx.ChatCompletion.new(model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")])
+      iex> _request = OpenaiEx.Chat.Completions.new(model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")])
       %{messages: [%{content: "Hello, world!", role: "user"}], model: "davinci"}
 
-      iex> _request = OpenaiEx.ChatCompletion.new(%{model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")]})
+      iex> _request = OpenaiEx.Chat.Completions.new(%{model: "davinci", messages: [OpenaiEx.ChatMessage.user("Hello, world!")]})
       %{messages: [%{content: "Hello, world!", role: "user"}], model: "davinci"}
   """
 

diff --git a/lib/openai_ex/embedding.ex → lib/openai_ex/embeddings.ex b/lib/openai_ex/embedding.ex → lib/openai_ex/embeddings.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Embedding do
+defmodule OpenaiEx.Embeddings do
   @moduledoc """
   This module provides an implementation of the OpenAI embeddings API. The API reference can be found at https://platform.openai.com/docs/api-reference/embeddings.
 
@@ -35,10 +35,10 @@ defmodule OpenaiEx.Embedding do
 
   Example usage:
 
-      iex> _request = OpenaiEx.Embedding.new(model: "davinci", input: "This is a test")
+      iex> _request = OpenaiEx.Embeddings.new(model: "davinci", input: "This is a test")
       %{input: "This is a test", model: "davinci"}
 
-      iex> _request = OpenaiEx.Embedding.new(%{model: "davinci", input: "This is a test"})
+      iex> _request = OpenaiEx.Embeddings.new(%{model: "davinci", input: "This is a test"})
       %{input: "This is a test", model: "davinci"}
   """
 

diff --git a/lib/openai_ex/file.ex → lib/openai_ex/files.ex b/lib/openai_ex/file.ex → lib/openai_ex/files.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.File do
+defmodule OpenaiEx.Files do
   @moduledoc """
   This module provides an implementation of the OpenAI files API. The API reference can be found at https://platform.openai.com/docs/api-reference/files.
 

diff --git a/lib/openai_ex/fine_tuning.ex → lib/openai_ex/fine_tuning_jobs.ex b/lib/openai_ex/fine_tuning.ex → lib/openai_ex/fine_tuning_jobs.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.FineTuning.Job do
+defmodule OpenaiEx.FineTuning.Jobs do
   @moduledoc """
   This module provides an implementation of the OpenAI fine-tuning job API. The API reference can be found at https://platform.openai.com/docs/api-reference/fine-tuning.
 

diff --git a/lib/openai_ex/image.ex → lib/openai_ex/images.ex b/lib/openai_ex/image.ex → lib/openai_ex/images.ex
@@ -1,8 +1,8 @@
-defmodule OpenaiEx.Image do
+defmodule OpenaiEx.Images do
   @moduledoc """
   This module provides an implementation of the OpenAI images API. The API reference can be found at https://platform.openai.com/docs/api-reference/images.
   """
-  alias OpenaiEx.Image
+  alias OpenaiEx.Images
 
   @doc """
   Calls the image generation endpoint.
@@ -39,7 +39,7 @@ defmodule OpenaiEx.Image do
   def edit(openai = %OpenaiEx{}, image_edit = %{}) do
     openai
     |> OpenaiEx.Http.post("/images/edits",
-      multipart: image_edit |> OpenaiEx.Http.to_multi_part_form_data(Image.Edit.file_fields())
+      multipart: image_edit |> OpenaiEx.Http.to_multi_part_form_data(Images.Edit.file_fields())
     )
   end
 
@@ -61,7 +61,7 @@ defmodule OpenaiEx.Image do
     openai
     |> OpenaiEx.Http.post("/images/variations",
       multipart:
-        image_variation |> OpenaiEx.Http.to_multi_part_form_data(Image.Variation.file_fields())
+        image_variation |> OpenaiEx.Http.to_multi_part_form_data(Images.Variation.file_fields())
     )
   end
 end
diff --git a/lib/openai_ex/image_edit.ex → lib/openai_ex/images_edit.ex b/lib/openai_ex/image_edit.ex → lib/openai_ex/images_edit.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Image.Edit do
+defmodule OpenaiEx.Images.Edit do
   @moduledoc """
   This module provides constructors for OpenAI Image Edit API request structure. The API reference can be found at https://platform.openai.com/docs/api-reference/images/create-edit.
 

diff --git a/lib/openai_ex/image_generate.ex → lib/openai_ex/images_generate.ex b/lib/openai_ex/image_generate.ex → lib/openai_ex/images_generate.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Image.Generate do
+defmodule OpenaiEx.Images.Generate do
   @moduledoc """
   This module provides constructors for the OpenAI image generation API. The API
   reference can be found at https://platform.openai.com/docs/api-reference/images/create.
@@ -42,10 +42,10 @@ defmodule OpenaiEx.Image.Generate do
 
   Example usage:
 
-      iex> _request = OpenaiEx.Image.Generate.new(prompt: "This is a test")
+      iex> _request = OpenaiEx.Images.Generate.new(prompt: "This is a test")
       %{prompt: "This is a test"}
 
-      iex> _request = OpenaiEx.Image.Generate.new(%{prompt: "This is a test"})
+      iex> _request = OpenaiEx.Images.Generate.new(%{prompt: "This is a test"})
       %{prompt: "This is a test"}
   """
   def new(args = [_ | _]) do

diff --git a/lib/openai_ex/image_variation.ex → lib/openai_ex/images_variation.ex b/lib/openai_ex/image_variation.ex → lib/openai_ex/images_variation.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Image.Variation do
+defmodule OpenaiEx.Images.Variation do
   @moduledoc """
   This module provides constructors for OpenAI Image Variation API request structure. The API reference can be found at https://platform.openai.com/docs/api-reference/images/create-variation.
 

diff --git a/lib/openai_ex/model.ex → lib/openai_ex/models.ex b/lib/openai_ex/model.ex → lib/openai_ex/models.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Model do
+defmodule OpenaiEx.Models do
   @moduledoc """
   This module provides an implementation of the OpenAI Models API. Information about these models can be found at https://platform.openai.com/docs/models.
   """

diff --git a/lib/openai_ex/moderation.ex → lib/openai_ex/moderations.ex b/lib/openai_ex/moderation.ex → lib/openai_ex/moderations.ex
@@ -1,4 +1,4 @@
-defmodule OpenaiEx.Moderation do
+defmodule OpenaiEx.Moderations do
   @moduledoc """
   This module provides an implementation of the OpenAI moderation API. The API reference can be found at https://platform.openai.com/docs/api-reference/moderations.
 
@@ -29,12 +29,12 @@ defmodule OpenaiEx.Moderation do
 
   Example usage:
 
-      iex> OpenaiEx.Moderation.new(input: "This is a test")
+      iex> OpenaiEx.Moderations.new(input: "This is a test")
       %{
         input: "This is a test"
       }
 
-      iex> OpenaiEx.Moderation.new(%{input: "This is a test"})
+      iex> OpenaiEx.Moderations.new(%{input: "This is a test"})
       %{
         input: "This is a test"
       }

diff --git a/notebooks/dlai_orderbot.livemd b/notebooks/dlai_orderbot.livemd
@@ -7,7 +7,7 @@ Mix.install([
 ])
 
 alias OpenaiEx
-alias OpenaiEx.ChatCompletion
+alias OpenaiEx.Chat.Completions
 alias OpenaiEx.ChatMessage
 ```
 
@@ -35,7 +35,7 @@ openai =
 ```elixir
 defmodule OpenaiEx.Notebooks.DlaiOrderbot do
   alias OpenaiEx
-  alias OpenaiEx.ChatCompletion
+  alias OpenaiEx.Chat.Completions
 
   def create_chat_req(args = [_ | _]) do
     args

diff --git a/notebooks/images.livemd b/notebooks/images.livemd
@@ -9,7 +9,7 @@ Mix.install([
 ])
 
 alias OpenaiEx
-alias OpenaiEx.Image
+alias OpenaiEx.Images
 ```
 
 ## Simple Kino UI

diff --git a/notebooks/streaming_orderbot.livemd b/notebooks/streaming_orderbot.livemd
@@ -7,7 +7,7 @@ Mix.install([
 ])
 
 alias OpenaiEx
-alias OpenaiEx.ChatCompletion
+alias OpenaiEx.Chat.Completions
 alias OpenaiEx.ChatMessage
 ```
 
@@ -27,7 +27,7 @@ openai = System.fetch_env!("LB_OPENAI_API_KEY") |> OpenaiEx.new()
 ```elixir
 defmodule OpenaiEx.Notebooks.StreamingOrderbot do
   alias OpenaiEx
-  alias OpenaiEx.ChatCompletion
+  alias OpenaiEx.Chat.Completions
   require Logger
 
   def set_task_pid(task_pid) do