View Source ExOpenAI.Components.CreateModerationResponse (ex_openai.ex v2.0.0-beta2)

Represents if a given text input is potentially harmful.

Fields

:id - required - String.t()
The unique identifier for the moderation request.
:model - required - String.t()
The model used to generate the moderation results.
:results - required - [{:%{}, [], [{{:required, [], [:categories]}, {:%{}, [], [{{:required, [], [:harassment]}, {:boolean, [], []}}, {{:required, [], [:"harassment/threatening"]}, {:boolean, [], []}}, {{:required, [], [:hate]}, {:boolean, [], []}}, {{:required, [], [:"hate/threatening"]}, {:boolean, [], []}}, {{:required, [], [:illicit]}, {:|, [], [{:boolean, [], []}, {:any, [], []}]}}, {{:required, [], [:"illicit/violent"]}, {:|, [], [{:boolean, [], []}, {:any, [], []}]}}, {{:required, [], [:"self-harm"]}, {:boolean, [], []}}, {{:required, [], [:"self-harm/instructions"]}, {:boolean, [], []}}, {{:required, [], [:"self-harm/intent"]}, {:boolean, [], []}}, {{:required, [], [:sexual]}, {:boolean, [], []}}, {{:required, [], [:"sexual/minors"]}, {:boolean, [], []}}, {{:required, [], [:violence]}, {:boolean, [], []}}, {{:required, [], [:"violence/graphic"]}, {:boolean, [], []}}]}}, {{:required, [], [:category_applied_input_types]}, {:%{}, [], [{{:required, [], [:harassment]}, {:list, [], [:text]}}, {{:required, [], [:"harassment/threatening"]}, {:list, [], [:text]}}, {{:required, [], [:hate]}, {:list, [], [:text]}}, {{:required, [], [:"hate/threatening"]}, {:list, [], [:text]}}, {{:required, [], [:illicit]}, {:list, [], [:text]}}, {{:required, [], [:"illicit/violent"]}, {:list, [], [:text]}}, {{:required, [], [:"self-harm"]}, {:list, [], [{:|, [], [:text, :image]}]}}, {{:required, [], [:"self-harm/instructions"]}, {:list, [], [{:|, [], [:text, :image]}]}}, {{:required, [], [:"self-harm/intent"]}, {:list, [], [{:|, [], [:text, :image]}]}}, {{:required, [], [:sexual]}, {:list, [], [{:|, [], [:text, :image]}]}}, {{:required, [], [:"sexual/minors"]}, {:list, [], [:text]}}, {{:required, [], [:violence]}, {:list, [], [{:|, [], [:text, :image]}]}}, {{:required, [], [:"violence/graphic"]}, {:list, [], [{:|, [], [:text, :image]}]}}]}}, {{:required, [], [:category_scores]}, {:%{}, [], [{{:required, [], [:harassment]}, {:number, [], []}}, {{:required, [], [:"harassment/threatening"]}, {:number, [], []}}, {{:required, [], [:hate]}, {:number, [], []}}, {{:required, [], [:"hate/threatening"]}, {:number, [], []}}, {{:required, [], [:illicit]}, {:number, [], []}}, {{:required, [], [:"illicit/violent"]}, {:number, [], []}}, {{:required, [], [:"self-harm"]}, {:number, [], []}}, {{:required, [], [:"self-harm/instructions"]}, {:number, [], []}}, {{:required, [], [:"self-harm/intent"]}, {:number, [], []}}, {{:required, [], [:sexual]}, {:number, [], []}}, {{:required, [], [:"sexual/minors"]}, {:number, [], []}}, {{:required, [], [:violence]}, {:number, [], []}}, {{:required, [], [:"violence/graphic"]}, {:number, [], []}}]}}, {{:required, [], [:flagged]}, {:boolean, [], []}}]}]
A list of moderation objects.

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.CreateModerationResponse{
  id: String.t(),
  model: String.t(),
  results: [
    %{
      categories: %{
        harassment: boolean(),
        "harassment/threatening": boolean(),
        hate: boolean(),
        "hate/threatening": boolean(),
        illicit: boolean() | any(),
        "illicit/violent": boolean() | any(),
        "self-harm": boolean(),
        "self-harm/instructions": boolean(),
        "self-harm/intent": boolean(),
        sexual: boolean(),
        "sexual/minors": boolean(),
        violence: boolean(),
        "violence/graphic": boolean()
      },
      category_applied_input_types: %{
        harassment: [:text],
        "harassment/threatening": [:text],
        hate: [:text],
        "hate/threatening": [:text],
        illicit: [:text],
        "illicit/violent": [:text],
        "self-harm": [:text | :image],
        "self-harm/instructions": [:text | :image],
        "self-harm/intent": [:text | :image],
        sexual: [:text | :image],
        "sexual/minors": [:text],
        violence: [:text | :image],
        "violence/graphic": [:text | :image]
      },
      category_scores: %{
        harassment: number(),
        "harassment/threatening": number(),
        hate: number(),
        "hate/threatening": number(),
        illicit: number(),
        "illicit/violent": number(),
        "self-harm": number(),
        "self-harm/instructions": number(),
        "self-harm/intent": number(),
        sexual: number(),
        "sexual/minors": number(),
        violence: number(),
        "violence/graphic": number()
      },
      flagged: boolean()
    }
  ]
}