-
Notifications
You must be signed in to change notification settings - Fork 2k
test(genai): Sample/pr test #4149
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
Conversation
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 @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 several new samples demonstrating the controlled generation capabilities of the Google GenAI SDK. These samples showcase how to use different schema types, including class-based schemas, enum-based schemas, nested schemas, and schemas with nullable properties, to guide the model's output into a desired structured format. Additionally, I've updated existing samples to utilize the latest gemini-2.5-flash
model.
Highlights
- New Controlled Generation Samples: I've added new samples demonstrating various controlled generation capabilities of the Google GenAI SDK, including the use of class schemas, enum class schemas, nested class schemas, nullable schemas, and direct response schemas.
- Model Version Upgrade: I've updated existing GenAI samples to utilize the latest
gemini-2.5-flash
model, ensuring they use the most current model version. - New Test Coverage: Corresponding test files have been introduced for all new controlled generation samples to ensure their correct functionality and provide robust testing coverage.
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.
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 comprehensive set of new samples for controlled generation with the GenAI SDK, complete with corresponding tests. The changes also include minor updates to existing files, primarily to update model names. The new samples are well-structured and demonstrate various features effectively. I've identified a few areas for improvement, including one high-severity correctness issue where a schema requires a field that isn't always present in the prompt. Other suggestions aim to enhance code clarity and consistency.
Humidity: {type: 'string', nullable: true}, | ||
WindSpeed: {type: 'integer', nullable: true}, | ||
}, | ||
required: ['Day', 'Temperature', 'Forecast', 'WindSpeed'], |
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.
The WindSpeed
property is marked as required, but the provided prompt does not include wind speed information for every day of the week (e.g., Tuesday, Wednesday, Thursday). This will cause an issue when the model tries to generate the JSON, as it may omit the WindSpeed
key for those days, violating the schema. To fix this, WindSpeed
should be removed from the required
array.
required: ['Day', 'Temperature', 'Forecast', 'WindSpeed'], | |
required: ['Day', 'Temperature', 'Forecast'], |
class InstrumentClass { | ||
static values() { | ||
return [ | ||
InstrumentClass.PERCUSSION, | ||
InstrumentClass.STRING, | ||
InstrumentClass.WOODWIND, | ||
InstrumentClass.BRASS, | ||
InstrumentClass.KEYBOARD, | ||
]; | ||
} | ||
} | ||
|
||
InstrumentClass.PERCUSSION = 'Percussion'; | ||
InstrumentClass.STRING = 'String'; | ||
InstrumentClass.WOODWIND = 'Woodwind'; | ||
InstrumentClass.BRASS = 'Brass'; | ||
InstrumentClass.KEYBOARD = 'Keyboard'; | ||
|
||
const responseSchema = { | ||
type: 'string', | ||
enum: InstrumentClass.values(), | ||
}; |
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.
The implementation of InstrumentClass
to mimic an enum is a bit complex. A simpler and more common JavaScript pattern for creating enums is to use a frozen object. This avoids the need for a class with a static method and late property assignments, making the code more concise and readable.
class InstrumentClass { | |
static values() { | |
return [ | |
InstrumentClass.PERCUSSION, | |
InstrumentClass.STRING, | |
InstrumentClass.WOODWIND, | |
InstrumentClass.BRASS, | |
InstrumentClass.KEYBOARD, | |
]; | |
} | |
} | |
InstrumentClass.PERCUSSION = 'Percussion'; | |
InstrumentClass.STRING = 'String'; | |
InstrumentClass.WOODWIND = 'Woodwind'; | |
InstrumentClass.BRASS = 'Brass'; | |
InstrumentClass.KEYBOARD = 'Keyboard'; | |
const responseSchema = { | |
type: 'string', | |
enum: InstrumentClass.values(), | |
}; | |
const InstrumentClass = Object.freeze({ | |
PERCUSSION: 'Percussion', | |
STRING: 'String', | |
WOODWIND: 'Woodwind', | |
BRASS: 'Brass', | |
KEYBOARD: 'Keyboard', | |
}); | |
const responseSchema = { | |
type: 'string', | |
enum: Object.values(InstrumentClass), | |
}; |
type: 'ARRAY', | ||
items: { | ||
type: 'OBJECT', | ||
properties: { | ||
recipeName: {type: 'STRING'}, | ||
ingredients: { | ||
type: 'ARRAY', | ||
items: {type: 'STRING'}, | ||
}, |
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.
The JSON schema types (ARRAY
, OBJECT
, STRING
) are in uppercase. While this might work with the library, the standard JSON Schema specification uses lowercase type names (e.g., 'array', 'object', 'string'). For consistency with other samples in this PR and adherence to the standard, it's better to use lowercase.
type: 'ARRAY', | |
items: { | |
type: 'OBJECT', | |
properties: { | |
recipeName: {type: 'STRING'}, | |
ingredients: { | |
type: 'ARRAY', | |
items: {type: 'STRING'}, | |
}, | |
type: 'array', | |
items: { | |
type: 'object', | |
properties: { | |
recipeName: {type: 'string'}, | |
ingredients: { | |
type: 'array', | |
items: {type: 'string'}, | |
}, |
Description
Fixes #
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
npm test
(see Testing)npm run lint
(see Style)GoogleCloudPlatform/nodejs-docs-samples
. Not a fork.