class

OpenAI::CustomToolParam

Inherits JSON::Serializable < Reference < Object

A custom tool that processes input using a specified format. Learn more about custom tools

Constructors

new(type_value : CustomToolParamType = CustomToolParamType::Custom, name : String = "", description : String | Nil = nil, format : CustomToolParamFormat | Nil = nil)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

description

Optional description of the custom tool, used to provide more context.

Source

description=(description : String | Nil)

Optional description of the custom tool, used to provide more context.

Source

format

The input format for the custom tool. Default is unconstrained text.

Source

format=(format : CustomToolParamFormat | Nil)

The input format for the custom tool. Default is unconstrained text.

Source

name

The name of the custom tool, used to identify it in tool calls.

Source

name=(name : String)

The name of the custom tool, used to identify it in tool calls.

Source

type_value

The type of the custom tool. Always custom.

Source

type_value=(type_value : CustomToolParamType)

The type of the custom tool. Always custom.

Source