feat: create new Vertex AI for Firebase plugin. #12728

cynthiajoan · 2024-05-01T05:18:32Z

Description

Add firebase_vertexai plugin. This plugin will provide flutter developer to have access to Vertex AI service. More details in README.md of the package.

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.

russellwheatley

Thank you for the PR, @cynthiajoan

A few things to note:

I am aware that the timeline is quite short so I've made some suggestions. I think that this being a dev release gives us more flexibility with future changes, and it might be worth pointing out that the API could change in the future.

For instance, I'm not sure we should have a dependency on App Check as it forces the user to have it + app check plugin initialisation, particularly as we're only interested in the token. There are ways around this issue that would require some internal changes and we can think about that before making it general release.

There are a number of private methods that don't appear to be used but I'm guessing they're for future releases. In any event, they can also be removed in a future release.

I don't think the plugin needs to extend the FirebasePluginPlatform but this will cause issue with the mock tests so it can be left and removed at a later time if we wish.

packages/firebase_vertexai/firebase_vertexai/README.md

packages/firebase_vertexai/firebase_vertexai/lib/firebase_vertexai.dart

packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_api.dart

packages/firebase_vertexai/firebase_vertexai/lib/src/firebase_vertexai.dart

packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_chat.dart

packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_model.dart

packages/firebase_vertexai/firebase_vertexai/test/vertex_mock.dart

packages/firebase_vertexai/firebase_vertexai/lib/src/vertex_content.dart

cynthiajoan · 2024-05-09T18:03:10Z

Thank you for the PR, @cynthiajoan

A few things to note:

I am aware that the timeline is quite short so I've made some suggestions. I think that this being a dev release gives us more flexibility with future changes, and it might be worth pointing out that the API could change in the future.

For instance, I'm not sure we should have a dependency on App Check as it forces the user to have it + app check plugin initialisation, particularly as we're only interested in the token. There are ways around this issue that would require some internal changes and we can think about that before making it general release.

There are a number of private methods that don't appear to be used but I'm guessing they're for future releases. In any event, they can also be removed in a future release.

I don't think the plugin needs to extend the FirebasePluginPlatform but this will cause issue with the mock tests so it can be left and removed at a later time if we wish.

Thanks Russell. I agree with the app check part, I will point out the sdk is in preview status and apis might be changing.

packages/firebase_vertexai/firebase_vertexai/LICENSE

packages/firebase_vertexai/firebase_vertexai/example/analysis_options.yaml

Lyokone · 2024-05-10T06:42:17Z

More on the app_check part, we can probably remove the changes made to the example App Check app, so we don't get a weird changelog for app check on the next release.
Otherwise I agree with Russell's review 👍

cynthiajoan · 2024-05-10T15:31:55Z

More on the app_check part, we can probably remove the changes made to the example App Check app, so we don't get a weird changelog for app check on the next release. Otherwise I agree with Russell's review 👍

removed! Thanks for the review

russellwheatley

I think tests are failing because of the name

packages/firebase_vertexai/firebase_vertexai/example/pubspec.yaml

Co-authored-by: Russell Wheatley <[email protected]>

…nto vertex_ai

russellwheatley

CI failures are unrelated 👍

natebosch · 2024-05-10T22:42:07Z

packages/firebase_vertexai/firebase_vertexai/example/README.md

@@ -0,0 +1,16 @@
+# firebase_vertexai_example
+
+A new Flutter project.


[nit] Update the file with specifics, or consider removing it if it's not useful.

natebosch · 2024-05-10T22:43:33Z

packages/firebase_vertexai/firebase_vertexai/lib/firebase_vertexai.dart

+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+library firebase_vertexai;


[nit] If we don't have a library level doc comment or annotation, we can omit the library line.
We can use URIs for the part of lines.

At some point it would be worth considering a refactor to stop using part and part of, but that can happen out of band.

natebosch · 2024-05-10T22:44:35Z

packages/firebase_vertexai/firebase_vertexai/lib/firebase_vertexai.dart

+    show FirebasePluginPlatform;
+import 'package:google_generative_ai/google_generative_ai.dart' as google_ai;
+// ignore: implementation_imports, tightly coupled packages
+import 'package:google_generative_ai/src/model.dart' as google_ai_model;


Consider updating this import to src/vertex_hooks.dart. We export the model creating method there now so you can import all of the vertex customizations from one place.

natebosch · 2024-05-10T22:46:11Z

packages/firebase_vertexai/firebase_vertexai/lib/src/firebase_vertexai.dart

+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+part of firebase_vertexai;


part of '../firebase_vertexai.dart';

natebosch · 2024-05-10T22:46:32Z

packages/firebase_vertexai/firebase_vertexai/lib/src/firebase_vertexai.dart

+const _defaultLocation = 'us-central1';
+
+/// Default timeout duration, 30 minutes in millisecond
+const int defaultTimeout = 1800000;


