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

Represents a step in execution of a run.

Fields

  • :assistant_id - required - String.t()
    The ID of the assistant associated with the run step.

  • :cancelled_at - required - integer() | any()

  • :completed_at - required - integer() | any()

  • :created_at - required - integer()
    The Unix timestamp (in seconds) for when the run step was created.

  • :expired_at - required - integer() | any()

  • :failed_at - required - integer() | any()

  • :id - required - String.t()
    The identifier of the run step, which can be referenced in API endpoints.

  • :last_error - required - {:%{}, [], [{{:required, [], [:code]}, {:|, [], [:server_error, :rate_limit_exceeded]}}, {{:required, [], [:message]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]} | any()

  • :metadata - required - ExOpenAI.Components.Metadata.t()

  • :object - required - :"thread.run.step"
    The object type, which is always thread.run.step.
    Allowed values: "thread.run.step"

  • :run_id - required - String.t()
    The ID of the run that this run step is a part of.

  • :status - required - :in_progress | :cancelled | :failed | :completed | :expired
    The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
    Allowed values: "in_progress", "cancelled", "failed", "completed", "expired"

  • :step_details - required - map()
    The details of the run step.

  • :thread_id - required - String.t()
    The ID of the thread that was run.

  • :type - required - :message_creation | :tool_calls
    The type of run step, which can be either message_creation or tool_calls.
    Allowed values: "message_creation", "tool_calls"

  • :usage - required - ExOpenAI.Components.RunStepCompletionUsage.t()

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RunStepObject{
  assistant_id: String.t(),
  cancelled_at: integer() | any(),
  completed_at: integer() | any(),
  created_at: integer(),
  expired_at: integer() | any(),
  failed_at: integer() | any(),
  id: String.t(),
  last_error:
    %{code: :server_error | :rate_limit_exceeded, message: String.t()} | any(),
  metadata: ExOpenAI.Components.Metadata.t(),
  object: :"thread.run.step",
  run_id: String.t(),
  status: (((:in_progress | :cancelled) | :failed) | :completed) | :expired,
  step_details: map(),
  thread_id: String.t(),
  type: :message_creation | :tool_calls,
  usage: ExOpenAI.Components.RunStepCompletionUsage.t()
}