Update to M.E.AI 9.3.0-preview.1.25161.3

[stephentoub]

Summary by CodeRabbit

• Refactor

  • Streamlined chat response handling to return a consolidated text output for clearer and more consistent results.
  • Enhanced flexibility by allowing a broader range of messaging inputs.
  • Simplified processing of content parts for improved consistency of displayed output.

• Chores

  • Upgraded a core AI-related dependency to a newer preview release, supporting better performance and stability.

[coderabbitai]

Walkthrough

This PR refactors several methods in the Generative AI library. In the extension methods, the condition for creating a part from data content is simplified, the chat update response no longer includes a choices property, and function extraction now uses messages instead of choices. The chat client methods have been updated to accept any enumerable collection of messages. Additionally, the package reference for Microsoft.Extensions.AI has been updated. Corresponding tests have been modified to retrieve the response text directly and some assertions were removed.

Changes

File(s)	Change Summary
src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs	Updated ToPart (simplified data condition, removed null check modifier), ToChatResponseUpdate (removed Choices property), and GetFunction (switched from response.Choices to response.Messages).
src/GenerativeAI.Microsoft/GenerativeAI.Microsoft.csproj	Upgraded Microsoft.Extensions.AI package from version 9.3.0-preview.1.25114.11 to 9.3.0-preview.1.25161.3.
src/GenerativeAI.Microsoft/GenerativeAIChatClient.cs	Changed method signatures for GetResponseAsync and GetStreamingResponseAsync to accept IEnumerable<ChatMessage> instead of IList<ChatMessage>, with corresponding internal updates.
tests/...	Modified tests to use response.Text directly (instead of response.Choices.LastOrDefault().Text) and removed certain assertions (e.g., on ChoiceIndex and data presence in parts).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as ChatClient
    participant S as AI Service
    U->>C: Call GetResponseAsync(IEnumerable messages)
    C->>S: Send chat request (converted from messages)
    S-->>C: Return ChatResponse (with Text)
    C-->>U: Return ChatResponse (Text property)

Loading

Possibly related PRs

• Update Microsoft.Extensions.AI to 9.3.0-preview.1.25114.11 #18: Modifications related to the GetResponseAsync method signature and response structure, aligning with changes in message handling.

Poem

I hop through lines of refactored code,
Where parts are born and messages flowed.
No more choices hiding deep inside,
Just clear text gleaming far and wide.
With each new change, my joy is fed –
A happy bunny bounds ahead! 🐇

---

📜 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 704bdff and 52adec0.

📒 Files selected for processing (7)

• src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs (2 hunks)
• src/GenerativeAI.Microsoft/GenerativeAI.Microsoft.csproj (1 hunks)
• src/GenerativeAI.Microsoft/GenerativeAIChatClient.cs (2 hunks)
• tests/AotTest/MEAITests.cs (2 hunks)
• tests/GenerativeAI.Microsoft.Tests/MicrosoftExtension_Tests.cs (0 hunks)
• tests/GenerativeAI.Microsoft.Tests/Microsoft_AIFunction_Tests.cs (3 hunks)
• tests/GenerativeAI.Microsoft.Tests/Microsoft_ChatClient_Tests.cs (1 hunks)

💤 Files with no reviewable changes (1)

• tests/GenerativeAI.Microsoft.Tests/MicrosoftExtension_Tests.cs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build (9.0.x)

🔇 Additional comments (12)

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

30-30: Package reference updated successfully.

The package reference for Microsoft.Extensions.AI has been updated from the previous version to 9.3.0-preview.1.25161.3, which aligns with the PR title. This update appears to be the main purpose of this PR.

tests/GenerativeAI.Microsoft.Tests/Microsoft_ChatClient_Tests.cs (1)

122-123: Test updated to match new API response structure.

The test assertions have been updated to check result.Text directly instead of accessing it through result.Choices[0].Text. This change aligns with the updated M.E.AI library where the chat response no longer includes a choices property.

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

40-41: Test updated to check response.Text directly.

The assertion has been modified to check response.Text directly instead of going through the now-removed Choices collection, matching the updated API structure.

---

56-58: Test assertions updated for new response structure.

Both the assertion and console output have been updated to use response.Text directly, aligning with the updated M.E.AI package response format.

---

77-77: Updated assertion to use direct Text property.

Changed from checking the text through Choices collection to directly using the Text property, consistent with other test updates and the new API structure.

tests/AotTest/MEAITests.cs (2)

24-25: Tests updated to use direct Text property.

Both the console output and assertion have been updated to use response.Text directly, consistent with the changes in the Microsoft.Extensions.AI package that no longer uses a Choices collection.

---

43-43: Updated assertion to use direct Text property.

Changed from checking the text through Choices collection to directly using the Text property, maintaining consistency with the updated API response structure.

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

44-49: Method parameter type broadened to accept any enumerable of messages.

The change from IList<ChatMessage> to IEnumerable<ChatMessage> improves API flexibility by allowing any enumerable collection of messages to be passed to the method. This is a good change as it follows the principle of programming to interfaces and accepting the most general type possible.

---

99-105: Method parameter type broadened for consistency with GetResponseAsync.

Similar to the GetResponseAsync method, the parameter type has been changed from IList<ChatMessage> to IEnumerable<ChatMessage>. This makes the API more flexible and maintains consistency between both methods.

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

88-94: Simplification of DataContent handling and null-safety improvement.

The code has been simplified by removing the condition check for image.Data != null. The removal of the null-forgiving operator (!) in favor of directly calling ToArray() suggests improved null-safety or the expectation that image.Data is guaranteed to be non-null in this context.

---

254-271: Removed Choices property from ChatResponseUpdate.

The ToChatResponseUpdate method has been modified to no longer include a Choices property in the returned object. This aligns with the AI-generated summary that mentions "the chat update response no longer includes a choices property." This change might require adjustments in any code that accesses this property.

---

463-463: Updated function extraction logic to use Messages instead of Choices.

The GetFunction method now extracts the FunctionCallContent from the response.Messages collection instead of response.Choices. This change is in line with the AI-generated summary that mentions "function extraction now uses messages instead of choices."

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @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.