Skip to content

[VertexAI] Add version info to the rest calls #1238

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

Merged
merged 4 commits into from
May 1, 2025

Conversation

a-maurice
Copy link
Collaborator

Description

Provide details of the change, and generalize the change in the PR title above.

Adds the correct version info to the rest request headers. This uses reflection to get the information, since the properties are either internal or private, which prevents easier access.


Testing

Describe how you've tested these changes.

Running locally


Type of Change

Place an x the applicable box:

  • Bug fix. Add the issue # below if applicable.
  • New feature. A non-breaking change which adds functionality.
  • Other, such as a build process or documentation change.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Summary of Changes

This pull request adds version information to the REST request headers for the VertexAI C# library. It uses reflection to access the internal Firebase.VersionInfo.SdkVersion property and includes it in the x-goog-api-client header. Additionally, if data collection is enabled, the Firebase App ID and version are added to the headers.

Highlights

  • Version Info: Adds the Firebase SDK version to the x-goog-api-client header.
  • Data Collection Headers: Adds X-Firebase-AppId and X-Firebase-AppVersion headers when data collection is enabled.
  • Reflection: Uses reflection to access internal Firebase properties.

Changelog

Click here to see the changelog
  • vertexai/src/GenerativeModel.cs
    • Added code to retrieve the Firebase SDK version using FirebaseInterops.GetVersionInfoSdkVersion().
    • Added the version to the x-goog-api-client header.
    • Conditionally added X-Firebase-AppId and X-Firebase-AppVersion headers based on the IsDataCollectionDefaultEnabled property.
  • vertexai/src/Internal/FirebaseInterops.cs
    • Added InitializeAppReflection() to cache the IsDataCollectionDefaultEnabled property.
    • Added GetIsDataCollectionDefaultEnabled() to retrieve the value of the IsDataCollectionDefaultEnabled property.
    • Added GetVersionInfoSdkVersion() to retrieve the Firebase SDK version using reflection.
    • Initialized InitializeAppReflection() in the static constructor.
  • vertexai/src/LiveGenerativeModel.cs
    • Added code to retrieve the Firebase SDK version using FirebaseInterops.GetVersionInfoSdkVersion().
    • Added the version to the x-goog-api-client header.
    • Conditionally added X-Firebase-AppId and X-Firebase-AppVersion headers based on the IsDataCollectionDefaultEnabled property.
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.


Through reflection's art,
Version's secret we impart,
Headers now complete,
Data's gentle beat,
SDK's tale, a brand new start.

Footnotes

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request adds version information to the REST request headers, which is a valuable addition for tracking and debugging purposes. The implementation uses reflection to access the version information, which is necessary due to the properties being internal or private. The changes look good overall, but there are a few areas that could be improved.

Summary of Findings

  • Error Handling in Reflection: The reflection logic includes error handling, but it could be more robust. Consider logging more detailed information about the exceptions encountered during reflection to aid in debugging.
  • Redundancy in Version Retrieval: The version retrieval logic is duplicated in GenerativeModel.cs and LiveGenerativeModel.cs. Consider creating a shared method or constant to avoid redundancy.
  • Potential NullReferenceException: In FirebaseInterops.GetIsDataCollectionDefaultEnabled, there's a potential for a NullReferenceException if _dataCollectionProperty is null. Adding a null check before accessing its GetValue method would improve robustness.

Merge Readiness

The pull request is almost ready for merging. Addressing the comments regarding error handling, redundancy, and potential NullReferenceException would improve the code quality and robustness. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.

@a-maurice a-maurice requested a review from cynthiajoan May 1, 2025 18:11
@a-maurice a-maurice merged commit 298858c into main May 1, 2025
5 checks passed
@a-maurice a-maurice deleted the am-vertexai-restheaders branch May 1, 2025 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants