-
Notifications
You must be signed in to change notification settings - Fork 2.9k
feat(genai): add Vertex AI Search tool sample #10150
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
base: main
Are you sure you want to change the base?
feat(genai): add Vertex AI Search tool sample #10150
Conversation
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
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 @jdomingr, 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 introduces a new sample for the Google GenAI SDK in Java, showcasing how to leverage the Vertex AI Search (VAIS) tool to provide grounded responses during content generation. The sample demonstrates the necessary client and tool configurations to enable the model to retrieve information from a specified datastore, enhancing the relevance and accuracy of generated text. This addition provides developers with a practical example of integrating external knowledge sources into their GenAI applications.
Highlights
- New GenAI SDK Sample: A new Java sample,
ToolsVaisWithText.java
, has been added to demonstrate how to integrate Vertex AI Search (VAIS) with the Google GenAI SDK for grounded content generation. - Vertex AI Search Integration: The sample illustrates the configuration of the GenAI client to enable Vertex AI capabilities and the setup of a
Tool
object specifically forVertexAISearch
, requiring adatastoreId
. - Integration Test Coverage: An integration test,
testToolsVaisWithText()
, has been added toToolsIT.java
to ensure the new VAIS sample functions correctly, verifying that content can be generated using the configured tool.
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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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 introduces a new sample for using the Vertex AI Search tool with the GenAI SDK. The changes include a new sample file ToolsVaisWithText.java
and a corresponding integration test in ToolsIT.java
. The code is well-structured and follows the existing patterns. I have a couple of minor suggestions to improve code clarity and efficiency.
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 looks perfectly fine.
- Tested with my own VAIS and queried it (asked questions about my personal blog content)
Description
Add new GenAI Vertex AI Search tool sample
The Vertex AI Search tool with text sample works locally, but a datastore had to be created and the Discovery Engine Editor role was required to pass the test. This means that, for this sample to pass the test, the reviewer needs to create a datastore, as found in Python Vais tool sample (https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/genai/tools/test_tools_examples.py)
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
mvn clean verify
requiredmvn -P lint checkstyle:check
requiredmvn -P lint clean compile pmd:cpd-check spotbugs:check
advisory only