Current section
Files
Jump to
Current section
Files
lib/ex_openai/generated/components/response_refusal_done_event.ex
defmodule ExOpenAI.Components.ResponseRefusalDoneEvent do
use ExOpenAI.Jason
@moduledoc """
Emitted when refusal text is finalized.
## Fields
* `:content_index` - **required** - `integer()`
The index of the content part that the refusal text is finalized.
* `:item_id` - **required** - `String.t()`
The ID of the output item that the refusal text is finalized.
* `:output_index` - **required** - `integer()`
The index of the output item that the refusal text is finalized.
* `:refusal` - **required** - `String.t()`
The refusal text that is finalized.
* `:sequence_number` - **required** - `integer()`
The sequence number of this event.
* `:type` - **required** - `:"response.refusal.done"`
The type of the event. Always `response.refusal.done`.
Allowed values: `"response.refusal.done"`
"""
@type t() :: %{
__struct__: __MODULE__,
content_index: integer(),
item_id: String.t(),
output_index: integer(),
refusal: String.t(),
sequence_number: integer(),
type: :"response.refusal.done"
}
defstruct [:content_index, :item_id, :output_index, :refusal, :sequence_number, :type]
end