Update Azure OpenAI API versions (#151)

marcominerva · Mar 13, 2024 · e710dee · e710dee
2 parents 0148e11 + 992591f
commit e710dee
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -53,9 +53,12 @@ builder.Services.AddChatGpt(options =>
 - _ResourceName_: the name of your Azure OpenAI Resource (required).
 - _ApiKey_: Azure OpenAI provides two methods for authentication. You can use either API Keys or Azure Active Directory (required).
 - _ApiVersion_: the version of the API to use (optional). Allowed values:
+ - 2022-12-01
  - 2023-05-15
  - 2023-06-01-preview
- - 2024-02-15-preview (default)
+ - 2024-02-15-preview
+ - 2024-03-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").
 
 ### DefaultModel and DefaultEmbeddingModel

diff --git a/docs/ChatGptNet/ChatGptOptionsBuilderExtensions/UseAzure.md b/docs/ChatGptNet/ChatGptOptionsBuilderExtensions/UseAzure.md
@@ -4,7 +4,7 @@ Configures Azure OpenAI Service settings.
 
 ```csharp
 public static ChatGptOptionsBuilder UseAzure(this ChatGptOptionsBuilder builder, 
- string resourceName, string apiKey, string apiVersion = "2024-02-15-preview", 
+ string resourceName, string apiKey, string apiVersion = "2024-03-01-preview", 
  AzureAuthenticationType authenticationType = AzureAuthenticationType.ApiKey)
 ```
 

diff --git a/samples/ChatGptApi/ChatGptApi.csproj b/samples/ChatGptApi/ChatGptApi.csproj
@@ -7,8 +7,8 @@
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.2" />
- <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.2.0" />
+ <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.3" />
+ <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.3.0" />
  <PackageReference Include="Polly.Extensions" Version="8.3.1" />
  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
  <PackageReference Include="TinyHelpers.AspNetCore" Version="3.0.6" />

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-02-15-preview", // Optional, used only by Azure OpenAI Service (default: 2024-02-15-preview)
+ "ApiVersion": "2024-03-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-03-01-preview)
  "AuthenticationType": "ApiKey", // Optional, used only by Azure OpenAI Service. Allowed values: ApiKey (default) or ActiveDirectory
 
  "DefaultModel": "my-model",

diff --git a/samples/ChatGptBlazor.Wasm/ChatGptBlazor.Wasm.csproj b/samples/ChatGptBlazor.Wasm/ChatGptBlazor.Wasm.csproj
@@ -9,9 +9,9 @@
 
  <ItemGroup>
  <PackageReference Include="Markdig" Version="0.35.0" />
- <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.0.2" />
- <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="8.0.2" PrivateAssets="all" />
- <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.2.0" />
+ <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.0.3" />
+ <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="8.0.3" PrivateAssets="all" />
+ <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.3.0" />
  <PackageReference Include="Polly.Extensions" Version="8.3.1" />
  </ItemGroup>
 

diff --git a/samples/ChatGptConsole/ChatGptConsole.csproj b/samples/ChatGptConsole/ChatGptConsole.csproj
@@ -9,7 +9,7 @@
 
  <ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
- <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.2.0" />
+ <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.3.0" />
  <PackageReference Include="Polly.Extensions" Version="8.3.1" />
  </ItemGroup>
 

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-02-15-preview", // Optional, used only by Azure OpenAI Service (default: 2024-02-15-preview)
+ "ApiVersion": "2024-03-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-03-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/ChatGptFunctionCallingConsole.csproj b/samples/ChatGptFunctionCallingConsole/ChatGptFunctionCallingConsole.csproj
@@ -9,7 +9,7 @@
 
  <ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
- <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.2.0" />
+ <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.3.0" />
  <PackageReference Include="Polly.Extensions" Version="8.3.1" />
  </ItemGroup>
 

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-02-15-preview", // Optional, used only by Azure OpenAI Service (default: 2024-02-15-preview)
+ "ApiVersion": "2024-03-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-03-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/ChatGptStreamConsole.csproj b/samples/ChatGptStreamConsole/ChatGptStreamConsole.csproj
@@ -9,7 +9,7 @@
 
  <ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
- <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.2.0" />
+ <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.3.0" />
  <PackageReference Include="Polly.Extensions" Version="8.3.1" />
  </ItemGroup>
 

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-02-15-preview", // Optional, used only by Azure OpenAI Service (default: 2024-02-15-preview)
+ "ApiVersion": "2024-03-01-preview", // Optional, used only by Azure OpenAI Service (default: 2024-03-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/ChatGptNet.csproj b/src/ChatGptNet/ChatGptNet.csproj
@@ -42,7 +42,7 @@
  <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
  <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.0.0" />
  <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.1" />
- <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.0" />
+ <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
  <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
  </ItemGroup>
 

diff --git a/src/ChatGptNet/ServiceConfigurations/AzureChatGptServiceConfiguration.cs b/src/ChatGptNet/ServiceConfigurations/AzureChatGptServiceConfiguration.cs
@@ -10,19 +10,23 @@ internal class AzureChatGptServiceConfiguration : ChatGptServiceConfiguration
  /// <summary>
  /// The default API version for Azure OpenAI service.
  /// </summary>
- public const string DefaultApiVersion = "2024-02-15-preview";
+ public const string DefaultApiVersion = "2024-03-01-preview";
 
  /// <summary>
  /// Gets or sets the name of the Azure OpenAI Resource.
  /// </summary>
  public string? ResourceName { get; set; }
 
  /// <summary>
- /// Gets or sets the API version of the Azure OpenAI service (Default: 2024-02-15-preview).
+ /// Gets or sets the API version of the Azure OpenAI service (Default: 2024-03-01-preview).
  /// </summary>
  /// <remarks>
  /// Currently supported versions are:
- /// <list type = "bullet" >
+ /// <list type = "bullet">
+ /// <item>
+ /// <term>2022-12-01</term>
+ /// <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json">Swagger spec</see></description>
+ /// </item>
  /// <item>
  /// <term>2023-05-15</term>
  /// <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/inference.json">Swagger spec</see></description>
@@ -35,6 +39,14 @@ internal class AzureChatGptServiceConfiguration : ChatGptServiceConfiguration
  /// <term>2024-02-15-preview</term>
  /// <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-02-15-preview/inference.json">Swagger spec</see></description>
  /// </item>
+ /// <item>
+ /// <term>2024-03-01-preview</term>
+ /// <description><see href="https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-03-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>
  /// </list>
  /// </remarks>
  public string ApiVersion { get; set; } = DefaultApiVersion;