AIFunctionFactory.Create Method

public:
 static Microsoft::Extensions::AI::AIFunction ^ Create(Delegate ^ method, Microsoft::Extensions::AI::AIFunctionFactoryOptions ^ options);

public static Microsoft.Extensions.AI.AIFunction Create(Delegate method, Microsoft.Extensions.AI.AIFunctionFactoryOptions? options);

static member Create : Delegate * Microsoft.Extensions.AI.AIFunctionFactoryOptions -> Microsoft.Extensions.AI.AIFunction

Public Shared Function Create (method As Delegate, options As AIFunctionFactoryOptions) As AIFunction

Parameters

Returns

The created AIFunction for invoking method.

Exceptions

Remarks

By default, any parameters to method are sourced from the AIFunctionArguments's dictionary of key/value pairs and are represented in the JSON schema for the function, as exposed in the returned AIFunction's JsonSchema. There are a few exceptions to this:

• CancellationToken parameters are automatically bound to the CancellationToken passed into the invocation via InvokeAsync(AIFunctionArguments, CancellationToken)'s CancellationToken parameter. The parameter is not included in the generated JSON schema. The behavior of CancellationToken parameters may not be overridden.
• By default, IServiceProvider parameters are bound from the Services property and are not included in the JSON schema. If the parameter is optional, such that a default value is provided, Services is allowed to be null; otherwise, Services must be non-null, or else the invocation will fail with an exception due to the required nature of the parameter. The handling of IServiceProvider parameters may be overridden via ConfigureParameterBinding.
• By default, AIFunctionArguments parameters are bound directly to AIFunctionArguments instance passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are not included in the JSON schema. If the AIFunctionArguments instance passed to InvokeAsync(AIFunctionArguments, CancellationToken) is null, the AIFunction implementation manufactures an empty instance, such that parameters of type AIFunctionArguments may always be satisfied, whether optional or not. The handling of AIFunctionArguments parameters may be overridden via ConfigureParameterBinding.

All other parameter types are, by default, bound from the AIFunctionArguments dictionary passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are included in the generated JSON schema. This may be overridden by the ConfigureParameterBinding provided via the options parameter; for every parameter, the delegate is enabled to choose if the parameter should be included in the generated schema and how its value should be bound, including handling of optionality (by default, required parameters that are not included in the AIFunctionArguments dictionary will result in an exception being thrown). Loosely-typed additional context information may be passed into InvokeAsync(AIFunctionArguments, CancellationToken) via the AIFunctionArguments's Context dictionary; the default binding ignores this collection, but a custom binding supplied via ConfigureParameterBinding may choose to source arguments from this data.

The default marshaling of parameters from the AIFunctionArguments dictionary permits values to be passed into the method's invocation directly if the object is already of a compatible type. Otherwise, if the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized into the parameter type, utilizing SerializerOptions if provided, or else using DefaultOptions. If the argument is anything else, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

In general, the data supplied via an AIFunctionArguments's dictionary is supplied from an AI service and should be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of method, consider having method point to an instance method on an instance configured to hold the appropriate state. An IServiceProvider parameter may also be used to resolve services from a dependency injection container.

By default, return values are serialized to JsonElement using options's SerializerOptions if provided, or else using DefaultOptions. Handling of return values may be overridden via MarshalResult.

public:
 static Microsoft::Extensions::AI::AIFunction ^ Create(System::Reflection::MethodInfo ^ method, System::Object ^ target, Microsoft::Extensions::AI::AIFunctionFactoryOptions ^ options);

public static Microsoft.Extensions.AI.AIFunction Create(System.Reflection.MethodInfo method, object? target, Microsoft.Extensions.AI.AIFunctionFactoryOptions? options);

static member Create : System.Reflection.MethodInfo * obj * Microsoft.Extensions.AI.AIFunctionFactoryOptions -> Microsoft.Extensions.AI.AIFunction

Public Shared Function Create (method As MethodInfo, target As Object, options As AIFunctionFactoryOptions) As AIFunction

Parameters

Returns

The created AIFunction for invoking method.

Exceptions

Remarks

By default, any parameters to method are sourced from the AIFunctionArguments's dictionary of key/value pairs and are represented in the JSON schema for the function, as exposed in the returned AIFunction's JsonSchema. There are a few exceptions to this:

• CancellationToken parameters are automatically bound to the CancellationToken passed into the invocation via InvokeAsync(AIFunctionArguments, CancellationToken)'s CancellationToken parameter. The parameter is not included in the generated JSON schema. The behavior of CancellationToken parameters may not be overridden.
• By default, IServiceProvider parameters are bound from the Services property and are not included in the JSON schema. If the parameter is optional, such that a default value is provided, Services is allowed to be null; otherwise, Services must be non-null, or else the invocation will fail with an exception due to the required nature of the parameter. The handling of IServiceProvider parameters may be overridden via ConfigureParameterBinding.
• By default, AIFunctionArguments parameters are bound directly to AIFunctionArguments instance passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are not included in the JSON schema. If the AIFunctionArguments instance passed to InvokeAsync(AIFunctionArguments, CancellationToken) is null, the AIFunction implementation manufactures an empty instance, such that parameters of type AIFunctionArguments may always be satisfied, whether optional or not. The handling of AIFunctionArguments parameters may be overridden via ConfigureParameterBinding.