Is this intentionally public?

It is not. However it's referenced in the test file, and I'm still learning how to access private attributes in test folder

cynthiajoan added 18 commits March 27, 2024 10:42

init with example working with google ai

8f3091e

working demo for vertex ai

9563d97

remove firebase config files

954f891

Add the image test assets

7799bc2

add FirebaseVertexAI class

2acb329

some code and documentation clean up

4a9b8aa

resolve the version update for generative ai

362880d

rename package name to firebase_vertexai

d31a582

update to product endpoint

563e773

Merge https://github.com/firebase/flutterfire into vertex_ai

974d223

FirebaseAppCheck implementation

88e399c

move the override to separate files

d13d5a3

fix the timeout maxvalue for js

cabcada

unblock compile error

058a397

fix multiple lint issues.

122658e

add function calling and system instruction

f56d8c9

add location option

6ad30c5

Add package info to request header

50df02f

cynthiajoan requested review from russellwheatley and Lyokone May 1, 2024 05:18

cynthiajoan added 7 commits May 6, 2024 15:01

some misc update

115a941

update change

2a2e430

Get license header check pass

1eb2184

Add totalBillableCharacters to CountTokensResponse

760196e

Move location field to service level

399c18d

Merge https://github.com/firebase/flutterfire into vertex_ai

4723d66

fix the compiling problem

e93f2db

cynthiajoan changed the title ~~Draft PR to create new firebase vertex ai plugin.~~ feat: create new Vertex AI for Firebase plugin. May 7, 2024

cynthiajoan added 2 commits May 7, 2024 14:39

Update readme

a1d2fb8

fix the doc name

5a8b080

hopefully last fix for analyzer

427bbfe

cynthiajoan marked this pull request as ready for review May 8, 2024 04:52

cynthiajoan added 3 commits May 8, 2024 13:37

Add unit test for content

dbb1715

remove unused import

231a22c

Update vertexai test

44dc585

russellwheatley requested changes May 9, 2024

View reviewed changes

Update with the code review comments

f7c7a74

cynthiajoan requested review from natebosch and russellwheatley May 9, 2024 18:56

Lyokone reviewed May 10, 2024

View reviewed changes

packages/firebase_vertexai/firebase_vertexai/LICENSE Outdated Show resolved Hide resolved

packages/firebase_vertexai/firebase_vertexai/example/analysis_options.yaml Outdated Show resolved Hide resolved

cynthiajoan added 2 commits May 10, 2024 08:29

more clean up on the review

8efd472

remove app check from the example dependency

5ac8d0d

cynthiajoan requested a review from Lyokone May 10, 2024 15:32

russellwheatley requested changes May 10, 2024

View reviewed changes

packages/firebase_vertexai/firebase_vertexai/example/pubspec.yaml Outdated Show resolved Hide resolved

cynthiajoan and others added 5 commits May 10, 2024 09:02

Update pubspec.yaml

7b8a694

Co-authored-by: Russell Wheatley <[email protected]>

fix analyzer on example

9e442db

Merge branch 'vertex_ai' of https://github.com/firebase/flutterfire i…

2626180

…nto vertex_ai

revert the app_check change in the PR

0145af3

more comma fix for analyzer

0486513

cynthiajoan requested review from russellwheatley and a-maurice May 10, 2024 18:02

russellwheatley approved these changes May 10, 2024

View reviewed changes

a-maurice approved these changes May 10, 2024

View reviewed changes

russellwheatley merged commit abb10ff into master May 10, 2024
20 of 23 checks passed

russellwheatley deleted the vertex_ai branch May 10, 2024 18:15

natebosch reviewed May 10, 2024

View reviewed changes

firebase locked and limited conversation to collaborators Jun 10, 2024

		@@ -0,0 +1,16 @@
		# firebase_vertexai_example

		A new Flutter project.

feat: create new Vertex AI for Firebase plugin. #12728

feat: create new Vertex AI for Firebase plugin. #12728

Uh oh!

Conversation

cynthiajoan commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Breaking Change

Uh oh!

russellwheatley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cynthiajoan commented May 9, 2024

Uh oh!

Uh oh!

Uh oh!

Lyokone commented May 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cynthiajoan commented May 10, 2024

Uh oh!

russellwheatley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

russellwheatley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natebosch May 10, 2024

Choose a reason for hiding this comment

Uh oh!

natebosch May 10, 2024

Choose a reason for hiding this comment

Uh oh!

natebosch May 10, 2024

Choose a reason for hiding this comment

Uh oh!

natebosch May 10, 2024

Choose a reason for hiding this comment

Uh oh!

natebosch May 10, 2024

Choose a reason for hiding this comment

Uh oh!

cynthiajoan May 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cynthiajoan commented May 1, 2024 •

edited

Loading

Lyokone commented May 10, 2024 •

edited

Loading