Skip to content

Update documentation for the genui implemention - 'Getting Started wi… #573

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

Merged
merged 3 commits into from
Dec 1, 2025
Merged

Update documentation for the genui implemention - 'Getting Started wi… #573

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddfab25
Update documentation for the genui implemention - 'Getting Started wi…
bjorndonald Nov 24, 2025
2d7bdf7
Updated the changelog to reflect new changes to the genui Readme file
bjorndonald Nov 24, 2025
ea76b60
Removed the additionalTools paramter from example in genui ReadMe
bjorndonald Nov 28, 2025
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
1 change: 1 addition & 0 deletions packages/genui/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# `genui` Changelog

## 0.5.2 (in progress)
- Updated README sample code to reflect current `FirebaseAiContentGenerator` API (added `catalog` parameter and replaced `tools` with `additionalTools`).

## 0.5.1

Expand Down
5 changes: 4 additions & 1 deletion packages/genui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,15 @@ provider.
// Create a ContentGenerator to communicate with the LLM.
// Provide system instructions and the tools from the GenUiManager.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 24, 2025

Choose a reason for hiding this comment

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

medium

This comment is now outdated. The code no longer passes tools from _genUiManager. The core UI tools are now inferred from the catalog parameter within FirebaseAiContentGenerator. You should update this comment to reflect the current implementation.

Suggested change
// Provide system instructions and the tools from the GenUiManager.
// Provide system instructions and any additional tools.

final contentGenerator = FirebaseAiContentGenerator(
catalog: CoreCatalogItems.asCatalog(),
systemInstruction: '''
You are an expert in creating funny riddles. Every time I give you a word,
you should generate UI that displays one new riddle related to that word.
Each riddle should have both a question and an answer.
''',
tools: _genUiManager.getTools(),
additionalTools: [
// Additional tools to be provided to the AI model. Schema [AiTool] (required String name, required String description, Schema? parameters, String? prefix)
Copy link
Collaborator

@jacobsimionato jacobsimionato Nov 28, 2025

Choose a reason for hiding this comment

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

I think we can remove the 'additionalTools' parameter from the example here, seeing as it's not necessary for the most simple setup.

Copy link
Contributor Author

@bjorndonald bjorndonald Nov 28, 2025

Choose a reason for hiding this comment

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

That makes sense. I have push the change.

],
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 24, 2025

Choose a reason for hiding this comment

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

medium

Placing a long comment inside an empty list can be hard to read. It would be more conventional and readable to place the explanatory comments above the additionalTools parameter.

Suggested change
additionalTools: [
// Additional tools to be provided to the AI model. Schema [AiTool] (required String name, required String description, Schema? parameters, String? prefix)
],
// Additional tools to be provided to the AI model. The schema for an AiTool is:
// required String name, required String description, Schema? parameters, String? prefix
additionalTools: [],

);

// Create the GenUiConversation to orchestrate everything.
Expand Down