Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions genai/controlled-generation/ctrlgen-with-class-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

// [START googlegenaisdk_ctrlgen_with_class_schema]
const {GoogleGenAI} = require('@google/genai');

const GOOGLE_CLOUD_PROJECT = process.env.GOOGLE_CLOUD_PROJECT;
const GOOGLE_CLOUD_LOCATION = process.env.GOOGLE_CLOUD_LOCATION || 'global';

async function generateContent(
projectId = GOOGLE_CLOUD_PROJECT,
location = GOOGLE_CLOUD_LOCATION
) {
const ai = new GoogleGenAI({
vertexai: true,
project: projectId,
location: location,
});

class Recipe {
/**
* @param {string} recipeName
* @param {string[]} ingredients
*/
constructor(recipeName, ingredients) {
this.recipeName = recipeName;
this.ingredients = ingredients;
}
}

const response = await ai.models.generateContent({
model: 'gemini-2.5-flash',
contents: 'List a few popular cookie recipes?',
config: {
responseMimeType: 'application/json',
responseSchema: Recipe,
},
});

console.log(response.text);
return response.text;
}
// [END googlegenaisdk_ctrlgen_with_class_schema]

module.exports = {
generateContent,
};
73 changes: 73 additions & 0 deletions genai/controlled-generation/ctrlgen-with-enum-class-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

// [START googlegenaisdk_ctrlgen_with_enum_class_schema]
const {GoogleGenAI} = require('@google/genai');

const GOOGLE_CLOUD_PROJECT = process.env.GOOGLE_CLOUD_PROJECT;
const GOOGLE_CLOUD_LOCATION = process.env.GOOGLE_CLOUD_LOCATION || 'global';

async function generateContent(
projectId = GOOGLE_CLOUD_PROJECT,
location = GOOGLE_CLOUD_LOCATION
) {
const ai = new GoogleGenAI({
vertexai: true,
project: projectId,
location: location,
});

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(),
};
Comment on lines +33 to +54
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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),
};


const response = await ai.models.generateContent({
model: 'gemini-2.5-flash',
contents: 'What type of instrument is a guitar?',
config: {
responseMimeType: 'text/x.enum',
responseSchema: responseSchema,
},
});

console.log(response.text);

return response.text;
}
// [END googlegenaisdk_ctrlgen_with_enum_class_schema]

module.exports = {
generateContent,
};
2 changes: 1 addition & 1 deletion genai/controlled-generation/ctrlgen-with-enum-schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ async function generateContent(
};

