Remove unsupported formats from schemas in IChatClient implementation

[stephentoub]

Summary by CodeRabbit

• Bug Fixes

  • Improved compatibility of function parameter schemas with Gemini by adjusting how unsupported "format" properties are handled in schema descriptions.

• New Features

  • Enhanced schema processing with automatic transformation and caching for better performance and reliability.

[coderabbitai]

Walkthrough

The update introduces a schema transformation cache to modify function parameter schemas when converting AIFunction instances to FunctionDeclaration objects. The transformation relocates unsupported "format" properties into the "description" field, except for "enum" or "date-time" formats, ensuring compatibility with Gemini restrictions. The cache and transformation logic are implemented as a new private static property.

Changes

Cohort / File(s)	Change Summary
Schema Transformation Logic src/GenerativeAI.Microsoft/Extensions/MicrosoftExtensions.cs	Adds a private static schema transformation cache, alters function parameter schema parsing to use the cache, and implements logic to move unsupported "format" properties into the "description" field, except for "enum" or "date-time".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Poem

A schema cache now hops in place,
Transforming fields with gentle grace.
Formats tucked where they belong,
Descriptions growing ever strong.
Gemini rules now satisfied—
In code, our schemas safely hide!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

618-621: Consider using a more structured format for the description field.

When appending format information to an existing description, consider using a more structured format instead of just a newline separator. This would make the format information more distinguishable.

-                schemaObj["description"] = schemaObj["description"] is { } descriptionNode && descriptionNode.GetValueKind() is JsonValueKind.String ?
-                    $"{descriptionNode.GetValue<string>()}\n{formatNode}" :
-                    formatNode.ToString();
+                schemaObj["description"] = schemaObj["description"] is { } descriptionNode && descriptionNode.GetValueKind() is JsonValueKind.String ?
+                    $"{descriptionNode.GetValue<string>()}\nFormat: {formatNode}" :
+                    $"Format: {formatNode}";

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 93f36a2 and b798d5e.

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

47-54: LGTM! Schema transformation correctly applied before parsing.

The change appropriately transforms the function schema through the cache before parsing, ensuring Gemini compatibility.

---

602-625: Well-implemented schema transformation for Gemini compatibility.

The transformation logic correctly identifies and relocates unsupported format properties while preserving "enum" and "date-time" formats. The implementation follows a clean pattern using the AIJsonSchemaTransformCache.

[gunpal5]

Thank you for support. I really appreciate it!