Current section

Files

Jump to
ex_openai lib ex_openai generated components custom_tool_call_resource.ex
Raw

lib/ex_openai/generated/components/custom_tool_call_resource.ex

defmodule ExOpenAI.Components.CustomToolCallResource do
use ExOpenAI.Jason
@moduledoc """
Module for representing the OpenAI schema CustomToolCallResource.
## Fields
* `:call_id` - **required** - `String.t()`
An identifier used to map this custom tool call to a tool call output.
* `:created_by` - **optional** - `String.t()`
The identifier of the actor that created the item.
* `:id` - **required** - `String.t()`
The unique ID of the custom tool call item.
* `:input` - **required** - `String.t()`
The input for the custom tool call generated by the model.
* `:name` - **required** - `String.t()`
The name of the custom tool being called.
* `:namespace` - **optional** - `String.t()`
The namespace of the custom tool being called.
* `:status` - **required** - `ExOpenAI.Components.FunctionCallStatus.t()`
The status of the item. One of `in_progress`, `completed`, or
`incomplete`. Populated when items are returned via API.
* `:type` - **required** - `:custom_tool_call`
The type of the custom tool call. Always `custom_tool_call`.
Allowed values: `"custom_tool_call"`
"""
@type t() :: %{
__struct__: __MODULE__,
call_id: String.t(),
created_by: String.t() | nil,
id: String.t(),
input: String.t(),
name: String.t(),
namespace: String.t() | nil,
status: ExOpenAI.Components.FunctionCallStatus.t(),
type: :custom_tool_call
}
defstruct [:call_id, :created_by, :id, :input, :name, :namespace, :status, :type]
end