Merge branch 'openai:main' into addtestframework

Author: m-redding

.github/workflows/live-test.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Run live tests
         run: dotnet test ./tests/OpenAI.Tests.csproj
           --configuration Release
-          --filter="TestCategory!=Smoke&TestCategory!=Assistants&TestCategory!=Images&TestCategory!=Uploads&TestCategory!=Moderations&TestCategory!=FineTuning&TestCategory!=Conversation&TestCategory!=Manual"
+          --filter="TestCategory!=Smoke&TestCategory!=Assistants&TestCategory!=StoredChat&TestCategory!=Images&TestCategory!=Uploads&TestCategory!=Moderations&TestCategory!=FineTuning&TestCategory!=Conversation&TestCategory!=Manual"
           --logger "trx;LogFilePrefix=live"
           --results-directory ${{github.workspace}}/artifacts/test-results
           ${{ env.version_suffix_args}}

.github/workflows/release.yml

@@ -55,7 +55,7 @@ jobs:
       - name: Run Live Tests
         run: dotnet test ./tests/OpenAI.Tests.csproj
           --configuration Release
-          --filter="TestCategory!=Smoke&TestCategory!=Assistants&TestCategory!=Images&TestCategory!=Uploads&TestCategory!=Moderations&TestCategory!=FineTuning&TestCategory!=Conversation&TestCategory!=Manual"
+          --filter="TestCategory!=Smoke&TestCategory!=Assistants&TestCategory!=StoredChat&TestCategory!=Images&TestCategory!=Uploads&TestCategory!=Moderations&TestCategory!=FineTuning&TestCategory!=Conversation&TestCategory!=Manual"
           --logger "trx;LogFilePrefix=live"
           --results-directory ${{ github.workspace }}/artifacts/test-results
           ${{ env.version_suffix_args }}
@@ -69,16 +69,67 @@ jobs:
           name: build-artifacts
           path: ${{ github.workspace }}/artifacts
 
