FunctionDeclaration
public struct FunctionDeclaration
extension FunctionDeclaration: Encodable
Structured representation of a function declaration.
This FunctionDeclaration
is a representation of a block of code that can be used as a Tool
by the model and executed by the client.
-
Constructs a new
FunctionDeclaration
.Declaration
Swift
public init(name: String, description: String, parameters: [String: Schema]?, requiredParameters: [String]? = nil)
Parameters
name
The name of the function; must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 63.
description
A brief description of the function.
parameters
Describes the parameters to this function; the keys are parameter names and the values are
Schema
objects describing them.requiredParameters
A list of required parameters by name.
-
Declaration
Swift
public func encode(to encoder: Encoder) throws