class OpenAI::ChatFunction
- OpenAI::ChatFunction
- Reference
- Object
Included Modules
- JSON::Serializable
Extended Modules
- JSON::Schema
Defined in:
openai/api/chat.crConstructors
- .new(name : String, parameters : JSON::Any, description : Nil | String = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#description : String | Nil
A description of what the function does, used by the model to choose when and how to call the function.
-
#description=(description : String | Nil)
A description of what the function does, used by the model to choose when and how to call the function.
-
#name : String
The name of the function to be called.
-
#name=(name : String)
The name of the function to be called.
-
#parameters : JSON::Any
The parameters the functions accepts, described as a JSON Schema object.
-
#parameters=(parameters : JSON::Any)
The parameters the functions accepts, described as a JSON Schema object.
Constructor Detail
Instance Method Detail
A description of what the function does, used by the model to choose when and how to call the function.
A description of what the function does, used by the model to choose when and how to call the function.
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.
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.
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": {}}.
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": {}}.