Compare LRO generated enumerator approach to branch with updated paging APIs

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,72 @@
+name: Bug report
+description: Report an issue or bug with this library
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is not an issue with the underlying OpenAI API
+      description: Issues with the underlying OpenAI API should be reported in our [Developer Community](https://community.openai.com/c/api/7)
+      options:
+        - label: This is an issue with the Python library
+          required: true
+  - type: checkboxes
+    id: non_azure
+    attributes:
+      label: Confirm this is not an issue with Azure OpenAI
+      description: Issues related to Azure OpenAI should be reported in the [Azure SDK repo](https://github.com/Azure/azure-sdk-for-net/issues)
+      options:
+        - label: This is not an issue with Azure OpenAI
+          required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is, and any additional context.
+      placeholder: Tell us what you see.
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Fetch a '...'
+        2. Update the '....'
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: code-snippets
+    attributes:
+      label: Code snippets
+      description: If applicable, add code snippets to help explain your problem.
+      render: C#
+    validations:
+      required: false
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: winOS
+    validations:
+      required: true
+  - type: input
+    id: language-version
+    attributes:
+      label: .NET version
+      placeholder: 
+    validations:
+      required: true
+  - type: input
+    id: lib-version
+    attributes:
+      label: Library version
+      placeholder: 
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: false
+contact_links:
+  - name: OpenAI support
+    url: https://help.openai.com/
+    about: |
+      Please only file issues here that you believe represent actual bugs or feature requests for the OpenAI .NET library.
+      If you're having general trouble with the OpenAI API, please visit our help center to get support.

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,36 @@
+name: Feature request
+description: Suggest an idea for this library
+labels: ['feature-request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is not a feature request for the underlying OpenAI API.
+      description: Feature requests for the underlying OpenAI API should be reported in our [Developer Community](https://community.openai.com/c/api/7)
+      options:
+        - label: This is not a feature request for the underlying OpenAI API
+          required: true
+  - type: checkboxes
+    id: non_azure
+    attributes:
+      label: Confirm this is not a feature request for Azure OpenAI.
+      description: Feature requests for Azure OpenAI should be reported reported in the [Azure SDK repo](https://github.com/Azure/azure-sdk-for-net/issues)
+      options:
+        - label: This is not a feature request for Azure OpenAI
+          required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Describe the feature or improvement you're requesting
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.

.github/workflows/live-test.yml

@@ -0,0 +1,42 @@
+# This workflow is triggered by the user and runs live tests on the codebase.
+name: Live Test
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - labeled
+
+jobs:
+  test:
+    name: Live Test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'live test')
+    environment: Live Testing
+    env:
+      version_suffix_args: ${{ format('/p:VersionSuffix="alpha.{0}"', github.run_number) }}
+    steps:
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.x'
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run live tests
+        run: dotnet test ./tests/OpenAI.Tests.csproj
+          --configuration Release
+          --filter="TestCategory!=Smoke&TestCategory!=Images&TestCategory!=Moderations&TestCategory!=Manual"
+          --logger "trx;LogFilePrefix=live"
+          --results-directory ${{github.workspace}}/artifacts/test-results
+          ${{ env.version_suffix_args}}
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: test-artifacts
+          path: ${{github.workspace}}/artifacts

.github/workflows/main.yml

@@ -1,4 +1,6 @@
-name: Build and Test
+# This worflow is triggered on push to main, pull request, or by manual invocation.
+# It builds and unit tests the codebase.
+name: Build and Unit Test
 
 on:
   workflow_dispatch:
@@ -10,51 +12,36 @@ on:
 
 jobs:
   build: # Test, pack and publish the Open AI nuget package as a build artifact 
+    name: Build
     runs-on: ubuntu-latest
     env:
-      version_suffix_args: ${{ format('--version-suffix="alpha.{0}"', github.run_number) }}
+      version_suffix_args: ${{ format('/p:VersionSuffix="alpha.{0}"', github.run_number) }}
     steps:
       - name: Setup .NET
-        uses: actions/setup-dotnet@v1
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 8.x
+          dotnet-version: '8.x'
 
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Build and Pack
+      - name: Build and pack
         run: dotnet pack
           --configuration Release
           --output "${{github.workspace}}/artifacts/packages"
-          ${{ env.version_suffix_args }}
+          ${{ env.version_suffix_args}}
 
-      - name: Test
+      - name: Run unit tests
         run: dotnet test
           --configuration Release
-          --filter="TestCategory~${{ github.event_name == 'pull_request' && 'Offline' || 'Online' }}|TestCategory~smoke"
-          --logger "trx;LogFileName=${{github.workspace}}/artifacts/test-results/full.trx"
-        env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          --filter="TestCategory=Smoke&TestCategory!=Manual"
+          --logger "trx;LogFilePrefix=smoke"
+          --results-directory ${{github.workspace}}/artifacts/test-results
+          ${{ env.version_suffix_args}}
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
         with:
           name: build-artifacts
           path: ${{github.workspace}}/artifacts
-
-      - name: NuGet Autenticate
-        if: github.event_name != 'pull_request'
-        run: dotnet nuget add source
-          "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
-          --name "github"
-          --username ${{ github.actor }}
-          --password ${{ secrets.GITHUB_TOKEN }}
-          --store-password-in-clear-text
-
-      - name: Publish
-        if: github.event_name != 'pull_request'
-        run: dotnet nuget push
-          ${{github.workspace}}/artifacts/packages/*.nupkg
-          --source "github"
-          --api-key ${{ secrets.GITHUB_TOKEN }}
-          --skip-duplicate

.github/workflows/release.yml

@@ -1,53 +1,105 @@
+# This workflow is triggered by new releases and on a daily schedule.
+# It builds, unit tests, live tests and published the Open AI nuget package.
+# For daily runs, the package is published to the GitHub package registry.
+# For releases, the package is published to the NuGet package registry.
 name: Release package
 
 on:
   release:
     types: [published]
+  schedule:
+    # run every day at 00:00
+    - cron: '0 0 * * *'
 
 jobs:
-  deploy:
+  build:
+    name: Build
     runs-on: ubuntu-latest
+    environment: Live Testing
+    env:
+      version_suffix_args: ${{ github.event_name == 'schedule' && format('/p:VersionSuffix="alpha.{0}"', github.run_number) || '' }}
     permissions:
       packages: write
       contents: write
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-dotnet@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '8.x' # SDK Version to use.
+          dotnet-version: '8.x'
+
+      - name: Checkout code
+        uses: actions/checkout@v2
 
       # Pack the client nuget package and include url back to the repository and release tag
       - name: Build and Pack
         run: dotnet pack
           --configuration Release
-          --output "${{github.workspace}}/artifacts/packages"
+          --output "${{ github.workspace }}/artifacts/packages"
           /p:PackageProjectUrl="${{ github.server_url }}/${{ github.repository }}/tree/${{ github.event.release.tag_name }}"
           /p:PackageReleaseNotes="${{ github.server_url }}/${{ github.repository }}/blob/${{ github.event.release.tag_name }}/CHANGELOG.md"
+          ${{ env.version_suffix_args }}
 
-      - name: Test
+      - name: Unit Test
         run: dotnet test
           --configuration Release
-          --filter="TestCategory~Online"
-          --logger "trx;LogFileName=${{github.workspace}}/artifacts/test-results/full.trx"
+          --filter="TestCategory=Smoke&TestCategory!=Manual"
+          --logger "trx;LogFileName=${{ github.workspace }}/artifacts/test-results/smoke.trx"
+          ${{ env.version_suffix_args }}
+
+      - name: Run Live Tests
+        run: dotnet test ./tests/OpenAI.Tests.csproj
+          --configuration Release
+          --filter="TestCategory!=Smoke&TestCategory!=Images&TestCategory!=Moderations&TestCategory!=Manual"
+          --logger "trx;LogFilePrefix=live"
+          --results-directory ${{ github.workspace }}/artifacts/test-results
+          ${{ env.version_suffix_args }}
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
-      # Append the nuget package to the github release that triggered this workflow
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: build-artifacts
+          path: ${{ github.workspace }}/artifacts
+
+  deploy:
+    name: Publish Package
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+
       - name: Upload release asset
+        if: github.event_name == 'release'
         run: gh release upload ${{ github.event.release.tag_name }}
-          ${{github.workspace}}/artifacts/packages/*.*nupkg
+          ${{ github.workspace }}/build-artifacts/packages/*.*nupkg
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Upload artifact
-        uses: actions/upload-artifact@v2
-        with:
-          name: build-artifacts
-          path: ${{github.workspace}}/artifacts
+      - name: NuGet authenticate
+        run: dotnet nuget add source
+          "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
+          --name "github"
+          --username ${{ github.actor }}
+          --password ${{ secrets.GITHUB_TOKEN }}
+          --store-password-in-clear-text
+
+      - name: Publish package to local feed
+        run: dotnet nuget push
+            ${{github.workspace}}/build-artifacts/packages/*.nupkg
+            --source "github"
+            --api-key ${{ secrets.GITHUB_TOKEN }}
+            --skip-duplicate
 
-      - name: Publish
+      - name: Publish package to nuget.org
+        if: github.event_name == 'release'
         run: dotnet nuget push
-          ${{github.workspace}}/artifacts/packages/*.nupkg
-          --source https://api.nuget.org/v3/index.json
-          --api-key ${{ secrets.NUGET_API_KEY }}
-          --skip-duplicate
+            ${{github.workspace}}/build-artifacts/packages/*.nupkg
+            --source https://api.nuget.org/v3/index.json
+            --api-key ${{ secrets.NUGET_API_KEY }}
+            --skip-duplicate

CHANGELOG.md

@@ -1,18 +1,26 @@
 # Release History
 
-## 2.0.0-beta.8 (Unreleased)
-
-### Features Added
+## 2.0.0-beta.8 (2024-07-31)
 
 ### Breaking Changes
 
+- Changed name of return types from methods returning streaming collections from `ResultCollection` to `CollectionResult`. ([7bdecfd](https://github.com/openai/openai-dotnet/commit/7bdecfd8d294be933c7779c7e5b6435ba8a8eab0))
+- Changed return types from methods returning paginated collections from `PageableCollection` to `PageCollection`. ([7bdecfd](https://github.com/openai/openai-dotnet/commit/7bdecfd8d294be933c7779c7e5b6435ba8a8eab0))
+- Users must now call `GetAllValues` on the collection of pages to enumerate collection items directly. Corresponding protocol methods return `IEnumerable<ClientResult>` where each collection item represents a single service response holding a page of values. ([7bdecfd](https://github.com/openai/openai-dotnet/commit/7bdecfd8d294be933c7779c7e5b6435ba8a8eab0))
+- Updated `VectorStoreFileCounts` and `VectorStoreFileAssociationError` types from `readonly struct` to `class`. ([58f93c8](https://github.com/openai/openai-dotnet/commit/58f93c8d5ea080adfee8b37ae3cc034ebb06c79f))
+
 ### Bugs Fixed
 
-- ([#49](https://github.com/openai/openai-dotnet/issues/49)) Fixed a bug with extensible enums implementing case-insensitive equality but case-sensitive hash codes. (commit_hash)
-- ([#57](https://github.com/openai/openai-dotnet/issues/57)) Fixed a bug with requests URIs with query string parameter potentially containing a malformed double question mark (`??`) on .NET Framework (net481). (commit_hash)
+- ([#49](https://github.com/openai/openai-dotnet/issues/49)) Fixed a bug with extensible enums implementing case-insensitive equality but case-sensitive hash codes. ([0c12500](https://github.com/openai/openai-dotnet/commit/0c125002ffd791594597ef837f4d10582bdff004))
+- ([#57](https://github.com/openai/openai-dotnet/issues/57)) Fixed a bug with requests URIs with query string parameter potentially containing a malformed double question mark (`??`) on .NET Framework (net481). ([0c12500](https://github.com/openai/openai-dotnet/commit/0c125002ffd791594597ef837f4d10582bdff004))
+- Added optional `CancellationToken` parameters to methods for `AssistantClient` and `VectorStore` client, consistent with past changes in [19a65a0](https://github.com/openai/openai-dotnet/commit/19a65a0a943fa3bef1ec8504708aaa526a1ee03a). ([d77539c](https://github.com/openai/openai-dotnet/commit/d77539ca04467c166f848953eb866012a265555c))
+- Fixed Assistants `FileSearchToolDefinition`'s `MaxResults` parameter to appropriately serialize and deserialize the value ([d77539c](https://github.com/openai/openai-dotnet/commit/d77539ca04467c166f848953eb866012a265555c))
+- Added missing `[EditorBrowsable(EditorBrowsableState.Never)]` attributes to `AssistantClient` protocol methods, which should improve discoverability of the strongly typed methods. ([d77539c](https://github.com/openai/openai-dotnet/commit/d77539ca04467c166f848953eb866012a265555c))
 
 ### Other Changes
 
+- Removed the usage of `init` and updated properties to use `set`. ([58f93c8](https://github.com/openai/openai-dotnet/commit/58f93c8d5ea080adfee8b37ae3cc034ebb06c79f))
+
 ## 2.0.0-beta.7 (2024-06-24)
 
 ### Bugs Fixed