class

OpenAI::ChatFunction

Inherits JSON::Serializable / Reference / Object

Constructors

new(name : String, parameters : JSON::Any, description : Nil | String = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

description

A description of what the function does, used by the model to choose when and how to call the function.

Source
description=(description : String | Nil)

A description of what the function does, used by the model to choose when and how to call the function.

Source
name

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Source
name=(name : String)

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Source
parameters

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.

Source
parameters=(parameters : JSON::Any)

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.

Source