Class FunctionBuilder
Fluent builder for creating function definitions
public class FunctionBuilder
- Inheritance
-
FunctionBuilder
- Inherited Members
Methods
AddEnumParameter(string, string, List<string>, bool, string?)
Adds an enum parameter to the function
public FunctionBuilder AddEnumParameter(string name, string description, List<string> values, bool required = false, string? defaultValue = null)
Parameters
Returns
AddParameter(string, string, string, bool, object?)
Adds a parameter to the function
public FunctionBuilder AddParameter(string name, string type, string description, bool required = false, object? defaultValue = null)
Parameters
Returns
Build()
Builds the final FunctionDefinition
public FunctionDefinition Build()
Returns
Create(string)
Creates a new FunctionBuilder instance
public static FunctionBuilder Create(string name)
Parameters
namestring
Returns
WithAsync(bool)
Allows supporting models and APIs to continue while this function executes. Unsupported providers retain the ordinary blocking tool-call flow.
public FunctionBuilder WithAsync(bool allowAsync = true)
Parameters
allowAsyncbool
Returns
WithDescription(string)
Sets the function description
public FunctionBuilder WithDescription(string description)
Parameters
descriptionstring
Returns
WithHandler(Func<Dictionary<string, object>, string>)
Sets a synchronous function handler
public FunctionBuilder WithHandler(Func<Dictionary<string, object>, string> handler)
Parameters
handlerFunc<Dictionary<string, object>, string>
Returns
WithHandler(Func<Dictionary<string, object>, CancellationToken, string>)
Sets a synchronous function handler that receives execution cancellation.
public FunctionBuilder WithHandler(Func<Dictionary<string, object>, CancellationToken, string> handler)
Parameters
handlerFunc<Dictionary<string, object>, CancellationToken, string>
Returns
WithHandler(Func<Dictionary<string, object>, CancellationToken, Task<string>>)
Sets an asynchronous function handler that receives execution cancellation. Use the token in cancellable operations to stop work when the run is cancelled.
public FunctionBuilder WithHandler(Func<Dictionary<string, object>, CancellationToken, Task<string>> handler)
Parameters
handlerFunc<Dictionary<string, object>, CancellationToken, Task<string>>
Returns
WithHandler(Func<Dictionary<string, object>, Task<string>>)
Sets the function handler
public FunctionBuilder WithHandler(Func<Dictionary<string, object>, Task<string>> handler)