Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.Net: Function name policy to control function fqn creation and parsing #10206

Closed
wants to merge 7 commits into from
Closed

.Net: Function name policy to control function fqn creation and parsing #10206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e804862
add funciton name policy to control funciton fqn creation and parsing
SergeyMenshykh Jan 15, 2025
2f2717c
update sample
SergeyMenshykh Jan 16, 2025
9f8617b
fix typo
SergeyMenshykh Jan 16, 2025
a6e5360
add funciton name policy parameter to add extensio methods and genera…
SergeyMenshykh Jan 16, 2025
9507519
Merge branch 'main' into function-name-policy
SergeyMenshykh Jan 16, 2025
b14463a
update xml comments for samples
SergeyMenshykh Jan 16, 2025
b924041
Merge branch 'function-name-policy' of https://github.com/SergeyMensh…
SergeyMenshykh Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 174 additions & 0 deletions dotnet/samples/Concepts/FunctionCalling/FunctionCalling_FunctionNamePolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
// Copyright (c) Microsoft. All rights reserved.

using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.ChatCompletion;

namespace FunctionCalling;

/// <summary>
/// These samples demonstrate how to use a custom function name policy to specify a separator for creating Fully Qualified Name (FQN) for functions when advertising them to AI models
/// and for parsing them when handling function calls from the models.
/// </summary>
public class FunctionCalling_FunctionNamePolicy(ITestOutputHelper output) : BaseTest(output)
{
/// <summary>
/// This sample demonstrates how to use an underscore as the function FQN separator.
/// This can be useful if the default separator, which is a hyphen ("-"), is not suitable for your needs.
/// For example, if your plugin name is "foo" and your function name is "bar," the function FQN will be "foo_bar" instead of "foo-bar".
/// </summary>
/// <remarks>
/// Using the underscore as the separator won't work if your function names have underscores, e.g., they follow the snake convention in which words are separated by underscores.
/// </remarks>
[Fact]
public async Task UseUnderscoreAsFunctionFqnSeparatorAsync()
{
// Create an instance of the kernel builder.
IKernelBuilder builder = Kernel.CreateBuilder();

// Register the OpenAI chat completion service and specify a custom function name policy that uses an underscore as the separator.
builder.AddOpenAIChatCompletion(
TestConfiguration.OpenAI.ChatModelId,
TestConfiguration.OpenAI.ApiKey,
functionNamePolicy: FunctionNamePolicy.Custom("_"));

// Build the kernel and import the UtilsPlugin.
Kernel kernel = builder.Build();
kernel.ImportPluginFromType<UtilsPlugin>();

IChatCompletionService chatCompletionService = kernel.GetRequiredService<IChatCompletionService>();

ChatMessageContent result = await chatCompletionService.GetChatMessageContentAsync(
"Given the current time of day and weather, what is the likely color of the sky in Boston?",
new() { FunctionChoiceBehavior = FunctionChoiceBehavior.Auto() },
kernel);

// Assert
Console.WriteLine(result);

// Expected output: "The likely color of the sky in Boston is gray due to the current rainy weather."
}

/// <summary>
/// This sample demonstrates how to use only function names as FQNs without plugin names included.
/// For example, if your plugin name is "foo" and your function name is "bar" the function's FQN will be "bar" instead of "foo-bar."
/// </summary>
[Fact]
public async Task UseOnlyFunctionNameAndDoNotUsePluginNameForFqnAsync()
{
// Create an instance of the kernel builder.
IKernelBuilder builder = Kernel.CreateBuilder();

// Register the OpenAI chat completion service and specify a custom function name policy that uses an underscore as the separator.
builder.AddOpenAIChatCompletion(
TestConfiguration.OpenAI.ChatModelId,
TestConfiguration.OpenAI.ApiKey,
functionNamePolicy: FunctionNamePolicy.FunctionNameOnly);

// Build the kernel and import the UtilsPlugin.
Kernel kernel = builder.Build();
kernel.ImportPluginFromType<UtilsPlugin>();

IChatCompletionService chatCompletionService = kernel.GetRequiredService<IChatCompletionService>();

ChatMessageContent result = await chatCompletionService.GetChatMessageContentAsync(
"Given the current time of day and weather, what is the likely color of the sky in Boston?",
new() { FunctionChoiceBehavior = FunctionChoiceBehavior.Auto() },
kernel);

// Assert
Console.WriteLine(result);

// Expected output: "The likely color of the sky in Boston is gray due to the current rainy weather."
}

/// <summary>
/// This sample demonstrates how to use a custom function FQN parser to handle hallucinated function names called by the AI model.
/// It addresses the scenario where the AI model calls functions using a different separator than the one used to advertise the functions.
/// For example, you function is advertised as "foo-bar" but the AI model calls it as "foo_bar"
/// </summary>
[Fact]
public async Task RecoverHallucinatedFunctionNameAsync()
{
// Create an instance of the kernel builder.
IKernelBuilder builder = Kernel.CreateBuilder();

// Define a custom function FQN parser that can handle a hallucinated function name.
static (string? PluginName, string FunctionName) ParseFunctionFqn(ParseFunctionFqnContext context)
{
static (string? PluginName, string FunctionName)? Parse(ParseFunctionFqnContext context, char separator)
{
var parts = context.FunctionFqn.Split(separator);
if (parts.Length == 2)
{
// Check if the function registered in the kernel
if (context.Kernel is { } kernel && kernel.Plugins.TryGetFunction(parts[0], parts[1], out _))
{
return (parts[0], parts[1]);
}
}

return null;
}

// Try to use use hyphen, dot, and underscore sequentially as separators.
var result = Parse(context, '-') ??
Parse(context, '.') ??
Parse(context, '_');

if (result is not null)
{
return result.Value;
}

// If no separator is found, return the function name as is allowing AI connector to apply default behavior.
return (null, context.FunctionFqn);
}

// Register the OpenAI chat completion service and specify a custom function name policy that uses an underscore as the separator.
builder.AddOpenAIChatCompletion(
TestConfiguration.OpenAI.ChatModelId,
TestConfiguration.OpenAI.ApiKey,
functionNamePolicy: FunctionNamePolicy.Custom("-", ParseFunctionFqn));

// Build the kernel and import the UtilsPlugin.
Kernel kernel = builder.Build();
kernel.ImportPluginFromType<UtilsPlugin>();

IChatCompletionService chatCompletionService = kernel.GetRequiredService<IChatCompletionService>();

ChatMessageContent result = await chatCompletionService.GetChatMessageContentAsync(
"Given the current time of day and weather, what is the likely color of the sky in Boston?",
new() { FunctionChoiceBehavior = FunctionChoiceBehavior.Auto() },
kernel);

// Assert
Console.WriteLine(result);

// Expected output: "The likely color of the sky in Boston is gray due to the current rainy weather."
}

public sealed class UtilsPlugin
{
[KernelFunction]
public string GetCurrentUtcDateTime()
{
return DateTime.UtcNow.ToString("R");
}

[KernelFunction]
public string GetWeatherForCity(string cityName, string currentDateTime)
{
return cityName switch
{
"Boston" => "61 and rainy",
"London" => "55 and cloudy",
"Miami" => "80 and sunny",
"Paris" => "60 and rainy",
"Tokyo" => "50 and sunny",
"Sydney" => "75 and sunny",
"Tel Aviv" => "80 and sunny",
_ => "31 and snowing",
};
}
}
}
130 changes: 130 additions & 0 deletions dotnet/src/Connectors/Connectors.AzureOpenAI/CompatibilitySuppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,System.String,Azure.Core.TokenCredential,System.String,System.String,System.Net.Http.HttpClient,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,System.String,System.String,System.String,System.String,System.Net.Http.HttpClient,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.String,Azure.Core.TokenCredential,System.String,System.String,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.String,System.String,System.String,System.String,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,Microsoft.Extensions.Logging.ILoggerFactory)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,System.String,Azure.Core.TokenCredential,System.String,System.Net.Http.HttpClient,Microsoft.Extensions.Logging.ILoggerFactory,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,System.String,System.String,System.String,System.Net.Http.HttpClient,Microsoft.Extensions.Logging.ILoggerFactory,System.String)</Target>
<Left>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/net8.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,System.String,Azure.Core.TokenCredential,System.String,System.String,System.Net.Http.HttpClient,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIKernelBuilderExtensions.AddAzureOpenAIChatCompletion(Microsoft.SemanticKernel.IKernelBuilder,System.String,System.String,System.String,System.String,System.String,System.Net.Http.HttpClient,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.String,Azure.Core.TokenCredential,System.String,System.String,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.AzureOpenAIServiceCollectionExtensions.AddAzureOpenAIChatCompletion(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.String,System.String,System.String,System.String,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,Azure.AI.OpenAI.AzureOpenAIClient,System.String,Microsoft.Extensions.Logging.ILoggerFactory)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,System.String,Azure.Core.TokenCredential,System.String,System.Net.Http.HttpClient,Microsoft.Extensions.Logging.ILoggerFactory,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
<Suppression>
<DiagnosticId>CP0002</DiagnosticId>
<Target>M:Microsoft.SemanticKernel.Connectors.AzureOpenAI.AzureOpenAIChatCompletionService.#ctor(System.String,System.String,System.String,System.String,System.Net.Http.HttpClient,Microsoft.Extensions.Logging.ILoggerFactory,System.String)</Target>
<Left>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Left>
<Right>lib/netstandard2.0/Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll</Right>
<IsBaselineSuppression>true</IsBaselineSuppression>
</Suppression>
</Suppressions>
Loading
Loading