OpenAI Connector Migration Guide

2024-09-24

Coming as part of the new 1.18 version of Semantic Kernel we migrated our OpenAI and AzureOpenAI services to use the new OpenAI SDK v2.0 and Azure OpenAI SDK v2.0 SDKs.

As those changes were major breaking changes when implementing ours we looked forward to break as minimal as possible the dev experience.

This guide prepares you for the migration that you may need to do to use our new OpenAI Connector is a complete rewrite of the existing OpenAI Connector and is designed to be more efficient, reliable, and scalable. This manual will guide you through the migration process and help you understand the changes that have been made to the OpenAI Connector.

Those changes are needed for anyone using OpenAI or AzureOpenAI connectors with Semantic Kernel version 1.18.0-rc or above.

1. Package Setup when using Azure only services

If you are working with Azure services you will need to change the package from Microsoft.SemanticKernel.Connectors.OpenAI to Microsoft.SemanticKernel.Connectors.AzureOpenAI. This is necessary as we created two distinct connectors for each.

Important

The Microsoft.SemanticKernel.Connectors.AzureOpenAI package depends on the Microsoft.SemanticKernel.Connectors.OpenAI package so there's no need to add both to your project when using OpenAI related types.

Before
- using Microsoft.SemanticKernel.Connectors.OpenAI;
After
+ using Microsoft.SemanticKernel.Connectors.AzureOpenAI;

1.1 AzureOpenAIClient

When using Azure with OpenAI, before where you were using OpenAIClient you will need to update your code to use the new AzureOpenAIClient type.

1.2 Services

All services below now belong to the Microsoft.SemanticKernel.Connectors.AzureOpenAI namespace.

AzureOpenAIAudioToTextService
AzureOpenAIChatCompletionService
AzureOpenAITextEmbeddingGenerationService
AzureOpenAITextToAudioService
AzureOpenAITextToImageService

2. Text Generation Deprecation

The latest OpenAI SDK does not support text generation modality, when migrating to their underlying SDK we had to drop support as well and remove TextGeneration specific services.

If you were using OpenAI's gpt-3.5-turbo-instruct legacy model with any of the OpenAITextGenerationService or AzureOpenAITextGenerationService you will need to update your code to target a chat completion model instead, using OpenAIChatCompletionService or AzureOpenAIChatCompletionService instead.

Note

OpenAI and AzureOpenAI ChatCompletion services also implement the ITextGenerationService interface and that may not require any changes to your code if you were targeting the ITextGenerationService interface.

tags: AddOpenAITextGeneration, AddAzureOpenAITextGeneration

3. ChatCompletion Multiple Choices Deprecated

The latest OpenAI SDK does not support multiple choices, when migrating to their underlying SDK we had to drop the support and remove ResultsPerPrompt also from the OpenAIPromptExecutionSettings.

tags: results_per_prompt

4. OpenAI File Service Deprecation

The OpenAIFileService was deprecated in the latest version of the OpenAI Connector. We strongly recommend to update your code to use the new OpenAIClient.GetFileClient() for file management operations.

5. OpenAI ChatCompletion custom endpoint

The OpenAIChatCompletionService experimental constructor for custom endpoints will not attempt to auto-correct the endpoint and use it as is.

We have the two only specific cases where we attempted to auto-correct the endpoint.

If you provided chat/completions path before. Now those need to be removed as they are added automatically to the end of your original endpoint by OpenAI SDK.
```
- http://any-host-and-port/v1/chat/completions
+ http://any-host-and-port/v1
```
If you provided a custom endpoint without any path. We won't be adding the v1/ as the first path. Now the v1 path needs to provided as part of your endpoint.
```
- http://any-host-and-port/
+ http://any-host-and-port/v1
```

6. SemanticKernel MetaPackage

To be retrocompatible with the new OpenAI and AzureOpenAI Connectors, our Microsoft.SemanticKernel meta package changed its dependency to use the new Microsoft.SemanticKernel.Connectors.AzureOpenAI package that depends on the Microsoft.SemanticKernel.Connectors.OpenAI package. This way if you are using the metapackage, no change is needed to get access to Azure related types.

7. Chat Message Content Changes

7.1 OpenAIChatMessageContent

The Tools property type has changed from IReadOnlyList<ChatCompletionsToolCall> to IReadOnlyList<ChatToolCall>.
Inner content type has changed from ChatCompletionsFunctionToolCall to ChatToolCall.
Metadata type FunctionToolCalls has changed from IEnumerable<ChatCompletionsFunctionToolCall> to IEnumerable<ChatToolCall>.

7.2 OpenAIStreamingChatMessageContent

The FinishReason property type has changed from CompletionsFinishReason to FinishReason.
The ToolCallUpdate property has been renamed to ToolCallUpdates and its type has changed from StreamingToolCallUpdate? to IReadOnlyList<StreamingToolCallUpdate>?.
The AuthorName property is not initialized because it's not provided by the underlying library anymore.

8. Metrics for AzureOpenAI Connector

The meter s_meter = new("Microsoft.SemanticKernel.Connectors.OpenAI"); and the relevant counters still have old names that contain "openai" in them, such as:

