Current section

Files

Jump to
ex_openai lib ex_openai generated components eval_item.ex
Raw

lib/ex_openai/generated/components/eval_item.ex

defmodule ExOpenAI.Components.EvalItem do
use ExOpenAI.Jason
@moduledoc """
A message input to the model with a role indicating instruction following
hierarchy. Instructions given with the `developer` or `system` role take
precedence over instructions given with the `user` role. Messages with the
`assistant` role are presumed to have been generated by the model in previous
interactions.
## Fields
* `:content` - **required** - `ExOpenAI.Components.EvalItemContent.t()`
* `:role` - **required** - `:user | :assistant | :system | :developer`
The role of the message input. One of `user`, `assistant`, `system`, or
`developer`.
Allowed values: `"user"`, `"assistant"`, `"system"`, `"developer"`
* `:type` - **optional** - `:message`
The type of the message input. Always `message`.
Allowed values: `"message"`
"""
@type t() :: %{
__struct__: __MODULE__,
content: ExOpenAI.Components.EvalItemContent.t(),
role: ((:user | :assistant) | :system) | :developer,
type: :message | nil
}
defstruct [:content, :role, :type]
end