Class Function

Structured representation of a function declaration as defined by the OpenAPI 3.03 specification. Included in this declaration are the function name and parameters. 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.

Inheritance
object
Tool
Function
Implements
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
[JsonConverter(typeof(FunctionConverter))]
public sealed class Function : Tool, IHasName

Constructors

| Edit this page View Source

Function()

Declaration
public Function()
| Edit this page View Source

Function(string, string)

Declaration
public Function(string name, string description = null)
Parameters
Type Name Description
string name
string description

Properties

| Edit this page View Source

Arguments

Google Gemini-specific. The function parameters and values in JSON object format.

Declaration
[JsonProperty("args")]
public string Arguments { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Description

Required. A brief description of the function.

Declaration
[JsonProperty("description")]
public string Description { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Name

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

Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Parameters

Optional.

Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case-sensitive. Schema Value: the Schema defining the type used for the parameter.

In Generative AI (Google), Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.

Declaration
[JsonProperty("parameters")]
public JsonSchema Parameters { get; set; }
Property Value
Type Description
JsonSchema
| Edit this page View Source

Strict

Optional. Only maintained for compatibility reasons.

Declaration
[JsonProperty("strict")]
public bool? Strict { get; set; }
Property Value
Type Description
bool?

Methods

| Edit this page View Source

Create<T>(string, string)

Creates a Function declaration from a given type. The type's properties will be used to define the function's parameters.

Declaration
public static Function Create<T>(string name, string description = null) where T : class
Parameters
Type Name Description
string name
string description
Returns
Type Description
Function
Type Parameters
Name Description
T

Implements

Extension Methods