semantic_kernel.connectors.openai.tokens.prompt
semantic_kernel.connectors.openai.tokens.completion
semantic_kernel.connectors.openai.tokens.total

9. Using Azure with your data (Data Sources)

With the new AzureOpenAIClient, you can now specify your datasource thru the options and that requires a small change in your code to the new type.

Before

var promptExecutionSettings = new OpenAIPromptExecutionSettings
{
    AzureChatExtensionsOptions = new AzureChatExtensionsOptions
    {
        Extensions = [ new AzureSearchChatExtensionConfiguration
        {
            SearchEndpoint = new Uri(TestConfiguration.AzureAISearch.Endpoint),
            Authentication = new OnYourDataApiKeyAuthenticationOptions(TestConfiguration.AzureAISearch.ApiKey),
            IndexName = TestConfiguration.AzureAISearch.IndexName
        }]
    };
};

After

var promptExecutionSettings = new AzureOpenAIPromptExecutionSettings
{
    AzureChatDataSource = new AzureSearchChatDataSource
    {
         Endpoint = new Uri(TestConfiguration.AzureAISearch.Endpoint),
         Authentication = DataSourceAuthentication.FromApiKey(TestConfiguration.AzureAISearch.ApiKey),
         IndexName = TestConfiguration.AzureAISearch.IndexName
    }
};

Tags: WithData, AzureOpenAIChatCompletionWithDataConfig, AzureOpenAIChatCompletionWithDataService

10. Breaking glass scenarios

Breaking glass scenarios are scenarios where you may need to update your code to use the new OpenAI Connector. Below are some of the breaking changes that you may need to be aware of.

10.1 KernelContent Metadata

Some of the keys in the content metadata dictionary have changed and removed.

Changed: Created -> CreatedAt
Changed: LogProbabilityInfo -> ContentTokenLogProbabilities
Changed: PromptFilterResults -> ContentFilterResultForPrompt
Changed: ContentFilterResultsForPrompt -> ContentFilterResultForResponse
Removed: FinishDetails
Removed: Index
Removed: Enhancements

10.2 Prompt Filter Results

The PromptFilterResults metadata type has changed from IReadOnlyList<ContentFilterResultsForPrompt> to ContentFilterResultForPrompt.

10.3 Content Filter Results

The ContentFilterResultsForPrompt type has changed from ContentFilterResultsForChoice to ContentFilterResultForResponse.

10.4 Finish Reason

The FinishReason metadata string value has changed from stop to Stop

10.5 Tool Calls

The ToolCalls metadata string value has changed from tool_calls to ToolCalls

10.6 LogProbs / Log Probability Info

The LogProbabilityInfo type has changed from ChatChoiceLogProbabilityInfo to IReadOnlyList<ChatTokenLogProbabilityInfo>.

10.7 Token Usage

The Token usage naming convention from OpenAI changed from Completion, Prompt tokens to Output and Input respectively. You will need to update your code to use the new naming.

The type also changed from CompletionsUsage to ChatTokenUsage.

Example of Token Usage Metadata Changes

Before
- var usage = FunctionResult.Metadata?["Usage"] as CompletionsUsage;
- var completionTokesn = usage?.CompletionTokens;
- var promptTokens = usage?.PromptTokens;

After
+ var usage = FunctionResult.Metadata?["Usage"] as ChatTokenUsage;
+ var promptTokens = usage?.InputTokens;
+ var completionTokens = completionTokens: usage?.OutputTokens;

10.8 OpenAIClient

The OpenAIClient type previously was a Azure specific namespace type but now it is an OpenAI SDK namespace type, you will need to update your code to use the new OpenAIClient type.

When using Azure, you will need to update your code to use the new AzureOpenAIClient type.

10.9 OpenAIClientOptions

The OpenAIClientOptions type previously was a Azure specific namespace type but now it is an OpenAI SDK namespace type, you will need to update your code to use the new AzureOpenAIClientOptions type if you are using the new AzureOpenAIClient with any of the specific options for the Azure client.

10.10 Pipeline Configuration

The new OpenAI SDK uses a different pipeline configuration, and has a dependency on System.ClientModel package. You will need to update your code to use the new HttpClientPipelineTransport transport configuration where before you were using HttpClientTransport from Azure.Core.Pipeline.

Example of Pipeline Configuration

var clientOptions = new OpenAIClientOptions
{
Before: From Azure.Core.Pipeline
-    Transport = new HttpClientTransport(httpClient),
-    RetryPolicy = new RetryPolicy(maxRetries: 0), // Disable Azure SDK retry policy if and only if a custom HttpClient is provided.
-    Retry = { NetworkTimeout = Timeout.InfiniteTimeSpan } // Disable Azure SDK default timeout
     

After: From OpenAI SDK -> System.ClientModel
+    Transport = new HttpClientPipelineTransport(httpClient),
+    RetryPolicy = new ClientRetryPolicy(maxRetries: 0); // Disable retry policy if and only if a custom HttpClient is provided.
+    NetworkTimeout = Timeout.InfiniteTimeSpan; // Disable default timeout
};

Share via