All other parameter types are, by default, bound from the AIFunctionArguments dictionary passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are included in the generated JSON schema. This may be overridden by the ConfigureParameterBinding provided via the options parameter; for every parameter, the delegate is enabled to choose if the parameter should be included in the generated schema and how its value should be bound, including handling of optionality (by default, required parameters that are not included in the AIFunctionArguments dictionary will result in an exception being thrown). Loosely-typed additional context information may be passed into InvokeAsync(AIFunctionArguments, CancellationToken) via the AIFunctionArguments's Context dictionary; the default binding ignores this collection, but a custom binding supplied via ConfigureParameterBinding may choose to source arguments from this data.

The default marshaling of parameters from the AIFunctionArguments dictionary permits values to be passed into the method's invocation directly if the object is already of a compatible type. Otherwise, if the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized into the parameter type, utilizing SerializerOptions if provided, or else using DefaultOptions. If the argument is anything else, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

In general, the data supplied via an AIFunctionArguments's dictionary is supplied from an AI service and should be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of method, consider having method point to an instance method on an instance configured to hold the appropriate state. An IServiceProvider parameter may also be used to resolve services from a dependency injection container.

By default, return values are serialized to JsonElement using options's SerializerOptions if provided, or else using DefaultOptions. Handling of return values may be overridden via MarshalResult.

public static Microsoft.Extensions.AI.AIFunction Create(System.Reflection.MethodInfo method, Type targetType, Microsoft.Extensions.AI.AIFunctionFactoryOptions? options = default);

static member Create : System.Reflection.MethodInfo * Type * Microsoft.Extensions.AI.AIFunctionFactoryOptions -> Microsoft.Extensions.AI.AIFunction

Public Shared Function Create (method As MethodInfo, targetType As Type, Optional options As AIFunctionFactoryOptions = Nothing) As AIFunction

Parameters

Returns

The created AIFunction for invoking method.

Exceptions

Remarks

Return values are serialized to JsonElement using options's SerializerOptions. Arguments that are not already of the expected type are marshaled to the expected type via JSON and using options's SerializerOptions. If the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized directly. If the argument is anything else unknown, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

By default, any parameters to method are sourced from the AIFunctionArguments's dictionary of key/value pairs and are represented in the JSON schema for the function, as exposed in the returned AIFunction's JsonSchema. There are a few exceptions to this:

• CancellationToken parameters are automatically bound to the CancellationToken passed into the invocation via InvokeAsync(AIFunctionArguments, CancellationToken)'s CancellationToken parameter. The parameter is not included in the generated JSON schema. The behavior of CancellationToken parameters may not be overridden.
• By default, IServiceProvider parameters are bound from the Services property and are not included in the JSON schema. If the parameter is optional, such that a default value is provided, Services is allowed to be null; otherwise, Services must be non-null, or else the invocation will fail with an exception due to the required nature of the parameter. The handling of IServiceProvider parameters may be overridden via ConfigureParameterBinding.
• By default, AIFunctionArguments parameters are bound directly to AIFunctionArguments instance passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are not included in the JSON schema. If the AIFunctionArguments instance passed to InvokeAsync(AIFunctionArguments, CancellationToken) is null, the AIFunction implementation manufactures an empty instance, such that parameters of type AIFunctionArguments may always be satisfied, whether optional or not. The handling of AIFunctionArguments parameters may be overridden via ConfigureParameterBinding.

All other parameter types are, by default, bound from the AIFunctionArguments dictionary passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are included in the generated JSON schema. This may be overridden by the ConfigureParameterBinding provided via the options parameter; for every parameter, the delegate is enabled to choose if the parameter should be included in the generated schema and how its value should be bound, including handling of optionality (by default, required parameters that are not included in the AIFunctionArguments dictionary will result in an exception being thrown). Loosely-typed additional context information may be passed into InvokeAsync(AIFunctionArguments, CancellationToken) via the AIFunctionArguments's Context dictionary; the default binding ignores this collection, but a custom binding supplied via ConfigureParameterBinding may choose to source arguments from this data.

The default marshaling of parameters from the AIFunctionArguments dictionary permits values to be passed into the method's invocation directly if the object is already of a compatible type. Otherwise, if the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized into the parameter type, utilizing SerializerOptions if provided, or else using DefaultOptions. If the argument is anything else, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

In general, the data supplied via an AIFunctionArguments's dictionary is supplied from an AI service and should be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of method, the instance constructed for each invocation may contain that data in it, such that it's then available to method as instance data. An IServiceProvider parameter may also be used to resolve services from a dependency injection container.

By default, return values are serialized to JsonElement using options's SerializerOptions if provided, or else using DefaultOptions. Handling of return values may be overridden via MarshalResult.

