feat: Update session sample with the new SessionServiceClient #13529
Conversation
… of ConversationalSearchServiceClient
There was a problem hiding this comment.
Summary of Changes
Hello @mostafaalaa3, 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 updates the session_sample.py file to migrate from using the ConversationalSearchServiceClient to the new SessionServiceClient. This change is proactive, as the former client is slated for deprecation, ensuring the sample remains current and functional with the recommended API client. The new client is noted to have the exact same methods as the one it replaces, simplifying the transition.
Highlights
- Client Migration: The
discoveryengine.ConversationalSearchServiceClientclient instantiation has been replaced withdiscoveryengine.SessionServiceClientin all five session-related functions (create_session,get_session,delete_session,update_session,list_sessions) withinsession_sample.py.
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 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 or fill out our survey 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.
Code Review
This pull request correctly updates the deprecated ConversationalSearchServiceClient to SessionServiceClient as intended. The change is straightforward. My review includes one suggestion to improve the sample code by adding a comment about client instantiation best practices. While the current approach is fine for self-contained examples, it's important to guide users on efficient client reuse in real-world applications. This will help prevent performance issues for users who adapt this sample code.
| @@ -37,7 +37,7 @@ def create_session( | |||
| discoveryengine.Session: The newly created Session. | |||
| """ | |||
|
|
|||
| client = discoveryengine.ConversationalSearchServiceClient() | |||
| client = discoveryengine.SessionServiceClient() | |||
There was a problem hiding this comment.
Instantiating a new client for each function call is not a recommended practice for production applications. Google Cloud client libraries are designed to have their client instances reused to avoid the overhead of setting up new connections for each request.
While this pattern is acceptable for a self-contained sample where each function is independent, adding a comment to educate users about this best practice would be very helpful.
This feedback also applies to the other functions in this file where a client is instantiated (lines 74, 107, 141, and 181).
| client = discoveryengine.SessionServiceClient() | |
| # In real-world applications, a single client instance should be created and reused for better performance. | |
| client = discoveryengine.SessionServiceClient() |
|
This obviously requires the a new client to be used |
Hi @mostafaalaa3. You did indicate in the PR template that you'd need an API enabled, but you didn't indicate which one. After review, I believe what's actually required is updating the google-cloud-discoveryclient to 0.13.11 (ref googleapis/google-cloud-python#14151 where SessionService was added in this version). I'm going to make this update, and see if that causes tests to pass. |
…rting SessionService
|
Please make sure you let folks know they need a minimum version of the SDK to have this sample work ✨ |
feat: Update session sample with the new SessionServiceClient instead of ConversationalSearchServiceClient.
Description
ConversationalSearchServiceClient will be deprecated soon and we would like to use SessionServiceClient instead. The new service has the exact same methods as the previous one.
Checklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)