View Source OpenaiEx.Moderation (openai_ex v0.5.4)
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.
API Fields
The following fields can be used as parameters when creating a new moderation:
:input
:model
Summary
Functions
Calls the moderation endpoint.
Arguments
openai
: The OpenAI configuration to use.moderation
: The moderation request to send.
Returns
A map containing the fields of the moderation response.
Creates a new moderation request with the given arguments.
Arguments
args
: A list of key-value pairs, or a map, representing the fields of the moderation request.
Returns
A map containing the fields of the moderation request.
The :input
field is required.
Example usage:
iex> OpenaiEx.Moderation.new(input: "This is a test")
%{
input: "This is a test"
}
iex> OpenaiEx.Moderation.new(%{input: "This is a test"})
%{
input: "This is a test"
}