Current section

Files

Jump to
openai_ex lib openai_ex moderations.ex
Raw

lib/openai_ex/moderations.ex

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.
"""
alias OpenaiEx.Http
@api_fields [
:input,
:model
]
@doc """
Creates a new moderation request with the given arguments.
Example usage:
iex> OpenaiEx.Moderations.new(input: "This is a test")
%{
input: "This is a test"
}
iex> OpenaiEx.Moderations.new(%{input: "This is a test"})
%{
input: "This is a test"
}
"""
def new(args = [_ | _]) do
args |> Enum.into(%{}) |> new()
end
def new(args = %{input: _}) do
args |> Map.take(@api_fields)
end
@doc """
Calls the moderation endpoint.
"""
def create!(openai = %OpenaiEx{}, moderation) do
openai |> create(moderation) |> Http.bang_it!()
end
def create(openai = %OpenaiEx{}, moderation) do
openai |> Http.post("/moderations", json: moderation |> Map.take(@api_fields))
end
end