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

Represents a ChatKit thread and its current status.

Fields

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

  • :id - required - String.t()
    Identifier of the thread.

  • :object - required - :"chatkit.thread"
    Type discriminator that is always chatkit.thread.
    Allowed values: "chatkit.thread"
    Default: "chatkit.thread"

  • :status - required - ExOpenAI.Components.ActiveStatus.t() | ExOpenAI.Components.LockedStatus.t() | ExOpenAI.Components.ClosedStatus.t()
    Current status for the thread. Defaults to active for newly created threads.

  • :title - required - String.t() | any()

  • :user - required - String.t()
    Free-form string that identifies your end user who owns the thread.

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ThreadResource{
  created_at: integer(),
  id: String.t(),
  object: :"chatkit.thread",
  status:
    (ExOpenAI.Components.ActiveStatus.t()
     | ExOpenAI.Components.LockedStatus.t())
    | ExOpenAI.Components.ClosedStatus.t(),
  title: String.t() | any(),
  user: String.t()
}