class OpenAI::ChatFunction

Included Modules

Extended Modules

Defined in:

openai/api/chat.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(name : String, parameters : JSON::Any, description : Nil | String = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def description : String | Nil #

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


[View source]
def description=(description : String | Nil) #

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


[View source]
def 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.


[View source]
def 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.


[View source]
def 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": {}}.


[View source]
def 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": {}}.


[View source]