Class Files

Hierarchy

BaseModule
- Files

Index

Constructors

Methods

delete download get list upload

Constructors

Image for: Constructors

constructor

new Files(apiClient: ApiClient): Files
Parameters
- apiClient: ApiClient
Returns Files
Overrides BaseModule.constructor
- Defined in files.ts:17

Methods

Image for: Methods

delete

delete(params: DeleteFileParameters): Promise<DeleteFileResponse>
Deletes a remotely stored file.
Parameters
- params: DeleteFileParameters
  The parameters for the delete request.
Returns Promise<DeleteFileResponse>
The DeleteFileResponse, the response for the delete method.
Example
The following code deletes an example file named "files/mehozpxf877d".
```
await ai.files.delete({name: file.name});
```
- Defined in files.ts:288

download

download(params: DownloadFileParameters): Promise<void>
Downloads a remotely stored file asynchronously to a location specified in the params object. This method only works on Node environment, to download files in the browser, use a browser compliant method like an tag.
Parameters
- params: DownloadFileParameters
  The parameters for the download request.
Returns Promise<void>
Example
The following code downloads an example file named "files/mehozpxf877d" as "file.txt".
```
await ai.files.download({file: file.name, downloadPath: 'file.txt'});
```
- Defined in files.ts:124

get

get(params: GetFileParameters): Promise<File>
Retrieves the file information from the service.
Parameters
- params: GetFileParameters
  The parameters for the get request
Returns Promise<File>
The Promise that resolves to the types.File object requested.
Example
```
const config: GetFileParameters = {
  name: fileName,
};
file = await ai.files.get(config);
console.log(file.name);
```
- Defined in files.ts:235

list

list(params?: ListFilesParameters): Promise<Pager<File>>
Lists all current project files from the service.
Parameters
- params: ListFilesParameters = {}
  The parameters for the list request
Returns Promise<Pager<File>>
The paginated results of the list of files
Example
The following code prints the names of all files from the service, the size of each page is 10.
```
const listResponse = await ai.files.list({config: {'pageSize': 10}});
for await (const file of listResponse) {
  console.log(file.name);
}
```
- Defined in files.ts:38

upload

upload(params: UploadFileParameters): Promise<File>
Uploads a file asynchronously to the Gemini API. This method is not available in Vertex AI. Supported upload sources:
- Node.js: File path (string) or Blob object.
- Browser: Blob object (e.g., File).
Parameters
- params: UploadFileParameters
  Optional parameters specified in the types.UploadFileParameters interface.
Returns Promise<File>
A promise that resolves to a types.File object.
Remarks
The mimeType can be specified in the config parameter. If omitted:
- For file path (string) inputs, the mimeType will be inferred from the file extension.
- For Blob object inputs, the mimeType will be set to the Blob's type property. Somex eamples for file extension to mimeType mapping: .txt -> text/plain .json -> application/json .jpg -> image/jpeg .png -> image/png .mp3 -> audio/mpeg .mp4 -> video/mp4
This section can contain multiple paragraphs and code examples.
See
types.UploadFileParameters#config for the optional config in the parameters.

Throws
An error if called on a Vertex AI client.

Throws
An error if the mimeType is not provided and can not be inferred, the mimeType can be provided in the params.config parameter.

Throws
An error occurs if a suitable upload location cannot be established.
Example
The following code uploads a file to Gemini API.
```
const file = await ai.files.upload({file: 'file.txt', config: {
  mimeType: 'text/plain',
}});
console.log(file.name);
```
- Defined in files.ts:92