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

Record of a client side tool invocation initiated by the assistant.

Fields

  • :arguments - required - String.t()
    JSON-encoded arguments that were sent to the tool.

  • :call_id - required - String.t()
    Identifier for the client tool call.

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

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

  • :name - required - String.t()
    Tool name that was invoked.

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

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

  • :status - required - ExOpenAI.Components.ClientToolCallStatus.t()
    Execution status for the tool call.

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

  • :type - required - :"chatkit.client_tool_call"
    Type discriminator that is always chatkit.client_tool_call.
    Allowed values: "chatkit.client_tool_call"
    Default: "chatkit.client_tool_call"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.ClientToolCallItem{
  arguments: String.t(),
  call_id: String.t(),
  created_at: integer(),
  id: String.t(),
  name: String.t(),
  object: :"chatkit.thread_item",
  output: String.t() | any(),
  status: ExOpenAI.Components.ClientToolCallStatus.t(),
  thread_id: String.t(),
  type: :"chatkit.client_tool_call"
}