-
Notifications
You must be signed in to change notification settings - Fork 46
[Firebase AI] Change public fields to easier types #1290
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @a-maurice, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines the public API of the Firebase AI SDK by updating several key data types. The primary goal is to enhance the usability and compatibility of the SDK, particularly for environments like Unity, by simplifying how binary data and collections are exposed. These changes provide more direct and intuitive access to data while maintaining immutability where intended.
Highlights
- API Type Refinement for Binary Data: Public fields previously using
ReadOnlyMemory<byte>
have been updated tobyte[]
. This change aims to align better with Unity's expectations and simplify the handling of binary data within the SDK's public API. - Collection Interface Update for Read-Only Access: Public properties and internal fields that exposed
IEnumerable<T>
or usedReadOnlyCollection<T>
internally have been transitioned toIReadOnlyList<T>
. This provides a clearer contract for consumers, indicating that the underlying data is a read-only list with indexed access, rather than just an enumerable sequence. - Internal Code Simplification: The internal implementations have been streamlined by removing the explicit wrapping of lists into
ReadOnlyCollection<T>
. Instead,List<T>
instances are now directly assigned toIReadOnlyList<T>
fields, reducing boilerplate and removing unnecessarySystem.Collections.ObjectModel
usings.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates public field types, changing ReadOnlyMemory<byte>
to byte[]
and IEnumerable<T>
to IReadOnlyList<T>
. These changes improve the API's usability within a Unity context. The review focuses on ensuring that these changes don't introduce unintended side effects, such as breaking encapsulation by exposing mutable collections. Several instances were found where internal List<T>
collections are exposed through IReadOnlyList<T>
properties, which could allow consumers to modify the internal state of objects. Suggestions to create defensive copies or use safer collection types to maintain immutability have been provided.
Description
Change public field types from ReadOnlyMemory to just byte[], since that is more inline with was Unity expects. Change IEnumerable to IReadOnlyList where appropriate, to better reflect the underlying data.
Testing
Running the tests locally
Type of Change
Place an
x
the applicable box: