diff --git a/quickstarts-js/Get_Started_Imagen.js b/quickstarts-js/Get_Started_Imagen.js new file mode 100644 index 000000000..6c649c674 --- /dev/null +++ b/quickstarts-js/Get_Started_Imagen.js @@ -0,0 +1,242 @@ +/* Markdown (render) +##### 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. +*/ + +/* Markdown (render) +# Gemini API: Get started with image generation +*/ + +/* Markdown (render) +The `imagen-3.0-generate-002` model is Google's highest quality text-to-image model, featuring a number of new and improved capabilities. Imagen 3 can do the following: + +* Generate images with fine detail, rich lighting, and few distracting artifact +* Understand prompts written in natural language +* Generate images in a wide range of formats and styles +* Render text effectively + +This notebook is using the [Python SDK](https://googleapis.github.io/python-genai/#imagen). For the REST API, check out the [Get Started with Imagen](../Get_started_imagen_rest.ipynb) guide. +*/ + +/* Markdown (render) + + + + + + + + +
+ ⚠️ + +

Image generation is a paid-only feature and won't work if you are on the free tier. Check the pricing page for more details.

+
+*/ + +/* Markdown (render) +## Setup +### Install SDK and set-up the client + +### API Key Configuration + +To ensure security, avoid hardcoding the API key in frontend code. Instead, set it as an environment variable on the server or local machine. + +When using the Gemini API client libraries, the key will be automatically detected if set as either `GEMINI_API_KEY` or `GOOGLE_API_KEY`. If both are set, `GOOGLE_API_KEY` takes precedence. + +For instructions on setting environment variables across different operating systems, refer to the official documentation: [Set API Key as Environment Variable](https://ai.google.dev/gemini-api/docs/api-key#set-api-env-var) + +In code, the key can then be accessed as: + +```js +ai = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY }); +``` +*/ + +// [CODE STARTS] +module = await import("https://esm.sh/@google/genai@1.4.0"); +GoogleGenAI = module.GoogleGenAI; +ai = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY }); +// [CODE ENDS] + +/* Markdown (render) +## Generate images +### Select model + +There are currently 3 available Imagen models: + +* Imagen 4 (imagen-4.0-generate-preview-06-06) is the new stadard model you should use to generate. +* Imagen 4 Ultra (imagen-4.0-ultra-generate-preview-06-06) is the best Imagen model, generating even finer images and is especially good at generating images with text. Note that it can only generate one image at a time. +* Imagen 3 (imagen-3.0-generate-002) is the previous generation model. It's still available in case you need to rerun old prompts, but it is recommended to use the 4th generation models now. +*/ + +// [CODE STARTS] +MODEL_ID = "imagen-4.0-generate-preview-06-06" // "imagen-3.0-generate-002","imagen-4.0-generate-preview-06-06","imagen-4.0-ultra-generate-preview-06-06" +// [CODE ENDS] + +/* Markdown (render) +### Prompt creation + +Now, write your prompt and set some optional parameters. The Imagen models are trained on long captions and will provide better results for longer and more descriptive prompts. Note that if you use a short prompt, it may result in low adherence and more random output. + +Check the [prompt guide](https://ai.google.dev/gemini-api/docs/imagen-prompt-guide) for more advice on creating your prompts. + +Here are the parameters you can set relating to your prompt: +* `number_of_images`: Specifies how many iamges will be generated. The default value is 4, with valid values between 1 to 4, inclusive. In the below code cell, `sample_count` is used to define this. +* `person_generation`: Allows the model to generate images with adults. Kids are always blocked. The supported values are `DONT_ALLOW` and `ALLOW_ADULT`. The default value is `ALLOW_ADULT`. +* `aspect_ratio`: Specifies the aspect ratio of the images produces. The supported values are `1:1`, `3:4`, `4:3`, `16:9`, and `9:16`. The default value is `1:1`. +* `output_mime_type`: The output type of your image, which will be `image/jpeg`. This is the only allowed value at the moment. + +A non-visible digital [SynthID](https://deepmind.google/technologies/synthid/) watermark is always added to generated images. +*/ + +// [CODE STARTS] +prompt = "A cat lounging lazily on a sunny windowstill playing with a kid toy." +number_of_images = 4 +personGeneration = "ALLOW_ADULT" +aspectRatio = "1:1" +// [CODE ENDS] + +/* Markdown (render) +### Generate the images +*/ + +// [CODE STARTS] +response = await ai.models.generateImages({ + model: MODEL_ID, + prompt: prompt, + config: { + numberOfImages: 4, + aspectRatio: aspectRatio, + personGeneration: personGeneration + }, +}); +// [CODE ENDS] + +/* Markdown (render) +### Display the images + +Use the code below to inspect the images you generated. +*/ + +// [CODE STARTS] +for (const generatedImage of response.generatedImages) { + const base64 = generatedImage.image.imageBytes; + console.image(base64, "image/png"); +} +// [CODE ENDS] + +/* Output Sample + +F5tua94.md.png +F5tu5cG.md.png +F5tu7Sf.md.png +F5tucAl.md.png + +*/ + +/* Markdown (render) +### Generate images with text +Imagen 3 and 4 models are good at generating images with text. Here's an example with a comic strip: +*/ + +// [CODE STARTS] +prompt = "A 3‑panel cosmic epic comic. Panel 1: Tiny 'Stardust' in nebula; radar shows anomaly (text 'ANOMALY DETECTED'), hull text 'stardust'. Pilot whispers. Panel 2: Bioluminescent leviathan emerges; console red text 'WARNING!'. Panel 3: Leviathan chases ship through asteroids; console red text 'SHIELD CRITICAL!', screen text 'EVADE!'. Pilot screams, SFX 'CRUNCH!', 'ROOOOAAARR!'."; + +numberOfImages = 1; +aspectRatio = "1:1"; +personGeneration = "ALLOW_ADULT"; + +result = await ai.models.generateImages({ + model: MODEL_ID, + prompt: prompt, + config: { + numberOfImages: numberOfImages, + aspectRatio: aspectRatio, + personGeneration: personGeneration, + outputMimeType: "image/jpeg" + } +}); + +for (const generatedImage of result.generatedImages) { + const base64 = generatedImage.image.imageBytes; + console.image(base64); +} + +// [CODE ENDS] + +/* Output Sample + +comic + +*/ + +/* Markdown (render) +Here's a second one. This time, the image saved in the notebook has been generated using Imagen 4 Ultra as there was quite a lot of text to process: +*/ + +// [CODE STARTS] +prompt = ` + a wall on which a colorful tag is drawn and that can be read as the first verse of Charles Baudelaire's poem "l'invitation au voyage": + Mon enfant, ma sÅ“ur, + Songe à la douceur + D’aller là -bas vivre ensemble ! + Aimer à loisir, + Aimer et mourir + Au pays qui te ressemble ! +`; + +numberOfImages = 1; +aspectRatio = "9:16"; +personGeneration = "ALLOW_ADULT"; + +result = await ai.models.generateImages({ + model: MODEL_ID, + prompt: prompt, + config: { + numberOfImages: numberOfImages, + aspectRatio: aspectRatio, + personGeneration: personGeneration, + outputMimeType: "image/jpeg" + } +}); + +for (const generatedImage of result.generatedImages) { + const base64 = generatedImage.image.imageBytes; + console.image(base64); +} + +// [CODE ENDS] + +/* Output Sample +poem +*/ + +/* Markdown (render) +## Next Steps +### Useful documentation references: + +To improve your prompting skills, check the [prompt guide](https://ai.google.dev/gemini-api/docs/imagen-prompt-guide) for great advices on creating your prompts. + +### Check those cool Imagen examples: +Here are some Imagen examples to get your imagination started on how to use it in creative ways: +* [Illustrate a book](https://github.com/google-gemini/cookbook/blob/main/examples/Book_illustration.ipynb): Use Gemini and Imagen to create illustration for an open-source book + +### Continue your discovery of the Gemini API + +Gemini is not only good at generating images, but also at understanding them. Check the [Spatial understanding](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Spatial_understanding.ipynb) guide for an introduction on those capabilities, and the [Video understanding](https://github.com/google-gemini/cookbook/blob/main/quickstarts/Video_understanding.ipynb) one for video examples. +*/ \ No newline at end of file diff --git a/quickstarts-js/README.md b/quickstarts-js/README.md index 1a2922067..80e03d7f0 100644 --- a/quickstarts-js/README.md +++ b/quickstarts-js/README.md @@ -17,5 +17,5 @@ Stay tuned, more JavaScript notebooks are on the way! | Cookbook | Description | Features | Launch | Code File | | --- | --- | --- | --- | --- | | Get Started | A comprehensive introduction to the Gemini JS/TS SDK, demonstrating features such as text and multimodal prompting, token counting, system instructions, safety filters, multi-turn chat, output control, function calling, content streaming, file uploads, and using URL or YouTube video context. | Explore core Gemini capabilities in JS/TS | [![Open in AI Studio](https://storage.googleapis.com/generativeai-downloads/images/Open_in_AIStudio.svg)](https://aistudio.google.com/apps/bundled/get_started?showPreview=true) | JS [Get_Started.js](./Get_Started.js) | - +| Imagen Quickstart | Generate rich, high-quality images using Google's Imagen 4 and Imagen 4 Ultra models. Explore prompt tuning, text rendering, comic-style generation, and poetic visualizations—all via the Gemini API. | Text-to-image, Imagen 4, prompt engineering, creative generation, SynthID | [![Open in AI Studio](https://storage.googleapis.com/generativeai-downloads/images/Open_in_AIStudio.svg)](https://aistudio.google.com/starter-apps/imagen?showPreview=true) | JS [Imagen.js](./Imagen.js) |