const response = await ai.models.generateContent({
model: 'gemini-2.0-flash',
model: 'gemini-2.5-flash',
contents: 'What type of instrument is an oboe?',
config: {
responseMimeType: 'text/x.enum',
Expand Down
74 changes: 74 additions & 0 deletions genai/controlled-generation/ctrlgen-with-nested-class-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

// [START googlegenaisdk_ctrlgen_with_nested_class_schema]
const {GoogleGenAI} = require('@google/genai');

const GOOGLE_CLOUD_PROJECT = process.env.GOOGLE_CLOUD_PROJECT;
const GOOGLE_CLOUD_LOCATION = process.env.GOOGLE_CLOUD_LOCATION || 'global';

async function generateContent(
projectId = GOOGLE_CLOUD_PROJECT,
location = GOOGLE_CLOUD_LOCATION
) {
const ai = new GoogleGenAI({
vertexai: true,
project: projectId,
location: location,
});

const Grade = Object.freeze({
A_PLUS: 'a+',
A: 'a',
B: 'b',
C: 'c',
D: 'd',
F: 'f',
});

class Recipe {
/**
* @param {string} recipeName
* @param {string} rating - Must be one of Grade enum values
*/
constructor(recipeName, rating) {
if (!Object.values(Grade).includes(rating)) {
throw new Error(`Invalid rating: ${rating}`);
}
this.recipeName = recipeName;
this.rating = rating;
}
}

const response = await ai.models.generateContent({
model: 'gemini-2.5-flash',
contents:
'List about 10 home-baked cookies and give them grades based on tastiness.',
config: {
responseMimeType: 'application/json',
responseSchema: Recipe,
},
});

console.log(response.text);

return response.text;
}
// [END googlegenaisdk_ctrlgen_with_nested_class_schema]

module.exports = {
generateContent,
};
80 changes: 80 additions & 0 deletions genai/controlled-generation/ctrlgen-with-nullable-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

// [START googlegenaisdk_ctrlgen_with_nullable_schema]
const {GoogleGenAI} = require('@google/genai');

const GOOGLE_CLOUD_PROJECT = process.env.GOOGLE_CLOUD_PROJECT;
const GOOGLE_CLOUD_LOCATION = process.env.GOOGLE_CLOUD_LOCATION || 'global';

async function generateContent(
projectId = GOOGLE_CLOUD_PROJECT,
location = GOOGLE_CLOUD_LOCATION
) {
const ai = new GoogleGenAI({
vertexai: true,
project: projectId,
location: location,
});

const prompt = `
The week ahead brings a mix of weather conditions.
Sunday is expected to be sunny with a temperature of 77°F and a humidity level of 50%. Winds will be light at around 10 km/h.
Monday will see partly cloudy skies with a slightly cooler temperature of 72°F and the winds will pick up slightly to around 15 km/h.
Tuesday brings rain showers, with temperatures dropping to 64°F and humidity rising to 70%.
Wednesday may see thunderstorms, with a temperature of 68°F.
Thursday will be cloudy with a temperature of 66°F and moderate humidity at 60%.
Friday returns to partly cloudy conditions, with a temperature of 73°F and the Winds will be light at 12 km/h.
Finally, Saturday rounds off the week with sunny skies, a temperature of 80°F, and a humidity level of 40%. Winds will be gentle at 8 km/h.
`;

const responseSchema = {
type: 'object',
properties: {
forecast: {
type: 'array',
items: {
type: 'object',
properties: {
Day: {type: 'string', nullable: true},
Forecast: {type: 'string', nullable: true},
Temperature: {type: 'integer', nullable: true},
Humidity: {type: 'string', nullable: true},
WindSpeed: {type: 'integer', nullable: true},
},
required: ['Day', 'Temperature', 'Forecast', 'WindSpeed'],
Copy link
Contributor

Choose a reason for hiding this comment

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

high

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.

Suggested change
required: ['Day', 'Temperature', 'Forecast', 'WindSpeed'],
required: ['Day', 'Temperature', 'Forecast'],

},
},
},
};

const response = await ai.models.generateContent({
model: 'gemini-2.5-flash',
contents: prompt,
config: {
responseMimeType: 'application/json',
responseSchema: responseSchema,
},
});
console.log(response.text);

return response.text;
}
// [END googlegenaisdk_ctrlgen_with_nullable_schema]

module.exports = {
generateContent,
};
67 changes: 67 additions & 0 deletions genai/controlled-generation/ctrlgen-with-resp-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

// [START googlegenaisdk_ctrlgen_with_resp_schema]
const {GoogleGenAI} = require('@google/genai');

const GOOGLE_CLOUD_PROJECT = process.env.GOOGLE_CLOUD_PROJECT;
const GOOGLE_CLOUD_LOCATION = process.env.GOOGLE_CLOUD_LOCATION || 'global';

async function generateContent(
projectId = GOOGLE_CLOUD_PROJECT,
location = GOOGLE_CLOUD_LOCATION
) {
const ai = new GoogleGenAI({
vertexai: true,
project: projectId,
location: location,
});

const prompt = 'List a few popular cookie recipes.';

const responseSchema = {
type: 'ARRAY',
items: {
type: 'OBJECT',
properties: {
recipeName: {type: 'STRING'},
ingredients: {
type: 'ARRAY',
items: {type: 'STRING'},
},
Comment on lines +36 to +44
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
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'},
},

},
required: ['recipeName', 'ingredients'],
},
};

const response = await ai.models.generateContent({
model: 'gemini-2.5-flash',
contents: prompt,
config: {
responseMimeType: 'application/json',
responseSchema: responseSchema,
},
});

console.log(response.text);

return response.text;
}
// [END googlegenaisdk_ctrlgen_with_resp_schema]

module.exports = {
generateContent,
};
29 changes: 29 additions & 0 deletions genai/test/ctrlgen-with-class-schema.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

const {assert} = require('chai');
const {describe, it} = require('mocha');

const projectId = process.env.CAIP_PROJECT_ID;
const sample = require('../controlled-generation/ctrlgen-with-class-schema.js');

describe('ctrlgen-with-class-schema', () => {
it('should generate text content in Json', async function () {
this.timeout(10000);
const output = await sample.generateContent(projectId);
assert(output.length > 0 && output.includes('Cookies'));
});
});
Loading