|
| 1 | +# OpenAI Connector Migration Guide |
| 2 | + |
| 3 | +This manual prepares you for the migration of your OpenAI Connector to the new OpenAI Connector. The 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. |
| 4 | + |
| 5 | +## 1. Package Setup when Using Azure |
| 6 | + |
| 7 | +If you are working with Azure and or OpenAI public APIs, you will need to change the package from `Microsoft.SemanticKernel.Connectors.OpenAI` to `Microsoft.SemanticKernel.Connectors.AzureOpenAI`, |
| 8 | + |
| 9 | +> [!IMPORTANT] |
| 10 | +> 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. |
| 11 | +
|
| 12 | +```diff |
| 13 | +- // Before |
| 14 | +- using Microsoft.SemanticKernel.Connectors.OpenAI; |
| 15 | ++ After |
| 16 | ++ using Microsoft.SemanticKernel.Connectors.AzureOpenAI; |
| 17 | +``` |
| 18 | + |
| 19 | +### 1.1 AzureOpenAIClient |
| 20 | + |
| 21 | +When using Azure with OpenAI, before where you were using `OpenAIClient` you will need to update your code to use the new `AzureOpenAIClient` type. |
| 22 | + |
| 23 | +### 1.2 Services |
| 24 | + |
| 25 | +All services below now belong to the `Microsoft.SemanticKernel.Connectors.AzureOpenAI` namespace. |
| 26 | + |
| 27 | +- `AzureOpenAIAudioToTextService` |
| 28 | +- `AzureOpenAIChatCompletionService` |
| 29 | +- `AzureOpenAITextEmbeddingGenerationService` |
| 30 | +- `AzureOpenAITextToAudioService` |
| 31 | +- `AzureOpenAITextToImageService` |
| 32 | + |
| 33 | +## 2. Text Generation Deprecated |
| 34 | + |
| 35 | +The latest `OpenAI` SDK does not support text generation modality, when migrating to their underlying SDK we had to drop the support and removed `TextGeneration` specific services but the existing `ChatCompletion` ones still supports (implements `ITextGenerationService`). |
| 36 | + |
| 37 | +If you were using 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. |
| 38 | + |
| 39 | +> [!NOTE] |
| 40 | +> 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. |
| 41 | +
|
| 42 | +tags: |
| 43 | +`OpenAITextGenerationService`,`AzureOpenAITextGenerationService`, |
| 44 | +`AddOpenAITextGeneration`,`AddAzureOpenAITextGeneration` |
| 45 | + |
| 46 | +## 3. ChatCompletion Multiple Choices Deprecated |
| 47 | + |
| 48 | +The latest `OpenAI` SDK does not support multiple choices, when migrating to their underlying SDK we had to drop the support and removed `ResultsPerPrompt` also from the `OpenAIPromptExecutionSettings`. |
| 49 | + |
| 50 | +tags: `ResultsPerPrompt`,`results_per_prompt` |
| 51 | + |
| 52 | +## 4. OpenAI File Service Deprecation |
| 53 | + |
| 54 | +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. |
| 55 | + |
| 56 | +## 5. SemanticKernel MetaPackage |
| 57 | + |
| 58 | +To be retro compatible 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. |
| 59 | + |
| 60 | +## 6. Contents |
| 61 | + |
| 62 | +### 6.1 OpenAIChatMessageContent |
| 63 | + |
| 64 | +- The `Tools` property type has changed from `IReadOnlyList<ChatCompletionsToolCall>` to `IReadOnlyList<ChatToolCall>`. |
| 65 | + |
| 66 | +- Inner content type has changed from `ChatCompletionsFunctionToolCall` to `ChatToolCall`. |
| 67 | + |
| 68 | +- Metadata type `FunctionToolCalls` has changed from `IEnumerable<ChatCompletionsFunctionToolCall>` to `IEnumerable<ChatToolCall>`. |
| 69 | + |
| 70 | +### 6.2 OpenAIStreamingChatMessageContent |
| 71 | + |
| 72 | +- The `FinishReason` property type has changed from `CompletionsFinishReason` to `FinishReason`. |
| 73 | +- The `ToolCallUpdate` property has been renamed to `ToolCallUpdates` and its type has changed from `StreamingToolCallUpdate?` to `IReadOnlyList<StreamingToolCallUpdate>?`. |
| 74 | +- The `AuthorName` property is not initialized because it's not provided by the underlying library anymore. |
| 75 | + |
| 76 | +## 6.3 Metrics for AzureOpenAI Connector |
| 77 | + |
| 78 | +The meter `s_meter = new("Microsoft.SemanticKernel.Connectors.OpenAI");` and the relevant counters still have old names that contain "openai" in them, such as: |
| 79 | + |
| 80 | +- `semantic_kernel.connectors.openai.tokens.prompt` |
| 81 | +- `semantic_kernel.connectors.openai.tokens.completion` |
| 82 | +- `semantic_kernel.connectors.openai.tokens.total` |
| 83 | + |
| 84 | +## 7. Using Azure with your data (Data Sources) |
| 85 | + |
| 86 | +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. |
| 87 | + |
| 88 | +Before |
| 89 | + |
| 90 | +```csharp |
| 91 | +var promptExecutionSettings = new OpenAIPromptExecutionSettings |
| 92 | +{ |
| 93 | + AzureChatExtensionsOptions = new AzureChatExtensionsOptions |
| 94 | + { |
| 95 | + Extensions = [ new AzureSearchChatExtensionConfiguration |
| 96 | + { |
| 97 | + SearchEndpoint = new Uri(TestConfiguration.AzureAISearch.Endpoint), |
| 98 | + Authentication = new OnYourDataApiKeyAuthenticationOptions(TestConfiguration.AzureAISearch.ApiKey), |
| 99 | + IndexName = TestConfiguration.AzureAISearch.IndexName |
| 100 | + }] |
| 101 | + }; |
| 102 | +}; |
| 103 | +``` |
| 104 | + |
| 105 | +After |
| 106 | + |
| 107 | +```csharp |
| 108 | +var promptExecutionSettings = new AzureOpenAIPromptExecutionSettings |
| 109 | +{ |
| 110 | + AzureChatDataSource = new AzureSearchChatDataSource |
| 111 | + { |
| 112 | + Endpoint = new Uri(TestConfiguration.AzureAISearch.Endpoint), |
| 113 | + Authentication = DataSourceAuthentication.FromApiKey(TestConfiguration.AzureAISearch.ApiKey), |
| 114 | + IndexName = TestConfiguration.AzureAISearch.IndexName |
| 115 | + } |
| 116 | +}; |
| 117 | +``` |
| 118 | + |
| 119 | +## 8. Breaking glass scenarios |
| 120 | + |
| 121 | +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. |
| 122 | + |
| 123 | +#### 8.1 KernelContent Metadata |
| 124 | + |
| 125 | +Some of the keys in the content metadata dictionary have changed, you will need to update your code to when using the previous key names. |
| 126 | + |
| 127 | +- `Created` -> `CreatedAt` |
| 128 | + |
| 129 | +#### 8.2 Prompt Filter Results |
| 130 | + |
| 131 | +The `PromptFilterResults` metadata type has changed from `IReadOnlyList<ContentFilterResultsForPrompt>` to `ContentFilterResultForPrompt`. |
| 132 | + |
| 133 | +#### 8.3 Content Filter Results |
| 134 | + |
| 135 | +The `ContentFilterResultsForPrompt` type has changed from `ContentFilterResultsForChoice` to `ContentFilterResultForResponse`. |
| 136 | + |
| 137 | +#### 8.4 Finish Reason |
| 138 | + |
| 139 | +The FinishReason metadata string value has changed from `stop` to `Stop` |
| 140 | + |
| 141 | +#### 8.5 Tool Calls |
| 142 | + |
| 143 | +The ToolCalls metadata string value has changed from `tool_calls` to `ToolCalls` |
| 144 | + |
| 145 | +#### 8.6 LogProbs / Log Probability Info |
| 146 | + |
| 147 | +The `LogProbabilityInfo` type has changed from `ChatChoiceLogProbabilityInfo` to `IReadOnlyList<ChatTokenLogProbabilityInfo>`. |
| 148 | + |
| 149 | +#### 8.7 Finish Details, Index, and Enhancements |
| 150 | + |
| 151 | +All of above have been removed. |
| 152 | + |
| 153 | +#### 8.8 Token Usage |
| 154 | + |
| 155 | +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. |
| 156 | + |
| 157 | +The type also changed from `CompletionsUsage` to `ChatTokenUsage`. |
| 158 | + |
| 159 | +[Example of Token Usage Metadata Changes](https://github.com/microsoft/semantic-kernel/pull/7151/files#diff-a323107b9f8dc8559a83e50080c6e34551ddf6d9d770197a473f249589e8fb47) |
| 160 | + |
| 161 | +```diff |
| 162 | +- Before |
| 163 | +- var usage = FunctionResult.Metadata?["Usage"] as CompletionsUsage; |
| 164 | +- var completionTokesn = usage?.CompletionTokens ?? 0; |
| 165 | +- var promptTokens = usage?.PromptTokens ?? 0; |
| 166 | + |
| 167 | ++ After |
| 168 | ++ var usage = FunctionResult.Metadata?["Usage"] as ChatTokenUsage; |
| 169 | ++ var promptTokens = usage?.InputTokens ?? 0; |
| 170 | ++ var completionTokens = completionTokens: usage?.OutputTokens ?? 0; |
| 171 | + |
| 172 | +totalTokens: usage?.TotalTokens ?? 0; |
| 173 | +``` |
| 174 | + |
| 175 | +#### 8.9 OpenAIClient |
| 176 | + |
| 177 | +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. |
| 178 | + |
| 179 | +When using Azure, you will need to update your code to use the new `AzureOpenAIClient` type. |
| 180 | + |
| 181 | +#### 8.10 Pipeline Configuration |
| 182 | + |
| 183 | +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`. |
| 184 | + |
| 185 | +[Example of Pipeline Configuration](https://github.com/microsoft/semantic-kernel/pull/7151/files#diff-fab02d9a75bf43cb57f71dddc920c3f72882acf83fb125d8cad963a643d26eb3) |
| 186 | + |
| 187 | +```diff |
| 188 | +var clientOptions = new OpenAIClientOptions |
| 189 | +{ |
| 190 | +- // Before: From Azure.Core.Pipeline |
| 191 | +- Transport = new HttpClientTransport(httpClient), |
| 192 | + |
| 193 | ++ // After: From OpenAI SDK -> System.ClientModel |
| 194 | ++ Transport = new HttpClientPipelineTransport(httpClient), |
| 195 | +}; |
| 196 | +``` |
0 commit comments