From bcb59e075521993188ee935802447d89e48cfb07 Mon Sep 17 00:00:00 2001 From: Michael Bleigh Date: Mon, 6 Oct 2025 14:56:31 -0700 Subject: [PATCH 1/2] docs: refine .guides guidance a bit --- js/genkit/.guides/setup.md | 3 ++- js/plugins/google-genai/.guides/usage.md | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 js/plugins/google-genai/.guides/usage.md diff --git a/js/genkit/.guides/setup.md b/js/genkit/.guides/setup.md index 4ca0078282..af7e48e4a9 100644 --- a/js/genkit/.guides/setup.md +++ b/js/genkit/.guides/setup.md @@ -13,6 +13,7 @@ import { googleAI } from '@genkit-ai/google-genai'; export const ai = genkit({ plugins: [googleAI()], + model: googleAI.model('gemini-2.5-flash'), }); export { z }; @@ -26,5 +27,5 @@ import './genkit.js'; // import each created flow, tool, etc. here for use in the Genkit Dev UI ``` -8. Add a `genkit:ui` script to `package.json` that runs `npx genkit-cli start -- npx tsx {sourceDir}/ai/index.ts` (or `pnpm dlx` or `yarn dlx` for those package managers). DO NOT try to run the script now. +8. Add a `genkit:ui` script to `package.json` that runs `npx genkit-cli start -- npx tsx --watch {sourceDir}/ai/index.ts` (or `pnpm dlx` or `yarn dlx` for those package managers). DO NOT try to run the script now. 9. Tell the user "Genkit is now configured and ready for use." as setup is now complete. Also remind them to set appropriate env variables (e.g. `GEMINI_API_KEY` for Google providers). Wait for the user to prompt further before creating any specific flows. diff --git a/js/plugins/google-genai/.guides/usage.md b/js/plugins/google-genai/.guides/usage.md new file mode 100644 index 0000000000..3dacef13d7 --- /dev/null +++ b/js/plugins/google-genai/.guides/usage.md @@ -0,0 +1,19 @@ +To use a Gemini model with Genkit: + +```ts +import { ai, z } from "..."; // path to genkit instance +import { googleAI } from "@genkit-ai/google-genai"; + +const {text} = await ai.generate({ + model: googleAI.model('gemini-2.5-flash'), + prompt: "...", +}); +``` + +ALWAYS use `gemini-2.5-*` series models, they are the best and current generation of Gemini models. NEVER use `gemini-2.0-*` or `gemini-1.5-*` models. For general purpose inference, use one of these models: + +- `gemini-2.5-flash`: balance of speed/performance, good default +- `gemini-2.5-pro`: most powerful, use for complex prompts +- `gemini-2.5-flash-lite`: very fast, use for simple prompts + +All of these models can accept multi-modal input, but for image or audio output see the available documentation for specialized models. From ef68174520c4d089e1be82981554de588af57c20 Mon Sep 17 00:00:00 2001 From: Michael Bleigh Date: Mon, 6 Oct 2025 14:59:59 -0700 Subject: [PATCH 2/2] format --- js/plugins/google-genai/.guides/usage.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/js/plugins/google-genai/.guides/usage.md b/js/plugins/google-genai/.guides/usage.md index 3dacef13d7..c26f839b26 100644 --- a/js/plugins/google-genai/.guides/usage.md +++ b/js/plugins/google-genai/.guides/usage.md @@ -1,12 +1,12 @@ To use a Gemini model with Genkit: ```ts -import { ai, z } from "..."; // path to genkit instance -import { googleAI } from "@genkit-ai/google-genai"; +import { ai, z } from '...'; // path to genkit instance +import { googleAI } from '@genkit-ai/google-genai'; -const {text} = await ai.generate({ +const { text } = await ai.generate({ model: googleAI.model('gemini-2.5-flash'), - prompt: "...", + prompt: '...', }); ```