-
Notifications
You must be signed in to change notification settings - Fork 923
feat(vertexai): Migrate to AI
and add GoogleAI support
#8931
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.
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
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: 41b0385 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (116,370 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
GenAI
and add GoogleAI supportAI
and add GoogleAI support
AI
and add GoogleAI supportAI
and add GoogleAI support
expect(backend.backendType).to.equal(BackendType.VERTEX_AI); | ||
expect(backend.location).to.equal('test-location'); | ||
}); | ||
it('sets custom location even if empty string', () => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we want that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We currently don't do any validation on location passed, so users can pass things like ' '
, 'x'
, etc without getting errors in the SDK or falling back to the default. I believe allowing ''
fits within this approach.
Do you think ''
should be treated the same as null
or undefined
and fallback to the default? I have no preference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess it doesn't really matter either way but I do think it's weird to treat null and empty string differently as both of them have to be put there deliberately and with the empty string we're assuming someone putting it there deliberately does not want the default, while with null, we're assuming they do? If you want null to cause it to be default I think anything falsy should also cause default (so maybe if (!location)
)
* [vertexai] Use json of unary-success-citations The test files have been updated to include `json` extension versions of the tests files. The old, `txt` extension files are deprecated and will be deleted eventually. * Update also the version used in the update script
API: http://goto.google.com/googleai-in-vinf-api (internal)
This PR integrates support for the Google AI API alongside the existing Vertex AI backend. To accommodate this, the SDK has been refactored to use the more generic
AI
naming convention instead ofVertexAI
.Changes
Google AI Support
googleAIBackend()
function to configure the SDK to use the Google AI API. This enables usage with models available in a free tier.googleAIMappers.ts
) to translate requests and responses between the SDK's unified format (prioritizing Vertex AI) and the specific format required by the Google AI API. This handles differences in features like safety settings (method
unsupported), citation metadata (citationSources
vscitations
), and response properties (defaulting missing safety scores).AIError
with codeUNSUPPORTED
or logs warnings for features/properties not available or different in the Google AI backend (e.g.,SafetySetting.method
, roundingtopK
,Part.videoMetadata
).Firebase AI Migration
VertexAI
toAI
(e.g.,AI
,AIError
,AIModel
,AIErrorCode
,AIOptions
).export type VertexAI = AI;
,export const VertexAIError = AIError;
).Backend
(GoogleAIBackend | VertexAIBackend
) andBackendType
types to abstract the backend configuration.Initialization
getAI(app?, options?)
function for initializing the SDK. It acceptsAIOptions
to specify the desiredbackend
.getVertexAI(app?, options?)
function for backward compatibility, initializing a Vertex AI backend instance.Internal
helpers.ts
) for instance identifiers based on backend type and location, allowing the component system to manage different service instances.request.ts
,stream-reader.ts
) to handle backend differences and use the appropriate mappers.Packaging
./ai
export path infirebase/package.json
to allow the package to be imported withfirebase/ai
.Testing
googleAIBackend
,vertexAIBackend
), Google AI request/response mappers, and instance identifier helpers.generateContent
,countTokens
) using the Google AI backend path to verify request mapping and error handling.Sample usage