Add file manager reference docs (#108)

README.md

@@ -90,7 +90,9 @@ These quickstarts describe how to add your API key and the SDK to your app, init
 Find complete documentation for the Google AI SDKs and the Gemini model in the Google documentation:\
 https://ai.google.dev/docs
 
-Find reference docs for this SDK [here in the repo](/docs/reference/main/generative-ai.md).
+Find reference docs for this SDK here in the repo:
+- [GoogleGenerativeAI](/docs/reference/main/generative-ai.md)
+- [GoogleAIFileManager](/docs/reference/files/generative-ai.googleaifilemanager.md)
 
 ## Changelog
 - `@google/generative-ai` - [CHANGELOG.md](/packages/main/CHANGELOG.md)

docs/reference/files/generative-ai.filemetadata.displayname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadata](./generative-ai.filemetadata.md) &gt; [displayName](./generative-ai.filemetadata.displayname.md)
+
+## FileMetadata.displayName property
+
+**Signature:**
+
+```typescript
+displayName?: string;
+```

docs/reference/files/generative-ai.filemetadata.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadata](./generative-ai.filemetadata.md)
+
+## FileMetadata interface
+
+Metadata to provide alongside a file upload
+
+**Signature:**
+
+```typescript
+export interface FileMetadata 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [displayName?](./generative-ai.filemetadata.displayname.md) |  | string | _(Optional)_ |
+|  [mimeType](./generative-ai.filemetadata.mimetype.md) |  | string |  |
+|  [name?](./generative-ai.filemetadata.name.md) |  | string | _(Optional)_ |
+

docs/reference/files/generative-ai.filemetadata.mimetype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadata](./generative-ai.filemetadata.md) &gt; [mimeType](./generative-ai.filemetadata.mimetype.md)
+
+## FileMetadata.mimeType property
+
+**Signature:**
+
+```typescript
+mimeType: string;
+```

docs/reference/files/generative-ai.filemetadata.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadata](./generative-ai.filemetadata.md) &gt; [name](./generative-ai.filemetadata.name.md)
+
+## FileMetadata.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.createtime.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [createTime](./generative-ai.filemetadataresponse.createtime.md)
+
+## FileMetadataResponse.createTime property
+
+**Signature:**
+
+```typescript
+createTime: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.displayname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [displayName](./generative-ai.filemetadataresponse.displayname.md)
+
+## FileMetadataResponse.displayName property
+
+**Signature:**
+
+```typescript
+displayName?: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md)
+
+## FileMetadataResponse.expirationTime property
+
+**Signature:**
+
+```typescript
+expirationTime: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md)
+
+## FileMetadataResponse interface
+
+File metadata response from server.
+
+**Signature:**
+
+```typescript
+export interface FileMetadataResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [createTime](./generative-ai.filemetadataresponse.createtime.md) |  | string |  |
+|  [displayName?](./generative-ai.filemetadataresponse.displayname.md) |  | string | _(Optional)_ |
+|  [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md) |  | string |  |
+|  [mimeType](./generative-ai.filemetadataresponse.mimetype.md) |  | string |  |
+|  [name](./generative-ai.filemetadataresponse.name.md) |  | string |  |
+|  [sha256Hash](./generative-ai.filemetadataresponse.sha256hash.md) |  | string |  |
+|  [sizeBytes](./generative-ai.filemetadataresponse.sizebytes.md) |  | string |  |
+|  [updateTime](./generative-ai.filemetadataresponse.updatetime.md) |  | string |  |
+|  [uri](./generative-ai.filemetadataresponse.uri.md) |  | string |  |
+

docs/reference/files/generative-ai.filemetadataresponse.mimetype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [mimeType](./generative-ai.filemetadataresponse.mimetype.md)
+
+## FileMetadataResponse.mimeType property
+
+**Signature:**
+
+```typescript
+mimeType: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [name](./generative-ai.filemetadataresponse.name.md)
+
+## FileMetadataResponse.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [sha256Hash](./generative-ai.filemetadataresponse.sha256hash.md)
+
+## FileMetadataResponse.sha256Hash property
+
+**Signature:**
+
+```typescript
+sha256Hash: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [sizeBytes](./generative-ai.filemetadataresponse.sizebytes.md)
+
+## FileMetadataResponse.sizeBytes property
+
+**Signature:**
+
+```typescript
+sizeBytes: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.updatetime.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [updateTime](./generative-ai.filemetadataresponse.updatetime.md)
+
+## FileMetadataResponse.updateTime property
+
+**Signature:**
+
+```typescript
+updateTime: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.uri.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [uri](./generative-ai.filemetadataresponse.uri.md)
+
+## FileMetadataResponse.uri property
+
+**Signature:**
+
+```typescript
+uri: string;
+```

docs/reference/files/generative-ai.googleaifilemanager._constructor_.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [(constructor)](./generative-ai.googleaifilemanager._constructor_.md)
+
+## GoogleAIFileManager.(constructor)
+
+Constructs a new instance of the `GoogleAIFileManager` class
+
+**Signature:**
+
+```typescript
+constructor(apiKey: string, _requestOptions?: RequestOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  apiKey | string |  |
+|  \_requestOptions | [RequestOptions](./generative-ai.requestoptions.md) | _(Optional)_ |
+

docs/reference/files/generative-ai.googleaifilemanager.apikey.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [apiKey](./generative-ai.googleaifilemanager.apikey.md)
+
+## GoogleAIFileManager.apiKey property
+
+**Signature:**
+
+```typescript
+apiKey: string;
+```

docs/reference/files/generative-ai.googleaifilemanager.deletefile.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [deleteFile](./generative-ai.googleaifilemanager.deletefile.md)
+
+## GoogleAIFileManager.deleteFile() method
+
+Delete file with given ID
+
+**Signature:**
+
+```typescript
+deleteFile(fileId: string): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fileId | string |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

docs/reference/files/generative-ai.googleaifilemanager.getfile.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [getFile](./generative-ai.googleaifilemanager.getfile.md)
+
+## GoogleAIFileManager.getFile() method
+
+Get metadata for file with given ID
+
+**Signature:**
+
+```typescript
+getFile(fileId: string): Promise<FileMetadataResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fileId | string |  |
+
+**Returns:**
+
+Promise&lt;[FileMetadataResponse](./generative-ai.filemetadataresponse.md)<!-- -->&gt;
+

docs/reference/files/generative-ai.googleaifilemanager.listfiles.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [listFiles](./generative-ai.googleaifilemanager.listfiles.md)
+
+## GoogleAIFileManager.listFiles() method
+
+List all uploaded files
+
+**Signature:**
+
+```typescript
+listFiles(listParams?: ListParams): Promise<ListFilesResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listParams | [ListParams](./generative-ai.listparams.md) | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;[ListFilesResponse](./generative-ai.listfilesresponse.md)<!-- -->&gt;
+

docs/reference/files/generative-ai.googleaifilemanager.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md)
+
+## GoogleAIFileManager class
+
+Class for managing GoogleAI file uploads.
+
+**Signature:**
+
+```typescript
+export declare class GoogleAIFileManager 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(apiKey, \_requestOptions)](./generative-ai.googleaifilemanager._constructor_.md) |  | Constructs a new instance of the <code>GoogleAIFileManager</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apiKey](./generative-ai.googleaifilemanager.apikey.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [deleteFile(fileId)](./generative-ai.googleaifilemanager.deletefile.md) |  | Delete file with given ID |
+|  [getFile(fileId)](./generative-ai.googleaifilemanager.getfile.md) |  | Get metadata for file with given ID |
+|  [listFiles(listParams)](./generative-ai.googleaifilemanager.listfiles.md) |  | List all uploaded files |
+|  [uploadFile(filePath, fileMetadata)](./generative-ai.googleaifilemanager.uploadfile.md) |  | Upload a file |
+

docs/reference/files/generative-ai.googleaifilemanager.uploadfile.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) &gt; [uploadFile](./generative-ai.googleaifilemanager.uploadfile.md)
+
+## GoogleAIFileManager.uploadFile() method
+
+Upload a file
+
+**Signature:**
+
+```typescript
+uploadFile(filePath: string, fileMetadata: FileMetadata): Promise<UploadFileResponse>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filePath | string |  |
+|  fileMetadata | [FileMetadata](./generative-ai.filemetadata.md) |  |
+
+**Returns:**
+
+Promise&lt;[UploadFileResponse](./generative-ai.uploadfileresponse.md)<!-- -->&gt;
+

docs/reference/files/generative-ai.listfilesresponse.files.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ListFilesResponse](./generative-ai.listfilesresponse.md) &gt; [files](./generative-ai.listfilesresponse.files.md)
+
+## ListFilesResponse.files property
+
+**Signature:**
+
+```typescript
+files: FileMetadataResponse[];
+```