Add Files API

[hsubox76]

Add file upload API.

• See newly-added /samples/node/file-upload.js for example usage.
• Introduces a top-level GoogleAIFileManager class with 4 methods:
  • uploadFile(fileName, fileMetadata) - metadata has properties mimeType, and optional name and displayName. Returns full File metadata including name, mimeType, created time, etc (invents a random name if not provided)
  • listFiles({ pageSize?: number, pageToken?: number })
  • getFile(filename)
  • deleteFile(filename)

This is a separate class outside of GoogleGenerativeAI and needs to be imported from a subpackage @google/generative-ai/files. The rationale is that this is meant for Node users only, for security reasons. Also it uses fs, which will break web builds. Making it a subpackage helps web users avoid importing this code.

This means that when instantiating GoogleAIFileManager, the user needs to provide the API key to the constructor, even if they've already provided it to GoogleGenerativeAI. These are essentially two separate tools, one for file management, and one for inference and interaction with the model.

The upload content type is multipart, which allows sending JSON metadata as well as the binary blob in the same request. Future improvements may include also offering a resumable upload type (perhaps a separate method). The code for generating the multipart content was taken from the Firebase Storage JS SDK's implementation of multipart upload.

Reference (internal):

• Multipart protocol: https://g3doc.corp.google.com/cloud/storage/g3doc/team/sub_teams/serving/sub_teams/orchestration/sub_teams/api/sub_teams/transporter/scotty/http_protocols.md?cl=head#unified-multipart-protocol
• Separate package for JS explanation: https://docs.google.com/document/d/1_uy4npZjMpxBBKDp-x74uG5KCj028IJBjaCWFHaXw78/edit?tab=t.0
• Files API design doc https://docs.google.com/document/d/1kmIGL_w7b1ADrs36a-uxlXneJSsVOUAQAyWuMvBsY6E/edit?tab=t.0

[changeset-bot]

🦋 Changeset detected

Latest commit: 12332d2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@google/generative-ai	Minor

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

[lahirumaramba]

Thanks Christina! Looks great!
Added a few comments

[lahirumaramba]

nit: Do we want to set the name and the displayName at initialization?

const uploadMetadata: FileMetadata = {
      mimeType: fileMetadata.mimeType,
      displayName:...
    };

[hsubox76]

Done, that is a bit cleaner.

[lahirumaramba]

Thanks! We can now remove line 76, 77. and 78-80, right?

[hsubox76]

Done

[lahirumaramba]

LGTM! Thank you.

[lahirumaramba]

Thanks! We can now remove line 76, 77. and 78-80, right?