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

An object representing a list of chat completion messages.

Fields

:data - required - [{:%{}, [], [{{:optional, [], [:annotations]}, {:list, [], [{:%{}, [], [{{:required, [], [:type]}, :url_citation}, {{:required, [], [:url_citation]}, {:%{}, [], [{{:required, [], [:end_index]}, {:integer, [], []}}, {{:required, [], [:start_index]}, {:integer, [], []}}, {{:required, [], [:title]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:url]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}}]}]}}, {{:optional, [], [:audio]}, {:|, [], [{:%{}, [], [{{:required, [], [:data]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:expires_at]}, {:integer, [], []}}, {{:required, [], [:id]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:transcript]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}, {:any, [], []}]}}, {{:required, [], [:content]}, {:|, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}, {:any, [], []}]}}, {{:optional, [], [:content_parts]}, {:|, [], [{:list, [], [{:|, [], [{{:., [], [ExOpenAI.Components.ChatCompletionRequestMessageContentPartText, :t]}, [], []}, {{:., [], [ExOpenAI.Components.ChatCompletionRequestMessageContentPartImage, :t]}, [], []}]}]}, {:any, [], []}]}}, {{:optional, [], [:function_call]}, {:%{}, [], [{{:required, [], [:arguments]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:name]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}}, {{:required, [], [:id]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:refusal]}, {:|, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}, {:any, [], []}]}}, {{:required, [], [:role]}, :assistant}, {{:optional, [], [:tool_calls]}, {{:., [], [ExOpenAI.Components.ChatCompletionMessageToolCalls, :t]}, [], []}}]}]
An array of chat completion message objects.
:first_id - required - String.t()
The identifier of the first chat message in the data array.
:has_more - required - boolean()
Indicates whether there are more chat messages available.
:last_id - required - String.t()
The identifier of the last chat message in the data array.
:object - required - :list
The type of this object. It is always set to "list".
Allowed values: "list"
Default: "list"

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.ChatCompletionMessageList{
  data: [
    %{
      optional(:annotations) => [
        %{
          type: :url_citation,
          url_citation: %{
            end_index: integer(),
            start_index: integer(),
            title: String.t(),
            url: String.t()
          }
        }
      ],
      optional(:audio) =>
        %{
          data: String.t(),
          expires_at: integer(),
          id: String.t(),
          transcript: String.t()
        }
        | any(),
      :content => String.t() | any(),
      optional(:content_parts) =>
        [
          ExOpenAI.Components.ChatCompletionRequestMessageContentPartText.t()
          | ExOpenAI.Components.ChatCompletionRequestMessageContentPartImage.t()
        ]
        | any(),
      optional(:function_call) => %{arguments: String.t(), name: String.t()},
      :id => String.t(),
      :refusal => String.t() | any(),
      :role => :assistant,
      optional(:tool_calls) =>
        ExOpenAI.Components.ChatCompletionMessageToolCalls.t()
    }
  ],
  first_id: String.t(),
  has_more: boolean(),
  last_id: String.t(),
  object: :list
}