feat(firebase-ai): create ai package, vertexai wraps around it
#8555
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| * @param config - The optional config for your firebase app. | ||
| * @returns Promise<FirebaseApp> - The initialized Firebase app. | ||
| */ | ||
| export function initializeApp( |
There was a problem hiding this comment.
Would you be able to point to what causes this to become potentially async?
There was a problem hiding this comment.
It is async: https://github.com/invertase/react-native-firebase/blob/main/packages/app/lib/internal/registry/app.js#L118
which bears out in the docs: https://rnfirebase.io/app/usage
| */ | ||
| export function getAI( | ||
| app: ReactNativeFirebase.FirebaseApp = getApp(), | ||
| options: AIOptions = { backend: new GoogleAIBackend() }, |
There was a problem hiding this comment.
I wonder if we should just remove the default and force the user to provide something? How is the API in the JS SDK?
There was a problem hiding this comment.
this is how it is in firebase-js-sdk: https://github.com/firebase/firebase-js-sdk/blob/main/packages/ai/src/api.ts#L130
| return { | ||
| app, | ||
| backend: options.backend, | ||
| location: (options.backend as VertexAIBackend)?.location || '', |
There was a problem hiding this comment.
Can it fail if it's a GoogleAIBackend? Should it use a parent class?
There was a problem hiding this comment.
It'll just revert to an empty string when GoogleAIBackend. This is for backwards compatibility with VertexAI: https://github.com/invertase/react-native-firebase/blob/firebase-ai/packages/ai/lib/public-types.ts#L132-L136
firebase-js-sdk does the same thing.
| @@ -37,8 +37,9 @@ export default [ | |||
| '**/app.playground.js', | |||
| '**/type-test.ts', | |||
| 'packages/**/modular/dist/**/*', | |||
| 'packages/vertexai/__tests__/test-utils', | |||
| 'packages/ai/__tests__/test-utils', | |||
There was a problem hiding this comment.
The name for the package is set as ai. Is this the correct name, for example would it be firebaseai or firebase_ai. Source
| location: 'us-central1', | ||
| }; | ||
|
|
||
| describe('Top level API', () => { |
There was a problem hiding this comment.
| describe('Top level API', () => { | |
| describe('getGenerativeModel()', () => { |
| }; | ||
|
|
||
| describe('Top level API', () => { | ||
| it('getGenerativeModel throws if no model is provided', () => { |
There was a problem hiding this comment.
| it('getGenerativeModel throws if no model is provided', () => { | |
| it('should throw an error if no model is provided', () => { |
| } | ||
| }); | ||
|
|
||
| it('getGenerativeModel throws if no projectId is provided', () => { |
There was a problem hiding this comment.
| it('getGenerativeModel throws if no projectId is provided', () => { | |
| it('should throw an error if no projectId is provided', () => { |
| } | ||
| }); | ||
|
|
||
| it('getGenerativeModel throws if no appId is provided', () => { |
There was a problem hiding this comment.
| it('getGenerativeModel throws if no appId is provided', () => { | |
| it('should throw an error if no appId is provided', () => { |
| assertAssignable<VertexAI, AI>(); | ||
| }); | ||
|
|
||
| it('AIError is backwards compatible with VertexAIError', function () { |
There was a problem hiding this comment.
| it('AIError is backwards compatible with VertexAIError', function () { | |
| it('should allow VertexAIError to extend AIError, function () { |
| expect(err).toBeInstanceOf(VertexAIError); | ||
| }); | ||
|
|
||
| it('AIErrorCode is backwards compatible with VertexAIErrorCode', () => { |
There was a problem hiding this comment.
| it('AIErrorCode is backwards compatible with VertexAIErrorCode', () => { | |
| it('should allow VertexAIErrorCode to be assignable to AIErrorCode', () => { |
| expect(errCode).toBe(VertexAIErrorCode.ERROR); | ||
| }); | ||
|
|
||
| it('AIModel is backwards compatible with VertexAIModel', () => { |
There was a problem hiding this comment.
| it('AIModel is backwards compatible with VertexAIModel', () => { | |
| it('should allow VertexAIModel to extend AIModel', () => { |
| }); | ||
|
|
||
| describe('backward-compatible functions', () => { | ||
| it('getGenerativeModel', () => { |
There was a problem hiding this comment.
| it('getGenerativeModel', () => { | |
| it('should return a VertexAIModel assignable to AIModel from getGenerativeModel()l', () => { |
| expect(model).toBeInstanceOf(VertexAIModel); | ||
| }); | ||
|
|
||
| describe('backward-compatible functions', () => { |
There was a problem hiding this comment.
| describe('backward-compatible functions', () => { | |
| describe('VertexAI functions', () => { |
Description
aipackage. Kept relevant types invertexaipackage and deprecated them.firebase-js-sdk.vertexaiandgoogleai.dist/so opted to makeaipackage a dependency which I think is a better way of doing it.aiexample app for illustration and tested latestvertexaiandaiimplementations which surfaced a couple of subtle bugs that have been resolved.Important
vertexaifor this pull request.Related issues
Release Summary
Checklist
AndroidiOSOther(macOS, web)e2etests added or updated inpackages/\*\*/e2ejesttests added or updated inpackages/\*\*/__tests__Test Plan
Think
react-native-firebaseis great? Please consider supporting the project with any of the below:React Native FirebaseandInvertaseon Twitter