Source:

AIFunctionFactory.cs

public static Microsoft.Extensions.AI.AIFunction Create(Delegate method, string? name = default, string? description = default, System.Text.Json.JsonSerializerOptions? serializerOptions = default);

static member Create : Delegate * string * string * System.Text.Json.JsonSerializerOptions -> Microsoft.Extensions.AI.AIFunction

Public Shared Function Create (method As Delegate, Optional name As String = Nothing, Optional description As String = Nothing, Optional serializerOptions As JsonSerializerOptions = Nothing) As AIFunction

Parameters

Returns

The created AIFunction for invoking method.

Exceptions

Remarks

Any parameters to method are sourced from the AIFunctionArguments's dictionary of key/value pairs and are represented in the JSON schema for the function, as exposed in the returned AIFunction's JsonSchema. There are a few exceptions to this:

• CancellationToken parameters are automatically bound to the CancellationToken passed into the invocation via InvokeAsync(AIFunctionArguments, CancellationToken)'s CancellationToken parameter. The parameter is not included in the generated JSON schema.
• By default, IServiceProvider parameters are bound from the Services property and are not included in the JSON schema. If the parameter is optional, such that a default value is provided, Services is allowed to be null; otherwise, Services must be non-null, or else the invocation will fail with an exception due to the required nature of the parameter.
• By default, AIFunctionArguments parameters are bound directly to AIFunctionArguments instance passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are not included in the JSON schema. If the AIFunctionArguments instance passed to InvokeAsync(AIFunctionArguments, CancellationToken) is null, the AIFunction implementation manufactures an empty instance, such that parameters of type AIFunctionArguments may always be satisfied, whether optional or not.

All other parameter types are bound from the AIFunctionArguments dictionary passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are included in the generated JSON schema.

The marshaling of parameters from the AIFunctionArguments dictionary permits values to be passed into the method's invocation directly if the object is already of a compatible type. Otherwise, if the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized into the parameter type, utilizing serializerOptions if provided, or else DefaultOptions. If the argument is anything else, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

In general, the data supplied via an AIFunctionArguments's dictionary is supplied from an AI service and should be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of method, consider having method point to an instance method on an instance configured to hold the appropriate state. An IServiceProvider parameter may also be used to resolve services from a dependency injection container.

Return values are serialized to JsonElement using serializerOptions if provided, or else using DefaultOptions.

Source:

AIFunctionFactory.cs

public static Microsoft.Extensions.AI.AIFunction Create(System.Reflection.MethodInfo method, object? target, string? name = default, string? description = default, System.Text.Json.JsonSerializerOptions? serializerOptions = default);

static member Create : System.Reflection.MethodInfo * obj * string * string * System.Text.Json.JsonSerializerOptions -> Microsoft.Extensions.AI.AIFunction

Public Shared Function Create (method As MethodInfo, target As Object, Optional name As String = Nothing, Optional description As String = Nothing, Optional serializerOptions As JsonSerializerOptions = Nothing) As AIFunction

Parameters

Returns

The created AIFunction for invoking method.

Exceptions

Remarks

Any parameters to method are sourced from the AIFunctionArguments's dictionary of key/value pairs and are represented in the JSON schema for the function, as exposed in the returned AIFunction's JsonSchema. There are a few exceptions to this:

• CancellationToken parameters are automatically bound to the CancellationToken passed into the invocation via InvokeAsync(AIFunctionArguments, CancellationToken)'s CancellationToken parameter. The parameter is not included in the generated JSON schema.
• By default, IServiceProvider parameters are bound from the Services property and are not included in the JSON schema. If the parameter is optional, such that a default value is provided, Services is allowed to be null; otherwise, Services must be non-null, or else the invocation will fail with an exception due to the required nature of the parameter.
• By default, AIFunctionArguments parameters are bound directly to AIFunctionArguments instance passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are not included in the JSON schema. If the AIFunctionArguments instance passed to InvokeAsync(AIFunctionArguments, CancellationToken) is null, the AIFunction implementation manufactures an empty instance, such that parameters of type AIFunctionArguments may always be satisfied, whether optional or not.

All other parameter types are bound from the AIFunctionArguments dictionary passed into InvokeAsync(AIFunctionArguments, CancellationToken) and are included in the generated JSON schema.

The marshaling of parameters from the AIFunctionArguments dictionary permits values to be passed into the method's invocation directly if the object is already of a compatible type. Otherwise, if the argument is a JsonElement, JsonDocument, or JsonNode, it is deserialized into the parameter type, utilizing serializerOptions if provided, or else DefaultOptions. If the argument is anything else, it is round-tripped through JSON, serializing the object as JSON and then deserializing it to the expected type.

In general, the data supplied via an AIFunctionArguments's dictionary is supplied from an AI service and should be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of method, consider having method point to an instance method on an instance configured to hold the appropriate state. An IServiceProvider parameter may also be used to resolve services from a dependency injection container.

Return values are serialized to JsonElement using serializerOptions if provided, or else using DefaultOptions.