// Copyright (c) Microsoft. All rights reserved.
using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.Plugins.OpenApi;
namespace Plugins;
public class CreatePluginFromOpenApiSpec_Klarna(ITestOutputHelper output) : BaseTest(output)
{
///
/// This sample shows how to invoke an OpenApi plugin.
///
///
/// You must provide the plugin name and a URI to the Open API manifest before running this sample.
///
[Fact(Skip = "Run it only after filling the template below")]
public async Task InvokeOpenApiPluginAsync()
{
Kernel kernel = new();
// This HTTP client is optional. SK will fallback to a default internal one if omitted.
using HttpClient httpClient = new();
// Import an Open AI plugin via URI
var plugin = await kernel.ImportPluginFromOpenApiAsync("", new Uri(""), new OpenApiFunctionExecutionParameters(httpClient));
// Add arguments for required parameters, arguments for optional ones can be skipped.
var arguments = new KernelArguments { [""] = "" };
// Run
var functionResult = await kernel.InvokeAsync(plugin[""], arguments);
var result = functionResult.GetValue();
Console.WriteLine($"Function execution result: {result?.Content}");
}
///
/// This sample shows how to invoke the Klarna Get Products function as an OpenAPI plugin.
///
[Fact]
public async Task InvokeKlarnaGetProductsAsOpenApiPluginAsync()
{
Kernel kernel = new();
var plugin = await kernel.ImportPluginFromOpenApiAsync("Klarna", new Uri("https://www.klarna.com/us/shopping/public/openai/v0/api-docs/"));
var arguments = new KernelArguments
{
["q"] = "Laptop", // Category or product that needs to be searched for.
["size"] = "3", // Number of products to return
["budget"] = "200", // Maximum price of the matching product in local currency
["countryCode"] = "US" // ISO 3166 country code with 2 characters based on the user location.
};
// Currently, only US, GB, DE, SE and DK are supported.
var functionResult = await kernel.InvokeAsync(plugin["productsUsingGET"], arguments);
var result = functionResult.GetValue();
Console.WriteLine($"Function execution result: {result?.Content}");
}
///
/// This sample shows how to use a delegating handler when invoking an OpenAPI function.
///
///
/// An instances of will be set in the `HttpRequestMessage.Options` (for .NET 5.0 or higher) or
/// in the `HttpRequestMessage.Properties` dictionary (for .NET Standard) with the key `KernelFunctionContextKey`.
/// The contains the , and .
///
[Fact]
public async Task UseDelegatingHandlerWhenInvokingAnOpenApiFunctionAsync()
{
using var httpHandler = new HttpClientHandler();
using var customHandler = new CustomHandler(httpHandler);
using HttpClient httpClient = new(customHandler);
Kernel kernel = new();
var plugin = await kernel.ImportPluginFromOpenApiAsync("Klarna", new Uri("https://www.klarna.com/us/shopping/public/openai/v0/api-docs/"), new OpenApiFunctionExecutionParameters(httpClient));
var arguments = new KernelArguments
{
["q"] = "Laptop", // Category or product that needs to be searched for.
["size"] = "3", // Number of products to return
["budget"] = "200", // Maximum price of the matching product in local currency
["countryCode"] = "US" // ISO 3166 country code with 2 characters based on the user location.
};
// Currently, only US, GB, DE, SE and DK are supported.
var functionResult = await kernel.InvokeAsync(plugin["productsUsingGET"], arguments);
var result = functionResult.GetValue();
Console.WriteLine($"Function execution result: {result?.Content}");
}
///
/// Custom delegating handler to modify the before sending it.
///
private sealed class CustomHandler(HttpMessageHandler innerHandler) : DelegatingHandler(innerHandler)
{
protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
#if NET
request.Options.TryGetValue(OpenApiKernelFunctionContext.KernelFunctionContextKey, out var functionContext);
#else
request.Properties.TryGetValue(OpenApiKernelFunctionContext.KernelFunctionContextKey, out var functionContext);
#endif
// Function context is only set when the Plugin is invoked via the Kernel
if (functionContext is not null)
{
// Modify the HttpRequestMessage
request.Headers.Add("Kernel-Function-Name", functionContext?.Function?.Name);
}
// Call the next handler in the pipeline
return await base.SendAsync(request, cancellationToken);
}
}
}