+  sign:
+    needs: build
+    runs-on: windows-latest # Code signing must run on a Windows agent for Authenticode signing (dll/exe)
+    environment: release # Needed for OIDC subject for releases triggered on release being created.
+    permissions:
+      id-token: write # Required for requesting the JWT
+      
+    steps:
+    - name: Download build artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: build-artifacts
+        path: ${{ github.workspace }}/build-artifacts
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: '9.x'
+  
+    - name: Install Sign CLI tool
+      run: dotnet tool install --tool-path . --prerelease sign
+    
+    - name: 'Az CLI login'
+      uses: azure/login@v2
+      with:
+        client-id: 80125de0-6f58-4f16-bd05-b2fa621d36a5
+        tenant-id: 16076fdc-fcc1-4a15-b1ca-32c9a255900e
+        allow-no-subscriptions: true
+
+    - name: Sign artifacts
+      shell: pwsh
+      run: >
+        ./sign code azure-key-vault
+        **/*.nupkg
+        --base-directory "${{ github.workspace }}/build-artifacts/packages"
+        --publisher-name "OpenAI"
+        --description "OpenAI library for .NET"
+        --description-url "https://github.com/openai/openai-dotnet"
+        --azure-credential-type "azure-cli"
+        --azure-key-vault-url "https://sc-openaisdk.vault.azure.net/"
+        --azure-key-vault-certificate "OpenAISDKSCCert"
+    
+    - name: Upload signed artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: build-artifacts-signed
+        path: ${{ github.workspace }}/build-artifacts
+        
   deploy:
     name: Publish Package
-    needs: build
+    needs: sign
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
 
       - name: Download build artifacts
         uses: actions/download-artifact@v4
+        with:
+          name: build-artifacts-signed
+          path: ${{ github.workspace }}/build-artifacts
 
       - name: Upload release asset
         if: github.event_name == 'release'
@@ -92,6 +143,13 @@ jobs:
         run: |
           gh release edit "${{ github.event.release.tag_name }}" \
             --notes "See full changelog: ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.event.release.tag_name }}/CHANGELOG.md"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '9.x'
 
       - name: NuGet authenticate
         run: dotnet nuget add source
@@ -114,4 +172,4 @@ jobs:
             ${{ github.workspace }}/build-artifacts/packages/*.nupkg
             --source https://api.nuget.org/v3/index.json
             --api-key ${{ secrets.NUGET_API_KEY }}
-            --skip-duplicate
+            --skip-duplicate

.github/workflows/update-generator.yml

@@ -0,0 +1,75 @@
+name: Update TypeSpec Generator Version
+
+on:
+  schedule:
+    # Run weekly on Mondays at 9 AM UTC
+    - cron: '0 9 * * 1'
+  workflow_dispatch:
+    # Allow manual triggering
+  repository_dispatch:
+    # Allow triggering from TypeSpec repository on new releases
+    types: [typespec-release]
+
+jobs:
+  update-generator:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.x'
+          
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.x
+          
+      - name: Check for generator updates
+        id: check-updates
+        run: |
+          # Get current version from the OpenAI package.json file
+          CURRENT_VERSION=$(node -p "require('./codegen/package.json').dependencies['@typespec/http-client-csharp']" 2>/dev/null || echo "unknown")
+          
+          echo "Current OpenAI version: $CURRENT_VERSION"
+          
+          # Get latest version from npm registry
+          LATEST_VERSION=$(npm view @typespec/http-client-csharp version 2>/dev/null || echo "unknown")
+          echo "Latest version from npm: $LATEST_VERSION"
+          
+          # Validate we got valid versions
+          if [ "$CURRENT_VERSION" = "unknown" ] || [ "$LATEST_VERSION" = "unknown" ]; then
+            echo "Error: Failed to get version information"
+            echo "Current: $CURRENT_VERSION, Latest: $LATEST_VERSION"
+            exit 1
+          fi
+          
+          # Compare versions (simple string comparison for alpha versions)
+          if [ "$CURRENT_VERSION" != "$LATEST_VERSION" ]; then
+            echo "Update needed: $CURRENT_VERSION -> $LATEST_VERSION"
+            echo "needs-update=true" >> $GITHUB_OUTPUT
+            echo "current-version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+            echo "latest-version=$LATEST_VERSION" >> $GITHUB_OUTPUT
+          else
+            echo "No update needed - already at latest version: $CURRENT_VERSION"
+            echo "needs-update=false" >> $GITHUB_OUTPUT
+          fi
+          
+      - name: Update generator version and create PR
+        if: steps.check-updates.outputs.needs-update == 'true'
+        run: |
+          LATEST_VERSION="${{ steps.check-updates.outputs.latest-version }}"
+          
+          # Use the PowerShell script to handle the entire update process (following TypeSpec pattern)
+          pwsh ./scripts/Submit-GeneratorUpdatePr.ps1 \
+            -PackageVersion "$LATEST_VERSION" \
+            -AuthToken "${{ secrets.GITHUB_TOKEN }}" \
+            -RepoPath "."

.gitignore

@@ -178,12 +178,11 @@ artifacts
 # Temporary typespec folders for typespec generation
 TempTypeSpecFiles/
 
-# Artifacts from the generator
-tspCodeModel.json
-Configuration.json
-
-# Base specification files
-specification/base/
+# Azure specification files
+specification/base/entrypoints/azure.v1
+specification/base/entrypoints/sdk.dotnet.azure
+specification/base/typespec.azure
+specification/base/typespec.azure.v1
 
 # Generator default TypeSpec output
 codegen/tsp-output/

CHANGELOG.md

@@ -1,12 +1,80 @@
 # Release History
 
-## 2.3.0-beta.1 (Unreleased)
+## 2.3.0 (2025-08-01)
 
-### Other changes
+### Features Added
 
-- Updated to `System.ClientModel` 1.5.1, which contains a fix for a concurrency bug which could cause some applications running on the legacy .NET Framework to experience an infinite loop while deserializing service responses. 
+- OpenAI.Audio:
+  - Added the `Model` property to `AudioClient`.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `AudioClient`.
+- OpenAI.Batch:
+  - Added new methods to `BatchClient`:
+    - `GetBatch` and `GetBatchAsync`
+  - Added constructors that can take a custom `AuthenticationPolicy` to `BatchClient`.
+- OpenAI.Chat:
+  - Added new methods to `ChatClient`:
+    - `UpdateChatCompletion` and `UpdateChatCompletionAsync`
+    - `GetChatCompletions` and `GetChatCompletionsAsync`
+    - `GetChatCompletionMessages` and `GetChatCompletionMessagesAsync`
+  - Added the `Model` property to `ChatClient`.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `ChatClient`.
+- OpenAI.Containers:
+  - Introduced the new `ContainersClient` to support the Containers API with protocol methods for the following operations:
+    - `CreateContainer` and `CreateContainerAsync`
+    - `GetContainers` and `GetContainersAsync`
+    - `GetContainer` and `GetContainerAsync`
+    - `DeleteContainer` and `DeleteContainerAsync`
+    - `CreateContainerFile` and `CreateContainerFileAsync`
+    - `GetContainerFiles` and `GetContainerFilesAsync`
+    - `GetContainerFile` and `GetContainerFileAsync`
+    - `GetContainerFileContent` and `GetContainerFileContentAsync`
+    - `DeleteContainerFile` and `DeleteContainerFileAsync`
+- OpenAI.Embeddings:
+  - Added the `Model` property to `EmbeddingClient`.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `EmbeddingClient`.
+- OpenAI.Evals:
+  - Added constructors that can take a custom `AuthenticationPolicy` to `EvaluationClient`.
+- OpenAI.Files:
+  - Added constructors that can take a custom `AuthenticationPolicy` to `OpenAIFileClient`.
+- OpenAI.FineTuning:
+  - Added constructors that can take a custom `AuthenticationPolicy` to `FineTuningClient`.
+- OpenAI.Graders:
+  - Introduced the new `GraderClient` to support the Graders API with protocol methods for the following operations:
+    - `RunGrader` and `RunGraderAsync`
+    - `ValidateGrader` and `ValidateGraderAsync`
+- OpenAI.Images:
+  - Added the `Model` property to `ImageClient`.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `ImageClient`.
+- OpenAI.Models:
+  - Added constructors that can take a custom `AuthenticationPolicy` to `OpenAIModelClient`.
+- OpenAI.Moderations:
+  - Added the `Model` property to `ModerationClient`.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `ModerationClient`.
+- OpenAI.Realtime:
+  - Enabled support for semantic voice activity detection (VAD) via the new `CreateSemanticVoiceActivityTurnDetectionOptions` method of `TurnDetectionOptions`.
+- OpenAI.Responses:
+  - Added a model factory.
+  - Added constructors that can take a custom `AuthenticationPolicy` to `OpenAIResponseClient`.
+- OpenAI.VectorStores:
+  - Added constructors that can take a custom `AuthenticationPolicy` to `VectorStoreClient`.
+
+### Bug Fixed
+
+- OpenAI.Assistants:
+  - Fixed an issue causing the `ImageDetail` property of `MessageContent` to not be serialized correctly.
+- OpenAI.Audio:
+  - Added a check to all overloads of `TranscribeAudioStreaming` and `TranscribeAudioStreamingAsync` in the `AudioClient` to prevent using the `whisper-1` model, which does not support streaming and simply ignores the `stream` parameter.
+- OpenAI.Realtime:
+  - Improved the disposal logic in `AsyncWebsocketMessageResultEnumerator` to prevent multiple disposals.
+- OpenAI.Responses:
+  - Fixed an issue in code generation that caused the `StreamingResponseTextAnnotationAddedUpdate` class to not be generated correctly as part of the set of possible handles when streaming.
+  - Fixed an issue in code generation that caused the `Status` property of `ReasoningResponseItem` and the `ReasoningStatus` enum to not be generated correctly and lead to incorrect behavior.
+
+### Other Changes
 
-- Removed explicit `net6.0` target framework, as this version reached end-of-life in November, 2024 and is no longer maintained nor supported by Microsoft.  This does not prevent using the OpenAI library on .NET 6, as the runtime will fallback to the `netstandard2.0` target.
+- The `OpenAI` NuGet package now contains signed binaries.
+- Updated the `System.ClientModel` dependency to version 1.5.1, which contains a fix for a concurrency bug which could cause some applications running on the legacy .NET Framework to experience an infinite loop while deserializing service responses.
+- Removed the explicit `net6.0` target framework, as this version reached end-of-life in November 2024 and is no longer maintained nor supported by Microsoft. This does not prevent using the OpenAI library on .NET 6, as the runtime will fallback to the `netstandard2.0` target.
 
 ## 2.2.0 (2025-07-02)
 
@@ -283,7 +351,7 @@
 ### Features Added
 
 - Added a new `RealtimeConversationClient` in a corresponding scenario namespace. ([ff75da4](https://github.com/openai/openai-dotnet/commit/ff75da4167bc83fa85eb69ac142cab88a963ed06))
-  - This maps to the new `/realtime` beta endpoint and is thus marked with a new `[Experimental("OPENAI002")]` diagnostic tag. 
+  - This maps to the new `/realtime` beta endpoint and is thus marked with a new `[Experimental("OPENAI002")]` diagnostic tag.
   - This is a very early version of the convenience surface and thus subject to significant change
   - Documentation and samples will arrive soon; in the interim, see [the scenario test files](/tests/RealtimeConversation) for basic usage
   - You can also find an external sample employing this client, together with Azure OpenAI support, at https://github.com/Azure-Samples/aoai-realtime-audio-sdk/tree/main/dotnet/samples/console
@@ -441,7 +509,7 @@
 ### Breaking Changes
 
 - Renamed `AudioClient`'s `GenerateSpeechFromText` methods to simply `GenerateSpeech`. ([d84bf54](https://github.com/openai/openai-dotnet/commit/d84bf54df14ddac4c49f6efd61467b600d34ecd7))
-- Changed the type of `OpenAIFileInfo`'s `SizeInBytes` property from `long?` to `int?`. ([d84bf54](https://github.com/openai/openai-dotnet/commit/d84bf54df14ddac4c49f6efd61467b600d34ecd7)) 
+- Changed the type of `OpenAIFileInfo`'s `SizeInBytes` property from `long?` to `int?`. ([d84bf54](https://github.com/openai/openai-dotnet/commit/d84bf54df14ddac4c49f6efd61467b600d34ecd7))
 
 ### Bugs Fixed
 

Configuration.json

@@ -0,0 +1,5 @@
+{
+  "package-name": "OpenAI",
+  "unreferenced-types-handling": "keepAll",
+  "disable-xml-docs": true
+}

README.md

@@ -151,8 +151,9 @@ Register the `ChatClient` as a singleton in your `Program.cs`:
 builder.Services.AddSingleton<ChatClient>(serviceProvider =>
 {
     var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
+    var model = "gpt-4o";
 
-    return new ChatClient(apiKey);
+    return new ChatClient(model, apiKey);
 });
 ```
 
@@ -518,14 +519,19 @@ await foreach (StreamingResponseUpdate update
             },
         }))
 {
-    if (update is StreamingResponseItemUpdate itemUpdate
+    if (update is StreamingResponseOutputItemAddedUpdate itemUpdate
         && itemUpdate.Item is ReasoningResponseItem reasoningItem)
     {
         Console.WriteLine($"[Reasoning] ({reasoningItem.Status})");
     }
-    else if (update is StreamingResponseContentPartDeltaUpdate deltaUpdate)
+    else if (update is StreamingResponseOutputItemAddedUpdate itemDone
+        && itemDone.Item is ReasoningResponseItem reasoningDone)
     {
-        Console.Write(deltaUpdate.Text);
+        Console.WriteLine($"[Reasoning DONE] ({reasoningDone.Status})");
+    }
+    else if (update is StreamingResponseOutputTextDeltaUpdate delta)
+    {
+        Console.Write(delta.Delta);
     }
 }
 ```
@@ -1095,4 +1101,4 @@ By default, the client classes will automatically retry the following errors up
 
 ### Observability
 
-OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.
+OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.