Update Microsoft.Extensions.AI to 9.3.0-preview.1.25114.11

[stephentoub]

Summary by CodeRabbit

• Refactor
  • Updated chat client methods with clearer names and improved response handling for a more intuitive user experience.
• Chores
  • Upgraded the underlying AI package to the latest preview version, enhancing overall performance and reliability.

[coderabbitai]

Walkthrough

This pull request updates the chat response handling system by changing method names, return types, and object properties. Methods in the extension and client classes now return updated response objects (e.g., ChatResponse and ChatResponseUpdate instead of their previous types) and have been renamed accordingly. Additionally, a package dependency has been upgraded in the project file. The test cases have been adjusted to match these modifications, including the update in property access and error handling with null inputs.

Changes

File(s)	Change Summary
src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs	Updated method return types: ToChatCompletion now returns ChatResponse and ToStreamingChatCompletionUpdate returns ChatResponseUpdate. Removed CompletionId property; added ResponseId (and Role for streaming updates).
src/GenerativeAI.Microsoft/GenerativeAI.Microsoft.csproj	Upgraded PackageReference for Microsoft.Extensions.AI from version 9.1.0-preview.1.25064.3 to 9.3.0-preview.1.25114.11.
src/GenerativeAI.Microsoft/GenerativeAIChatClient.cs	Renamed CompleteAsync to GetResponseAsync (returning ChatResponse) and CompleteStreamingAsync to GetStreamingResponseAsync (returning IAsyncEnumerable<ChatResponseUpdate>). Removed the Metadata property.
tests/GenerativeAI.Microsoft.Tests/GenerativeAIChatClient_Tests.cs	Modified test cases to reflect the method renaming and return type updates. Updated assertions for error handling (expecting ArgumentNullException on null inputs) and replaced direct metadata access with service retrieval via GetService<ChatClientMetadata>().

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant GC as GenerativeAIChatClient
    participant AM as AbstractionMapper
    participant CS as Chat Service

    U->>GC: GetResponseAsync(chatMessages)
    GC->>AM: ToChatCompletion(response)
    AM->>CS: Process Request
    CS-->>AM: ChatResponse
    AM-->>GC: ChatResponse
    GC-->>U: ChatResponse

Loading

sequenceDiagram
    participant U as User
    participant GC as GenerativeAIChatClient
    participant AM as AbstractionMapper
    participant CS as Chat Service

    U->>GC: GetStreamingResponseAsync(chatMessages)
    GC->>AM: ToStreamingChatCompletionUpdate(response)
    AM->>CS: Process Stream Request
    CS-->>AM: ChatResponseUpdate (stream)
    AM-->>GC: ChatResponseUpdate (stream)
    GC-->>U: Streamed ChatResponseUpdate

Loading

Poem

I'm a coding rabbit, hopping with delight,
New names and types gleam in the light.
Methods reborn with a fresh design,
Upgraded packages line by line.
In this code garden, changes bloom so bright! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d1cfac8 and cff3b28.

📒 Files selected for processing (4)

• src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs (2 hunks)
• src/GenerativeAI.Microsoft/GenerativeAI.Microsoft.csproj (1 hunks)
• src/GenerativeAI.Microsoft/GenerativeAIChatClient.cs (2 hunks)
• tests/GenerativeAI.Microsoft.Tests/GenerativeAIChatClient_Tests.cs (5 hunks)

🔇 Additional comments (8)

src/GenerativeAI.Microsoft/GenerativeAI.Microsoft.csproj (1)

29-29:

Details

❓ Verification inconclusive

Verify stability of preview version.

The package is being updated to a preview version which may contain breaking changes. Please ensure thorough testing before deploying to production.

---

🌐 Web query:

What are the breaking changes in Microsoft.Extensions.AI 9.3.0-preview.1.25114.11 compared to 9.1.0-preview.1.25064.3?

💡 Result:

The key breaking changes between Microsoft.Extensions.AI 9.3.0-preview and 9.1.x involve dependency updates and namespace shifts:

Dependency Updates

• Upgraded Azure.Core from v1.x → v1.40[3]
• Upgraded Azure.Identity from v1.x → v1.12[3]
• Updated Microsoft.SemanticKernel dependencies[3]

These dependency changes could impact applications relying on:

• Specific authentication flows from older Azure.Identity versions
• Serialization/deserialization behaviors tied to Azure.Core implementations
• Semantic Kernel integration points

Namespace Migrations
While major namespace changes occurred in earlier previews (like moving Azure OpenAI client types to Azure.AI.OpenAI namespace[1][2]), upgrading between these specific versions requires verifying compatibility with dependent SDKs due to their updated package references[3].

Developers should:
1️⃣ Review release notes for updated dependencies
2️⃣ Test authentication flows
3️⃣ Validate serialization/API interactions
4️⃣ Check Semantic Kernel integration compatibility[3]

---

Preview Package Stability Check

The package reference has been updated to Microsoft.Extensions.AI 9.3.0-preview.1.25114.11, which introduces several breaking changes compared to 9.1.0-preview.1.25064.3:

• Dependency Updates:

  • Azure.Core is upgraded from v1.x to v1.40
  • Azure.Identity is upgraded from v1.x to v1.12
  • Adjustments to Microsoft.SemanticKernel dependencies

• Namespace Migrations:

  • Although major namespace shifts occurred in earlier previews (e.g., types moving to the Azure.AI.OpenAI namespace), ensure that any integration points depending on these namespaces (or earlier versions) are verified for compatibility.

Please review the release notes, verify that authentication flows and API interactions (like serialization/deserialization) work as expected, and test any Semantic Kernel integrations thoroughly before deploying to production.

src/GenerativeAI.Microsoft/GenerativeAIChatClient.cs (2)

32-40: LGTM! Method rename and return type update.

The method has been correctly renamed from CompleteAsync to GetResponseAsync and its return type updated from ChatCompletion to ChatResponse to align with the new package version.

---

42-53: LGTM! Method rename and return type update.

The method has been correctly renamed from CompleteStreamingAsync to GetStreamingResponseAsync and its return type updated from StreamingChatCompletionUpdate to ChatResponseUpdate to align with the new package version.

src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs (2)

141-158: LGTM! Return type update.

The method's return type has been correctly updated from ChatCompletion to ChatResponse to align with the new package version. The property ResponseId has been added to replace CompletionId.

---

165-180: LGTM! Return type update and property addition.

The method's return type has been correctly updated from StreamingChatCompletionUpdate to ChatResponseUpdate. The addition of the Role property enhances the response information.

tests/GenerativeAI.Microsoft.Tests/GenerativeAIChatClient_Tests.cs (3)

96-96: LGTM! Test updates for GetResponseAsync.

Tests have been correctly updated to use the new method name GetResponseAsync instead of CompleteAsync.

Also applies to: 118-118

---

143-143: LGTM! Test updates for GetStreamingResponseAsync.

Tests have been correctly updated to use the new method name GetStreamingResponseAsync and return type ChatResponseUpdate.

Also applies to: 165-166

---

225-226: LGTM! Test updates for metadata access.

Tests have been correctly updated to use GetService<ChatClientMetadata>() instead of accessing the removed Metadata property.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.