feat(genai): Add Live API samples v2 #13523
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @Guiners, 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!
I've added new Live API samples for the genai library, specifically introducing an example for a grounded Retrieval Augmented Generation (RAG) engine. Additionally, I've applied minor formatting improvements across several existing Live API websocket samples to enhance readability.
Highlights
- New Live API Sample: I've introduced live_ground_ragengine_with_txt.py, a new sample demonstrating how to use the Live API with a grounded RAG engine, leveraging VertexRagStore for context management.
- Code Formatting Improvements: I've applied minor formatting adjustments, primarily line wrapping, to several existing Live API websocket samples (live_websocket_audiogen_with_txt.py, live_websocket_audiotranscript_with_txt.py, live_websocket_textgen_with_audio.py, live_websocket_textgen_with_txt.py, and live_with_txt.py) to improve code readability.
- Test Coverage: I've updated test_live_examples.py to include a new test case and a mocking fixture for the newly added grounded RAG engine sample, ensuring its functionality is covered.
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 introduces a new sample for the Genai Live API, demonstrating its use with a RAG engine, and includes a corresponding test. Additionally, it applies formatting updates to several existing live API samples, which improves code style and readability. My review focuses on the new sample, where I've suggested a change to remove a hardcoded resource name to enhance reusability for other developers. The rest of the changes are positive and improve the codebase.
| import asyncio | ||
|
|
||
| _memory_corpus = "projects/cloud-ai-devrel-softserve/locations/us-central1/ragCorpora/2305843009213693952" |
There was a problem hiding this comment.
For better reusability and to avoid exposing project-specific details, it's recommended to construct the _memory_corpus string from environment variables for the project ID and a placeholder for the user-specific RAG corpus ID. This requires importing the os module and aligns with the practices in other samples.
import asyncio
import os
# TODO(developer): Set this to your RAG Corpus ID.
RAG_CORPUS_ID = "your-rag-corpus-id"
_memory_corpus = f"projects/{os.getenv('GOOGLE_CLOUD_PROJECT')}/locations/us-central1/ragCorpora/{RAG_CORPUS_ID}"
Description
Fixes #
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)