Skip to content

docs(doc-snippets): clarify ai.chat is provided by genkit/beta #3791

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(doc-snippets): clarify ai.chat is provided by genkit/beta #3791

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions js/doc-snippets/src/flows/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ import { googleAI } from '@genkit-ai/googleai';
import { z } from 'genkit';
import { genkit } from 'genkit/beta';

// NOTE: The chat / studio style APIs (for example `ai.chat`) are provided
// in the beta package `genkit/beta`. If you try to use `ai.chat` while
// importing `genkit` from the stable package, you'll run into confusing
// type errors because the chat APIs aren't exposed there. The snippets in
// this file use `genkit/beta` on purpose so `ai.chat` and related features
// are available.

const ai = genkit({
plugins: [googleAI()],
});
Expand Down Expand Up @@ -121,6 +128,14 @@ const PrixFixeMenuSchema = z.object({
dessert: z.string(),
});

// IMPORTANT: This flow uses `ai.chat(...)` which is only available when
// `genkit` is imported from `genkit/beta` (see the note above). If you
// copied this example into your project and saw type errors around
// `ai.chat`, make sure your import looks like:
//
// import { genkit } from 'genkit/beta';
//
// instead of `import { genkit } from 'genkit'`.
export const complexMenuSuggestionFlow = ai.defineFlow(
{
name: 'complexMenuSuggestionFlow',
Expand Down