Skip to content

[VertexAI] Remove option from LiveSession Receive #1240

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

Remove the closeOnTurnComplete parameter from ReceiveAsync. It should always close after receiving the TurnComplete message, as it is easy enough for the developer to restart it on their end if they want.


Testing

Describe how you've tested these changes.

Running tests 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 removes the closeOnTurnComplete parameter from the ReceiveAsync method in LiveSession.cs. The change enforces that the stream always closes after receiving a TurnComplete message from the server. The PR description indicates that this change simplifies the API, as developers can easily restart the stream if needed.

Highlights

  • API Simplification: The closeOnTurnComplete parameter has been removed from the ReceiveAsync method.
  • Mandatory Stream Closure: The stream now always closes upon receiving a TurnComplete message.
  • Code Cleanup: The conditional check for closeOnTurnComplete has been removed, streamlining the code.

Changelog

  • vertexai/src/LiveSession.cs
    • Removed the closeOnTurnComplete parameter from the ReceiveAsync method signature.
    • Updated the method documentation to reflect the automatic closure behavior.
    • Removed the conditional check for closeOnTurnComplete when handling the TurnComplete message.
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.


A parameter's gone,
Simpler code marches on,
TurnComplete arrives,
The stream now survives,
No choice but to be withdrawn.

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 removes the closeOnTurnComplete parameter from the ReceiveAsync method in the LiveSession class. This change enforces that the stream always closes after receiving a TurnComplete message from the server. The rationale is that developers can easily restart the stream if they need it to continue. Overall, this seems like a reasonable simplification.

Summary of Findings

  • Documentation Update: The documentation for ReceiveAsync was updated to reflect the new behavior of automatically closing the connection upon receiving a TurnComplete message. This is good, as it keeps the documentation in sync with the code.
  • Code Simplification: The removal of the closeOnTurnComplete parameter simplifies the ReceiveAsync method and its usage. This reduces the number of options a developer needs to consider when using the API.

Merge Readiness

The code change appears straightforward and well-justified. The removal of the parameter simplifies the API and the documentation has been updated accordingly. I don't see any immediate issues that would block merging. However, as I am unable to directly approve the pull request, I recommend that others review and approve this code before merging, especially to ensure that the change does not introduce any unexpected side effects in existing use cases.

@a-maurice a-maurice requested a review from cynthiajoan May 1, 2025 00:48
@a-maurice a-maurice merged commit ccb7b52 into main May 1, 2025
5 checks passed
@a-maurice a-maurice deleted the am-vertexai_turncomplete branch May 1, 2025 18:22
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