Skip to content

Conversation

gspencergoog
Copy link
Contributor

Description

This adds the responseJsonSchema field to the GenerationConfig class, which enables more JSON schema features like $def and $ref along with other advanced JSON schema features that Gemini 2.5 supports.

See the Gemini docs for more information about what is supported.

Related Issues

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@gspencergoog gspencergoog changed the title add responseJsonSchema to GenerationConfig feat: add responseJsonSchema to GenerationConfig Jul 29, 2025
@gspencergoog gspencergoog changed the title feat: add responseJsonSchema to GenerationConfig feat: add responseJsonSchema to GenerationConfig Jul 29, 2025
Copy link

@rodydavis rodydavis left a comment

Choose a reason for hiding this comment

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

LGTM

@cynthiajoan cynthiajoan changed the title feat: add responseJsonSchema to GenerationConfig feat(firebaseai): add responseJsonSchema to GenerationConfig Jul 30, 2025
@cynthiajoan
Copy link
Collaborator

Thanks for the PR, would like to check if it has been tested under both vertexAI and googleAI backend.

@gspencergoog
Copy link
Contributor Author

Thanks for the PR, would like to check if it has been tested under both vertexAI and googleAI backend.

Yes, I've tested it on both backends.

@gspencergoog
Copy link
Contributor Author

Okay, @cynthiajoan I added an example here that uses $def and $anchor, which wasn't possible before this change.

I also formatted the output a little better in the "chat" of the example, and updated the regular schema example to match.

I also bumped the Gemini model versions in the example's main, since they were pretty old, but I'm happy to revert that if you wanted them to stay that way.

@gspencergoog gspencergoog force-pushed the add_responseJsonSchema branch from 50e985e to 3b34157 Compare August 19, 2025 16:26
@Lyokone Lyokone merged commit def807a into firebase:main Aug 20, 2025
24 of 26 checks passed
sybrands-place pushed a commit to sybrands-place/flutterfire that referenced this pull request Aug 27, 2025
* main: (31 commits)
  making sure vertex instance will differentiate with location (firebase#17664)
  fix(firebaseai): Added token details parsing for Dev API (firebase#17609)
  feat(firebaseai): add thinking feature (firebase#17652)
  feat(firebaseai): Add app check limited use token (firebase#17645)
  fix(firebaseai): remove candidateCount from LiveGenerationConfig since the connection fails silently when it is set (firebase#17647)
  fix(firebaseai): Export `UnknownPart` (firebase#17655)
  fix(firebase_ai): Add `GroundingMetadata` parsing for Developer API (firebase#17657)
  fix(app_check, iOS): correctly parse `forceRefresh` argument using `boolValue` (firebase#17627)
  feat(firebaseai): imagen editing (firebase#17556)
  feat(firebaseai): add responseJsonSchema to GenerationConfig (firebase#17564)
  chore(firebaseai): fix error message test failure (firebase#17644)
  ci(apple): fix CI runners with explicit Xcode version (firebase#17634)
  chore(firebaseai): Minor fix for error message wording (firebase#17639)
  chore: fix warnings after latest flutter version (firebase#17640)
  Update CHANGELOG.md, put live api entry back for the official announcment (firebase#17635)
  fix(ci): ignore .gradle files in license check (firebase#17625)
  Remove `generateContent` call from count tokens page (firebase#17613)
  Update CHANGELOG.md (firebase#17621)
  Update CONTRIBUTING.md to add API change rule (firebase#17619)
  chore(release): publish packages (firebase#17618)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀 [firebase_ai] Support for advanced Schema features with $ref and $def
4 participants