Skip to content

docs(genai): Add Grounding Sample for Vertex AI Search #13268

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
Mar 31, 2025

Conversation

holtskinner
Copy link
Contributor

@holtskinner holtskinner commented Mar 31, 2025

Add new VAIS example

@holtskinner holtskinner requested review from a team as code owners March 31, 2025 17:50
Copy link

snippet-bot bot commented Mar 31, 2025

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Mar 31, 2025
Copy link
Contributor

@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 @holtskinner, 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 a new example demonstrating how to use Vertex AI Search ( grounding ) with the google-generative-ai library. It includes a new file tools_vais_with_txt.py that contains the code for generating content using the Vertex AI Search tool, and it also adds a test case for this new tool in test_tools_examples.py. The example shows how to configure the GenerateContentConfig to use the VertexAISearch tool, and how to pass in the datastore ID.

Highlights

  • New Feature: Adds a new example demonstrating how to use Vertex AI Search with the google-generative-ai library.
  • New File: Introduces tools_vais_with_txt.py, which contains the code for generating content using the Vertex AI Search tool.
  • Test Case: Adds a test case for the new Vertex AI Search tool in test_tools_examples.py.

Changelog

  • genai/tools/test_tools_examples.py
    • Imports the new tools_vais_with_txt module.
    • Adds a new test function test_tools_vais_with_txt to test the Vertex AI Search tool.
  • genai/tools/tools_vais_with_txt.py
    • Creates a new file containing the generate_content function that uses the Vertex AI Search tool.
    • The generate_content function takes a datastore ID as input.
    • The function configures the GenerateContentConfig to use the VertexAISearch tool.
    • Includes example usage of the Vertex AI Search 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 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.


Did you know?

The concept of 'grounding' in AI refers to the process of connecting abstract symbols and concepts to real-world data and experiences, enabling AI systems to understand and reason about the world in a more human-like way.

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
Contributor

@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 a new tool integration with Vertex AI Search (VAIS) to the genai tools. It includes a new module tools_vais_with_txt.py that defines the generate_content function to interact with VAIS, and a corresponding test case in test_tools_examples.py. The code appears to be well-structured and includes necessary imports and configurations.

Merge Readiness

The pull request appears to be in good shape. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.

Copy link
Member

@msampathkumar msampathkumar left a comment

Choose a reason for hiding this comment

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

LGTM. Please wait till the PR is merged.

@holtskinner holtskinner merged commit 2c169cd into main Mar 31, 2025
14 checks passed
@holtskinner holtskinner deleted the grounding-vais branch March 31, 2025 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants