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.
public class Function : Tool
- Inheritance
-
objectFunction
- Inherited Members
Constructors
Function()
public Function()
Function(string, string)
public Function(string name, string description = null)
Parameters
namestringdescriptionstring
Properties
Arguments
Google Gemini-specific. The function parameters and values in JSON object format.
public string Arguments { get; set; }
Property Value
- string
Description
Required. A brief description of the function.
public string Description { get; set; }
Property Value
- string
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.
public string Name { get; set; }
Property Value
- string
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.
public JsonSchema Parameters { get; set; }
Property Value
- JsonSchema
Strict
Optional. Only maintained for compatibility reasons.
public bool? Strict { get; set; }
Property Value
- bool?
Methods
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.
public static Function Create<T>(string name, string description = null) where T : class
Parameters
namestringdescriptionstring
Returns
Type Parameters
T