Update Azure API version to 2024-05-01-preview

Updated the Azure OpenAI API version across configuration files and documentation from `2024-04-01-preview` to `2024-05-01-preview`. This includes changes in `README.md`, `appsettings.json`, and `AzureChatGptServiceConfiguration.cs`, ensuring the application defaults to the newer API version. The update reflects the adoption of new features or improvements available in the latest API preview version.
marcominerva · Jun 26, 2024 · cab6101 · cab6101
1 parent 2e5b38c
commit cab6101
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,8 @@ builder.Services.AddChatGpt(options =>
   - 2023-10-01-preview
   - 2024-02-15-preview
   - 2024-03-01-preview
-  - 2024-04-01-preview (default)
+  - 2024-04-01-preview
+  - 2024-05-01-preview (default)
   - 2024-02-01
 - _AuthenticationType_: it specifies if the key is an actual API Key or an [Azure Active Directory token](https://learn.microsoft.com/azure/cognitive-services/openai/how-to/managed-identity) (optional, default: "ApiKey").
 

diff --git a/samples/ChatGptApi/appsettings.json b/samples/ChatGptApi/appsettings.json
@@ -4,7 +4,7 @@
         "ApiKey": "", // Required
         //"Organization": "", // Optional, used only by OpenAI
         "ResourceName": "", // Required when using Azure OpenAI Service
-        "ApiVersion": "2024-04-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-04-01-preview)
+        "ApiVersion": "2024-05-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-05-01-preview)
         "AuthenticationType": "ApiKey", // Optional, used only by Azure OpenAI Service. Allowed values: ApiKey (default) or ActiveDirectory
 
         "DefaultModel": "my-model",

diff --git a/samples/ChatGptConsole/appsettings.json b/samples/ChatGptConsole/appsettings.json
@@ -4,7 +4,7 @@
         "ApiKey": "", // Required
         //"Organization": "", // Optional, used only by OpenAI
         "ResourceName": "", // Required when using Azure OpenAI Service
-        "ApiVersion": "2024-04-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-04-01-preview)
+        "ApiVersion": "2024-05-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-05-01-preview)
         "AuthenticationType": "ApiKey", // Optional, used only by Azure OpenAI Service. Allowed values: ApiKey (default) or ActiveDirectory
 
         "DefaultModel": "my-model",

diff --git a/samples/ChatGptFunctionCallingConsole/appsettings.json b/samples/ChatGptFunctionCallingConsole/appsettings.json
@@ -4,7 +4,7 @@
         "ApiKey": "", // Required
         //"Organization": "", // Optional, used only by OpenAI
         "ResourceName": "", // Required when using Azure OpenAI Service
-        "ApiVersion": "2024-04-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-04-01-preview)
+        "ApiVersion": "2024-05-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-05-01-preview)
         "AuthenticationType": "ApiKey", // Optional, used only by Azure OpenAI Service. Allowed values: ApiKey (default) or ActiveDirectory
 
         "DefaultModel": "my-model",

diff --git a/samples/ChatGptStreamConsole/appsettings.json b/samples/ChatGptStreamConsole/appsettings.json
@@ -4,7 +4,7 @@
         "ApiKey": "", // Required
         //"Organization": "", // Optional, used only by OpenAI
         "ResourceName": "", // Required when using Azure OpenAI Service
-        "ApiVersion": "2024-04-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-04-01-preview)
+        "ApiVersion": "2024-05-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-05-01-preview)
         "AuthenticationType": "ApiKey", // Optional, used only by Azure OpenAI Service. Allowed values: ApiKey (default) or ActiveDirectory
 
         "DefaultModel": "my-model",

diff --git a/src/ChatGptNet/ServiceConfigurations/AzureChatGptServiceConfiguration.cs b/src/ChatGptNet/ServiceConfigurations/AzureChatGptServiceConfiguration.cs
@@ -10,7 +10,7 @@ internal class AzureChatGptServiceConfiguration : ChatGptServiceConfiguration
     /// <summary>
     /// The default API version for Azure OpenAI service.
     /// </summary>
-    public const string DefaultApiVersion = "2024-04-01-preview";
+    public const string DefaultApiVersion = "2024-05-01-preview";
 
     /// <summary>
     /// Gets or sets the name of the Azure OpenAI Resource.
@@ -48,6 +48,10 @@ internal class AzureChatGptServiceConfiguration : ChatGptServiceConfiguration
     ///     <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json">Swagger spec</see></description>
     ///   </item>
     ///   <item>
+    ///     <term>2024-05-01-preview</term>
+    ///     <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json">Swagger spec</see></description>
+    ///   </item>
+    ///   <item>
     ///     <term>2023-02-01</term>
     ///     <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json">Swagger spec</see></description>
     ///   </item>