diff --git a/README.md b/README.md index f4a2db9d..54f7d46e 100644 --- a/README.md +++ b/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) diff --git a/docs/reference/files/generative-ai.filemetadata.displayname.md b/docs/reference/files/generative-ai.filemetadata.displayname.md new file mode 100644 index 00000000..c3c30c01 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadata.displayname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [displayName](./generative-ai.filemetadata.displayname.md) + +## FileMetadata.displayName property + +**Signature:** + +```typescript +displayName?: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadata.md b/docs/reference/files/generative-ai.filemetadata.md new file mode 100644 index 00000000..1a0ae553 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadata.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [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)_ | + diff --git a/docs/reference/files/generative-ai.filemetadata.mimetype.md b/docs/reference/files/generative-ai.filemetadata.mimetype.md new file mode 100644 index 00000000..b5e104b6 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadata.mimetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [mimeType](./generative-ai.filemetadata.mimetype.md) + +## FileMetadata.mimeType property + +**Signature:** + +```typescript +mimeType: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadata.name.md b/docs/reference/files/generative-ai.filemetadata.name.md new file mode 100644 index 00000000..7b9a8f57 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadata.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadata](./generative-ai.filemetadata.md) > [name](./generative-ai.filemetadata.name.md) + +## FileMetadata.name property + +**Signature:** + +```typescript +name?: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.createtime.md b/docs/reference/files/generative-ai.filemetadataresponse.createtime.md new file mode 100644 index 00000000..69676d20 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.createtime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [createTime](./generative-ai.filemetadataresponse.createtime.md) + +## FileMetadataResponse.createTime property + +**Signature:** + +```typescript +createTime: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.displayname.md b/docs/reference/files/generative-ai.filemetadataresponse.displayname.md new file mode 100644 index 00000000..c7229302 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.displayname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [displayName](./generative-ai.filemetadataresponse.displayname.md) + +## FileMetadataResponse.displayName property + +**Signature:** + +```typescript +displayName?: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md b/docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md new file mode 100644 index 00000000..38c8c246 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.expirationtime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md) + +## FileMetadataResponse.expirationTime property + +**Signature:** + +```typescript +expirationTime: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.md b/docs/reference/files/generative-ai.filemetadataresponse.md new file mode 100644 index 00000000..68625069 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [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 | | + diff --git a/docs/reference/files/generative-ai.filemetadataresponse.mimetype.md b/docs/reference/files/generative-ai.filemetadataresponse.mimetype.md new file mode 100644 index 00000000..8e46260c --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.mimetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [mimeType](./generative-ai.filemetadataresponse.mimetype.md) + +## FileMetadataResponse.mimeType property + +**Signature:** + +```typescript +mimeType: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.name.md b/docs/reference/files/generative-ai.filemetadataresponse.name.md new file mode 100644 index 00000000..52e90945 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [name](./generative-ai.filemetadataresponse.name.md) + +## FileMetadataResponse.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md b/docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md new file mode 100644 index 00000000..0dacfc22 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.sha256hash.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sha256Hash](./generative-ai.filemetadataresponse.sha256hash.md) + +## FileMetadataResponse.sha256Hash property + +**Signature:** + +```typescript +sha256Hash: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md b/docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md new file mode 100644 index 00000000..82bf6635 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.sizebytes.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [sizeBytes](./generative-ai.filemetadataresponse.sizebytes.md) + +## FileMetadataResponse.sizeBytes property + +**Signature:** + +```typescript +sizeBytes: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.updatetime.md b/docs/reference/files/generative-ai.filemetadataresponse.updatetime.md new file mode 100644 index 00000000..8037d571 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.updatetime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [updateTime](./generative-ai.filemetadataresponse.updatetime.md) + +## FileMetadataResponse.updateTime property + +**Signature:** + +```typescript +updateTime: string; +``` diff --git a/docs/reference/files/generative-ai.filemetadataresponse.uri.md b/docs/reference/files/generative-ai.filemetadataresponse.uri.md new file mode 100644 index 00000000..c7668720 --- /dev/null +++ b/docs/reference/files/generative-ai.filemetadataresponse.uri.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [uri](./generative-ai.filemetadataresponse.uri.md) + +## FileMetadataResponse.uri property + +**Signature:** + +```typescript +uri: string; +``` diff --git a/docs/reference/files/generative-ai.googleaifilemanager._constructor_.md b/docs/reference/files/generative-ai.googleaifilemanager._constructor_.md new file mode 100644 index 00000000..5c49872e --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager._constructor_.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [(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)_ | + diff --git a/docs/reference/files/generative-ai.googleaifilemanager.apikey.md b/docs/reference/files/generative-ai.googleaifilemanager.apikey.md new file mode 100644 index 00000000..78091bb5 --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.apikey.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [apiKey](./generative-ai.googleaifilemanager.apikey.md) + +## GoogleAIFileManager.apiKey property + +**Signature:** + +```typescript +apiKey: string; +``` diff --git a/docs/reference/files/generative-ai.googleaifilemanager.deletefile.md b/docs/reference/files/generative-ai.googleaifilemanager.deletefile.md new file mode 100644 index 00000000..e5ecfdad --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.deletefile.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [deleteFile](./generative-ai.googleaifilemanager.deletefile.md) + +## GoogleAIFileManager.deleteFile() method + +Delete file with given ID + +**Signature:** + +```typescript +deleteFile(fileId: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileId | string | | + +**Returns:** + +Promise<void> + diff --git a/docs/reference/files/generative-ai.googleaifilemanager.getfile.md b/docs/reference/files/generative-ai.googleaifilemanager.getfile.md new file mode 100644 index 00000000..613d6b6c --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.getfile.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [getFile](./generative-ai.googleaifilemanager.getfile.md) + +## GoogleAIFileManager.getFile() method + +Get metadata for file with given ID + +**Signature:** + +```typescript +getFile(fileId: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileId | string | | + +**Returns:** + +Promise<[FileMetadataResponse](./generative-ai.filemetadataresponse.md)> + diff --git a/docs/reference/files/generative-ai.googleaifilemanager.listfiles.md b/docs/reference/files/generative-ai.googleaifilemanager.listfiles.md new file mode 100644 index 00000000..ef116fb6 --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.listfiles.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [listFiles](./generative-ai.googleaifilemanager.listfiles.md) + +## GoogleAIFileManager.listFiles() method + +List all uploaded files + +**Signature:** + +```typescript +listFiles(listParams?: ListParams): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| listParams | [ListParams](./generative-ai.listparams.md) | _(Optional)_ | + +**Returns:** + +Promise<[ListFilesResponse](./generative-ai.listfilesresponse.md)> + diff --git a/docs/reference/files/generative-ai.googleaifilemanager.md b/docs/reference/files/generative-ai.googleaifilemanager.md new file mode 100644 index 00000000..655c8d0c --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [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 GoogleAIFileManager 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 | + diff --git a/docs/reference/files/generative-ai.googleaifilemanager.uploadfile.md b/docs/reference/files/generative-ai.googleaifilemanager.uploadfile.md new file mode 100644 index 00000000..90648e90 --- /dev/null +++ b/docs/reference/files/generative-ai.googleaifilemanager.uploadfile.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) > [uploadFile](./generative-ai.googleaifilemanager.uploadfile.md) + +## GoogleAIFileManager.uploadFile() method + +Upload a file + +**Signature:** + +```typescript +uploadFile(filePath: string, fileMetadata: FileMetadata): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | | +| fileMetadata | [FileMetadata](./generative-ai.filemetadata.md) | | + +**Returns:** + +Promise<[UploadFileResponse](./generative-ai.uploadfileresponse.md)> + diff --git a/docs/reference/files/generative-ai.listfilesresponse.files.md b/docs/reference/files/generative-ai.listfilesresponse.files.md new file mode 100644 index 00000000..3760979f --- /dev/null +++ b/docs/reference/files/generative-ai.listfilesresponse.files.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [files](./generative-ai.listfilesresponse.files.md) + +## ListFilesResponse.files property + +**Signature:** + +```typescript +files: FileMetadataResponse[]; +``` diff --git a/docs/reference/files/generative-ai.listfilesresponse.md b/docs/reference/files/generative-ai.listfilesresponse.md new file mode 100644 index 00000000..eb90d5a6 --- /dev/null +++ b/docs/reference/files/generative-ai.listfilesresponse.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) + +## ListFilesResponse interface + +Response from calling [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) + +**Signature:** + +```typescript +export interface ListFilesResponse +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [files](./generative-ai.listfilesresponse.files.md) | | [FileMetadataResponse](./generative-ai.filemetadataresponse.md)\[\] | | +| [nextPageToken?](./generative-ai.listfilesresponse.nextpagetoken.md) | | string | _(Optional)_ | + diff --git a/docs/reference/files/generative-ai.listfilesresponse.nextpagetoken.md b/docs/reference/files/generative-ai.listfilesresponse.nextpagetoken.md new file mode 100644 index 00000000..bc906aab --- /dev/null +++ b/docs/reference/files/generative-ai.listfilesresponse.nextpagetoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListFilesResponse](./generative-ai.listfilesresponse.md) > [nextPageToken](./generative-ai.listfilesresponse.nextpagetoken.md) + +## ListFilesResponse.nextPageToken property + +**Signature:** + +```typescript +nextPageToken?: string; +``` diff --git a/docs/reference/files/generative-ai.listparams.md b/docs/reference/files/generative-ai.listparams.md new file mode 100644 index 00000000..c3ab7efc --- /dev/null +++ b/docs/reference/files/generative-ai.listparams.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) + +## ListParams interface + +Params to pass to [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) + +**Signature:** + +```typescript +export interface ListParams +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [pageSize?](./generative-ai.listparams.pagesize.md) | | number | _(Optional)_ | +| [pageToken?](./generative-ai.listparams.pagetoken.md) | | string | _(Optional)_ | + diff --git a/docs/reference/files/generative-ai.listparams.pagesize.md b/docs/reference/files/generative-ai.listparams.pagesize.md new file mode 100644 index 00000000..a5fbfbff --- /dev/null +++ b/docs/reference/files/generative-ai.listparams.pagesize.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageSize](./generative-ai.listparams.pagesize.md) + +## ListParams.pageSize property + +**Signature:** + +```typescript +pageSize?: number; +``` diff --git a/docs/reference/files/generative-ai.listparams.pagetoken.md b/docs/reference/files/generative-ai.listparams.pagetoken.md new file mode 100644 index 00000000..374ad9ef --- /dev/null +++ b/docs/reference/files/generative-ai.listparams.pagetoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ListParams](./generative-ai.listparams.md) > [pageToken](./generative-ai.listparams.pagetoken.md) + +## ListParams.pageToken property + +**Signature:** + +```typescript +pageToken?: string; +``` diff --git a/docs/reference/files/generative-ai.md b/docs/reference/files/generative-ai.md new file mode 100644 index 00000000..0daf824f --- /dev/null +++ b/docs/reference/files/generative-ai.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) + +## generative-ai package + +## Classes + +| Class | Description | +| --- | --- | +| [GoogleAIFileManager](./generative-ai.googleaifilemanager.md) | Class for managing GoogleAI file uploads. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [FileMetadata](./generative-ai.filemetadata.md) | Metadata to provide alongside a file upload | +| [FileMetadataResponse](./generative-ai.filemetadataresponse.md) | File metadata response from server. | +| [ListFilesResponse](./generative-ai.listfilesresponse.md) | Response from calling [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) | +| [ListParams](./generative-ai.listparams.md) | Params to pass to [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) | +| [RequestOptions](./generative-ai.requestoptions.md) | Params passed to getGenerativeModel() or GoogleAIFileManager(). | +| [UploadFileResponse](./generative-ai.uploadfileresponse.md) | Response from calling [GoogleAIFileManager.uploadFile()](./generative-ai.googleaifilemanager.uploadfile.md) | + diff --git a/docs/reference/generative-ai.requestoptions.apiclient.md b/docs/reference/files/generative-ai.requestoptions.apiclient.md similarity index 100% rename from docs/reference/generative-ai.requestoptions.apiclient.md rename to docs/reference/files/generative-ai.requestoptions.apiclient.md diff --git a/docs/reference/generative-ai.requestoptions.apiversion.md b/docs/reference/files/generative-ai.requestoptions.apiversion.md similarity index 100% rename from docs/reference/generative-ai.requestoptions.apiversion.md rename to docs/reference/files/generative-ai.requestoptions.apiversion.md diff --git a/docs/reference/generative-ai.requestoptions.baseurl.md b/docs/reference/files/generative-ai.requestoptions.baseurl.md similarity index 100% rename from docs/reference/generative-ai.requestoptions.baseurl.md rename to docs/reference/files/generative-ai.requestoptions.baseurl.md diff --git a/docs/reference/generative-ai.requestoptions.md b/docs/reference/files/generative-ai.requestoptions.md similarity index 87% rename from docs/reference/generative-ai.requestoptions.md rename to docs/reference/files/generative-ai.requestoptions.md index 8bd86b90..7809e3a0 100644 --- a/docs/reference/generative-ai.requestoptions.md +++ b/docs/reference/files/generative-ai.requestoptions.md @@ -4,7 +4,7 @@ ## RequestOptions interface -Params passed to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md). +Params passed to getGenerativeModel() or GoogleAIFileManager(). **Signature:** diff --git a/docs/reference/generative-ai.requestoptions.timeout.md b/docs/reference/files/generative-ai.requestoptions.timeout.md similarity index 100% rename from docs/reference/generative-ai.requestoptions.timeout.md rename to docs/reference/files/generative-ai.requestoptions.timeout.md diff --git a/docs/reference/files/generative-ai.uploadfileresponse.file.md b/docs/reference/files/generative-ai.uploadfileresponse.file.md new file mode 100644 index 00000000..faf5574b --- /dev/null +++ b/docs/reference/files/generative-ai.uploadfileresponse.file.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UploadFileResponse](./generative-ai.uploadfileresponse.md) > [file](./generative-ai.uploadfileresponse.file.md) + +## UploadFileResponse.file property + +**Signature:** + +```typescript +file: FileMetadataResponse; +``` diff --git a/docs/reference/files/generative-ai.uploadfileresponse.md b/docs/reference/files/generative-ai.uploadfileresponse.md new file mode 100644 index 00000000..3c2a055c --- /dev/null +++ b/docs/reference/files/generative-ai.uploadfileresponse.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [UploadFileResponse](./generative-ai.uploadfileresponse.md) + +## UploadFileResponse interface + +Response from calling [GoogleAIFileManager.uploadFile()](./generative-ai.googleaifilemanager.uploadfile.md) + +**Signature:** + +```typescript +export interface UploadFileResponse +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [file](./generative-ai.uploadfileresponse.file.md) | | [FileMetadataResponse](./generative-ai.filemetadataresponse.md) | | + diff --git a/docs/reference/index.md b/docs/reference/files/index.md similarity index 100% rename from docs/reference/index.md rename to docs/reference/files/index.md diff --git a/docs/reference/generative-ai.baseparams.generationconfig.md b/docs/reference/main/generative-ai.baseparams.generationconfig.md similarity index 100% rename from docs/reference/generative-ai.baseparams.generationconfig.md rename to docs/reference/main/generative-ai.baseparams.generationconfig.md diff --git a/docs/reference/generative-ai.baseparams.md b/docs/reference/main/generative-ai.baseparams.md similarity index 100% rename from docs/reference/generative-ai.baseparams.md rename to docs/reference/main/generative-ai.baseparams.md diff --git a/docs/reference/generative-ai.baseparams.safetysettings.md b/docs/reference/main/generative-ai.baseparams.safetysettings.md similarity index 100% rename from docs/reference/generative-ai.baseparams.safetysettings.md rename to docs/reference/main/generative-ai.baseparams.safetysettings.md diff --git a/docs/reference/generative-ai.batchembedcontentsrequest.md b/docs/reference/main/generative-ai.batchembedcontentsrequest.md similarity index 100% rename from docs/reference/generative-ai.batchembedcontentsrequest.md rename to docs/reference/main/generative-ai.batchembedcontentsrequest.md diff --git a/docs/reference/generative-ai.batchembedcontentsrequest.requests.md b/docs/reference/main/generative-ai.batchembedcontentsrequest.requests.md similarity index 100% rename from docs/reference/generative-ai.batchembedcontentsrequest.requests.md rename to docs/reference/main/generative-ai.batchembedcontentsrequest.requests.md diff --git a/docs/reference/generative-ai.batchembedcontentsresponse.embeddings.md b/docs/reference/main/generative-ai.batchembedcontentsresponse.embeddings.md similarity index 100% rename from docs/reference/generative-ai.batchembedcontentsresponse.embeddings.md rename to docs/reference/main/generative-ai.batchembedcontentsresponse.embeddings.md diff --git a/docs/reference/generative-ai.batchembedcontentsresponse.md b/docs/reference/main/generative-ai.batchembedcontentsresponse.md similarity index 100% rename from docs/reference/generative-ai.batchembedcontentsresponse.md rename to docs/reference/main/generative-ai.batchembedcontentsresponse.md diff --git a/docs/reference/generative-ai.blockreason.md b/docs/reference/main/generative-ai.blockreason.md similarity index 100% rename from docs/reference/generative-ai.blockreason.md rename to docs/reference/main/generative-ai.blockreason.md diff --git a/docs/reference/generative-ai.chatsession._constructor_.md b/docs/reference/main/generative-ai.chatsession._constructor_.md similarity index 100% rename from docs/reference/generative-ai.chatsession._constructor_.md rename to docs/reference/main/generative-ai.chatsession._constructor_.md diff --git a/docs/reference/generative-ai.chatsession.gethistory.md b/docs/reference/main/generative-ai.chatsession.gethistory.md similarity index 100% rename from docs/reference/generative-ai.chatsession.gethistory.md rename to docs/reference/main/generative-ai.chatsession.gethistory.md diff --git a/docs/reference/generative-ai.chatsession.md b/docs/reference/main/generative-ai.chatsession.md similarity index 100% rename from docs/reference/generative-ai.chatsession.md rename to docs/reference/main/generative-ai.chatsession.md diff --git a/docs/reference/generative-ai.chatsession.model.md b/docs/reference/main/generative-ai.chatsession.model.md similarity index 100% rename from docs/reference/generative-ai.chatsession.model.md rename to docs/reference/main/generative-ai.chatsession.model.md diff --git a/docs/reference/generative-ai.chatsession.params.md b/docs/reference/main/generative-ai.chatsession.params.md similarity index 100% rename from docs/reference/generative-ai.chatsession.params.md rename to docs/reference/main/generative-ai.chatsession.params.md diff --git a/docs/reference/generative-ai.chatsession.requestoptions.md b/docs/reference/main/generative-ai.chatsession.requestoptions.md similarity index 100% rename from docs/reference/generative-ai.chatsession.requestoptions.md rename to docs/reference/main/generative-ai.chatsession.requestoptions.md diff --git a/docs/reference/generative-ai.chatsession.sendmessage.md b/docs/reference/main/generative-ai.chatsession.sendmessage.md similarity index 100% rename from docs/reference/generative-ai.chatsession.sendmessage.md rename to docs/reference/main/generative-ai.chatsession.sendmessage.md diff --git a/docs/reference/generative-ai.chatsession.sendmessagestream.md b/docs/reference/main/generative-ai.chatsession.sendmessagestream.md similarity index 100% rename from docs/reference/generative-ai.chatsession.sendmessagestream.md rename to docs/reference/main/generative-ai.chatsession.sendmessagestream.md diff --git a/docs/reference/generative-ai.citationmetadata.citationsources.md b/docs/reference/main/generative-ai.citationmetadata.citationsources.md similarity index 100% rename from docs/reference/generative-ai.citationmetadata.citationsources.md rename to docs/reference/main/generative-ai.citationmetadata.citationsources.md diff --git a/docs/reference/generative-ai.citationmetadata.md b/docs/reference/main/generative-ai.citationmetadata.md similarity index 100% rename from docs/reference/generative-ai.citationmetadata.md rename to docs/reference/main/generative-ai.citationmetadata.md diff --git a/docs/reference/generative-ai.citationsource.endindex.md b/docs/reference/main/generative-ai.citationsource.endindex.md similarity index 100% rename from docs/reference/generative-ai.citationsource.endindex.md rename to docs/reference/main/generative-ai.citationsource.endindex.md diff --git a/docs/reference/generative-ai.citationsource.license.md b/docs/reference/main/generative-ai.citationsource.license.md similarity index 100% rename from docs/reference/generative-ai.citationsource.license.md rename to docs/reference/main/generative-ai.citationsource.license.md diff --git a/docs/reference/generative-ai.citationsource.md b/docs/reference/main/generative-ai.citationsource.md similarity index 100% rename from docs/reference/generative-ai.citationsource.md rename to docs/reference/main/generative-ai.citationsource.md diff --git a/docs/reference/generative-ai.citationsource.startindex.md b/docs/reference/main/generative-ai.citationsource.startindex.md similarity index 100% rename from docs/reference/generative-ai.citationsource.startindex.md rename to docs/reference/main/generative-ai.citationsource.startindex.md diff --git a/docs/reference/generative-ai.citationsource.uri.md b/docs/reference/main/generative-ai.citationsource.uri.md similarity index 100% rename from docs/reference/generative-ai.citationsource.uri.md rename to docs/reference/main/generative-ai.citationsource.uri.md diff --git a/docs/reference/generative-ai.content.md b/docs/reference/main/generative-ai.content.md similarity index 100% rename from docs/reference/generative-ai.content.md rename to docs/reference/main/generative-ai.content.md diff --git a/docs/reference/generative-ai.content.parts.md b/docs/reference/main/generative-ai.content.parts.md similarity index 100% rename from docs/reference/generative-ai.content.parts.md rename to docs/reference/main/generative-ai.content.parts.md diff --git a/docs/reference/generative-ai.content.role.md b/docs/reference/main/generative-ai.content.role.md similarity index 100% rename from docs/reference/generative-ai.content.role.md rename to docs/reference/main/generative-ai.content.role.md diff --git a/docs/reference/generative-ai.contentembedding.md b/docs/reference/main/generative-ai.contentembedding.md similarity index 100% rename from docs/reference/generative-ai.contentembedding.md rename to docs/reference/main/generative-ai.contentembedding.md diff --git a/docs/reference/generative-ai.contentembedding.values.md b/docs/reference/main/generative-ai.contentembedding.values.md similarity index 100% rename from docs/reference/generative-ai.contentembedding.values.md rename to docs/reference/main/generative-ai.contentembedding.values.md diff --git a/docs/reference/generative-ai.counttokensrequest.contents.md b/docs/reference/main/generative-ai.counttokensrequest.contents.md similarity index 100% rename from docs/reference/generative-ai.counttokensrequest.contents.md rename to docs/reference/main/generative-ai.counttokensrequest.contents.md diff --git a/docs/reference/generative-ai.counttokensrequest.md b/docs/reference/main/generative-ai.counttokensrequest.md similarity index 100% rename from docs/reference/generative-ai.counttokensrequest.md rename to docs/reference/main/generative-ai.counttokensrequest.md diff --git a/docs/reference/generative-ai.counttokensresponse.md b/docs/reference/main/generative-ai.counttokensresponse.md similarity index 100% rename from docs/reference/generative-ai.counttokensresponse.md rename to docs/reference/main/generative-ai.counttokensresponse.md diff --git a/docs/reference/generative-ai.counttokensresponse.totaltokens.md b/docs/reference/main/generative-ai.counttokensresponse.totaltokens.md similarity index 100% rename from docs/reference/generative-ai.counttokensresponse.totaltokens.md rename to docs/reference/main/generative-ai.counttokensresponse.totaltokens.md diff --git a/docs/reference/generative-ai.embedcontentrequest.content.md b/docs/reference/main/generative-ai.embedcontentrequest.content.md similarity index 100% rename from docs/reference/generative-ai.embedcontentrequest.content.md rename to docs/reference/main/generative-ai.embedcontentrequest.content.md diff --git a/docs/reference/generative-ai.embedcontentrequest.md b/docs/reference/main/generative-ai.embedcontentrequest.md similarity index 100% rename from docs/reference/generative-ai.embedcontentrequest.md rename to docs/reference/main/generative-ai.embedcontentrequest.md diff --git a/docs/reference/generative-ai.embedcontentrequest.tasktype.md b/docs/reference/main/generative-ai.embedcontentrequest.tasktype.md similarity index 100% rename from docs/reference/generative-ai.embedcontentrequest.tasktype.md rename to docs/reference/main/generative-ai.embedcontentrequest.tasktype.md diff --git a/docs/reference/generative-ai.embedcontentrequest.title.md b/docs/reference/main/generative-ai.embedcontentrequest.title.md similarity index 100% rename from docs/reference/generative-ai.embedcontentrequest.title.md rename to docs/reference/main/generative-ai.embedcontentrequest.title.md diff --git a/docs/reference/generative-ai.embedcontentresponse.embedding.md b/docs/reference/main/generative-ai.embedcontentresponse.embedding.md similarity index 100% rename from docs/reference/generative-ai.embedcontentresponse.embedding.md rename to docs/reference/main/generative-ai.embedcontentresponse.embedding.md diff --git a/docs/reference/generative-ai.embedcontentresponse.md b/docs/reference/main/generative-ai.embedcontentresponse.md similarity index 100% rename from docs/reference/generative-ai.embedcontentresponse.md rename to docs/reference/main/generative-ai.embedcontentresponse.md diff --git a/docs/reference/generative-ai.enhancedgeneratecontentresponse.functioncall.md b/docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncall.md similarity index 91% rename from docs/reference/generative-ai.enhancedgeneratecontentresponse.functioncall.md rename to docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncall.md index f6cc24c5..98bbcc69 100644 --- a/docs/reference/generative-ai.enhancedgeneratecontentresponse.functioncall.md +++ b/docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncall.md @@ -6,6 +6,7 @@ > Warning: This API is now obsolete. > +> - use `functionCalls()` instead > Deprecated: use `functionCalls()` instead. diff --git a/docs/reference/generative-ai.enhancedgeneratecontentresponse.functioncalls.md b/docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncalls.md similarity index 100% rename from docs/reference/generative-ai.enhancedgeneratecontentresponse.functioncalls.md rename to docs/reference/main/generative-ai.enhancedgeneratecontentresponse.functioncalls.md diff --git a/docs/reference/generative-ai.enhancedgeneratecontentresponse.md b/docs/reference/main/generative-ai.enhancedgeneratecontentresponse.md similarity index 100% rename from docs/reference/generative-ai.enhancedgeneratecontentresponse.md rename to docs/reference/main/generative-ai.enhancedgeneratecontentresponse.md diff --git a/docs/reference/generative-ai.enhancedgeneratecontentresponse.text.md b/docs/reference/main/generative-ai.enhancedgeneratecontentresponse.text.md similarity index 100% rename from docs/reference/generative-ai.enhancedgeneratecontentresponse.text.md rename to docs/reference/main/generative-ai.enhancedgeneratecontentresponse.text.md diff --git a/docs/reference/main/generative-ai.filedata.fileuri.md b/docs/reference/main/generative-ai.filedata.fileuri.md new file mode 100644 index 00000000..2a22f1f0 --- /dev/null +++ b/docs/reference/main/generative-ai.filedata.fileuri.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [fileUri](./generative-ai.filedata.fileuri.md) + +## FileData.fileUri property + +**Signature:** + +```typescript +fileUri: string; +``` diff --git a/docs/reference/main/generative-ai.filedata.md b/docs/reference/main/generative-ai.filedata.md new file mode 100644 index 00000000..f6df39cb --- /dev/null +++ b/docs/reference/main/generative-ai.filedata.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) + +## FileData interface + +Data pointing to a file uploaded with the Files API. + +**Signature:** + +```typescript +export interface FileData +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fileUri](./generative-ai.filedata.fileuri.md) | | string | | +| [mimeType](./generative-ai.filedata.mimetype.md) | | string | | + diff --git a/docs/reference/main/generative-ai.filedata.mimetype.md b/docs/reference/main/generative-ai.filedata.mimetype.md new file mode 100644 index 00000000..3904de53 --- /dev/null +++ b/docs/reference/main/generative-ai.filedata.mimetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileData](./generative-ai.filedata.md) > [mimeType](./generative-ai.filedata.mimetype.md) + +## FileData.mimeType property + +**Signature:** + +```typescript +mimeType: string; +``` diff --git a/docs/reference/main/generative-ai.filedatapart.filedata.md b/docs/reference/main/generative-ai.filedatapart.filedata.md new file mode 100644 index 00000000..86761b38 --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.filedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [fileData](./generative-ai.filedatapart.filedata.md) + +## FileDataPart.fileData property + +**Signature:** + +```typescript +fileData: FileData; +``` diff --git a/docs/reference/main/generative-ai.filedatapart.functioncall.md b/docs/reference/main/generative-ai.filedatapart.functioncall.md new file mode 100644 index 00000000..5beeec09 --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.functioncall.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionCall](./generative-ai.filedatapart.functioncall.md) + +## FileDataPart.functionCall property + +**Signature:** + +```typescript +functionCall?: never; +``` diff --git a/docs/reference/main/generative-ai.filedatapart.functionresponse.md b/docs/reference/main/generative-ai.filedatapart.functionresponse.md new file mode 100644 index 00000000..81fae57c --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.functionresponse.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [functionResponse](./generative-ai.filedatapart.functionresponse.md) + +## FileDataPart.functionResponse property + +**Signature:** + +```typescript +functionResponse?: never; +``` diff --git a/docs/reference/main/generative-ai.filedatapart.inlinedata.md b/docs/reference/main/generative-ai.filedatapart.inlinedata.md new file mode 100644 index 00000000..ce07379b --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.inlinedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [inlineData](./generative-ai.filedatapart.inlinedata.md) + +## FileDataPart.inlineData property + +**Signature:** + +```typescript +inlineData?: never; +``` diff --git a/docs/reference/main/generative-ai.filedatapart.md b/docs/reference/main/generative-ai.filedatapart.md new file mode 100644 index 00000000..433786ea --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) + +## FileDataPart interface + +Content part interface if the part represents FunctionResponse. + +**Signature:** + +```typescript +export interface FileDataPart +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fileData](./generative-ai.filedatapart.filedata.md) | | [FileData](./generative-ai.filedata.md) | | +| [functionCall?](./generative-ai.filedatapart.functioncall.md) | | never | _(Optional)_ | +| [functionResponse?](./generative-ai.filedatapart.functionresponse.md) | | never | _(Optional)_ | +| [inlineData?](./generative-ai.filedatapart.inlinedata.md) | | never | _(Optional)_ | +| [text?](./generative-ai.filedatapart.text.md) | | never | _(Optional)_ | + diff --git a/docs/reference/main/generative-ai.filedatapart.text.md b/docs/reference/main/generative-ai.filedatapart.text.md new file mode 100644 index 00000000..9452b18e --- /dev/null +++ b/docs/reference/main/generative-ai.filedatapart.text.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileDataPart](./generative-ai.filedatapart.md) > [text](./generative-ai.filedatapart.text.md) + +## FileDataPart.text property + +**Signature:** + +```typescript +text?: never; +``` diff --git a/docs/reference/generative-ai.finishreason.md b/docs/reference/main/generative-ai.finishreason.md similarity index 100% rename from docs/reference/generative-ai.finishreason.md rename to docs/reference/main/generative-ai.finishreason.md diff --git a/docs/reference/generative-ai.functioncall.args.md b/docs/reference/main/generative-ai.functioncall.args.md similarity index 100% rename from docs/reference/generative-ai.functioncall.args.md rename to docs/reference/main/generative-ai.functioncall.args.md diff --git a/docs/reference/generative-ai.functioncall.md b/docs/reference/main/generative-ai.functioncall.md similarity index 100% rename from docs/reference/generative-ai.functioncall.md rename to docs/reference/main/generative-ai.functioncall.md diff --git a/docs/reference/generative-ai.functioncall.name.md b/docs/reference/main/generative-ai.functioncall.name.md similarity index 100% rename from docs/reference/generative-ai.functioncall.name.md rename to docs/reference/main/generative-ai.functioncall.name.md diff --git a/docs/reference/generative-ai.functioncallingconfig.allowedfunctionnames.md b/docs/reference/main/generative-ai.functioncallingconfig.allowedfunctionnames.md similarity index 100% rename from docs/reference/generative-ai.functioncallingconfig.allowedfunctionnames.md rename to docs/reference/main/generative-ai.functioncallingconfig.allowedfunctionnames.md diff --git a/docs/reference/generative-ai.functioncallingconfig.md b/docs/reference/main/generative-ai.functioncallingconfig.md similarity index 100% rename from docs/reference/generative-ai.functioncallingconfig.md rename to docs/reference/main/generative-ai.functioncallingconfig.md diff --git a/docs/reference/generative-ai.functioncallingconfig.mode.md b/docs/reference/main/generative-ai.functioncallingconfig.mode.md similarity index 100% rename from docs/reference/generative-ai.functioncallingconfig.mode.md rename to docs/reference/main/generative-ai.functioncallingconfig.mode.md diff --git a/docs/reference/generative-ai.functioncallingmode.md b/docs/reference/main/generative-ai.functioncallingmode.md similarity index 100% rename from docs/reference/generative-ai.functioncallingmode.md rename to docs/reference/main/generative-ai.functioncallingmode.md diff --git a/docs/reference/main/generative-ai.functioncallpart.filedata.md b/docs/reference/main/generative-ai.functioncallpart.filedata.md new file mode 100644 index 00000000..3a9fee1e --- /dev/null +++ b/docs/reference/main/generative-ai.functioncallpart.filedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallPart](./generative-ai.functioncallpart.md) > [fileData](./generative-ai.functioncallpart.filedata.md) + +## FunctionCallPart.fileData property + +**Signature:** + +```typescript +fileData?: never; +``` diff --git a/docs/reference/generative-ai.functioncallpart.functioncall.md b/docs/reference/main/generative-ai.functioncallpart.functioncall.md similarity index 100% rename from docs/reference/generative-ai.functioncallpart.functioncall.md rename to docs/reference/main/generative-ai.functioncallpart.functioncall.md diff --git a/docs/reference/generative-ai.functioncallpart.functionresponse.md b/docs/reference/main/generative-ai.functioncallpart.functionresponse.md similarity index 100% rename from docs/reference/generative-ai.functioncallpart.functionresponse.md rename to docs/reference/main/generative-ai.functioncallpart.functionresponse.md diff --git a/docs/reference/generative-ai.functioncallpart.inlinedata.md b/docs/reference/main/generative-ai.functioncallpart.inlinedata.md similarity index 100% rename from docs/reference/generative-ai.functioncallpart.inlinedata.md rename to docs/reference/main/generative-ai.functioncallpart.inlinedata.md diff --git a/docs/reference/generative-ai.functioncallpart.md b/docs/reference/main/generative-ai.functioncallpart.md similarity index 88% rename from docs/reference/generative-ai.functioncallpart.md rename to docs/reference/main/generative-ai.functioncallpart.md index 45ed1cdb..76fce8fb 100644 --- a/docs/reference/generative-ai.functioncallpart.md +++ b/docs/reference/main/generative-ai.functioncallpart.md @@ -16,6 +16,7 @@ export interface FunctionCallPart | Property | Modifiers | Type | Description | | --- | --- | --- | --- | +| [fileData?](./generative-ai.functioncallpart.filedata.md) | | never | _(Optional)_ | | [functionCall](./generative-ai.functioncallpart.functioncall.md) | | [FunctionCall](./generative-ai.functioncall.md) | | | [functionResponse?](./generative-ai.functioncallpart.functionresponse.md) | | never | _(Optional)_ | | [inlineData?](./generative-ai.functioncallpart.inlinedata.md) | | never | _(Optional)_ | diff --git a/docs/reference/generative-ai.functioncallpart.text.md b/docs/reference/main/generative-ai.functioncallpart.text.md similarity index 100% rename from docs/reference/generative-ai.functioncallpart.text.md rename to docs/reference/main/generative-ai.functioncallpart.text.md diff --git a/docs/reference/generative-ai.functiondeclaration.description.md b/docs/reference/main/generative-ai.functiondeclaration.description.md similarity index 100% rename from docs/reference/generative-ai.functiondeclaration.description.md rename to docs/reference/main/generative-ai.functiondeclaration.description.md diff --git a/docs/reference/generative-ai.functiondeclaration.md b/docs/reference/main/generative-ai.functiondeclaration.md similarity index 100% rename from docs/reference/generative-ai.functiondeclaration.md rename to docs/reference/main/generative-ai.functiondeclaration.md diff --git a/docs/reference/generative-ai.functiondeclaration.name.md b/docs/reference/main/generative-ai.functiondeclaration.name.md similarity index 100% rename from docs/reference/generative-ai.functiondeclaration.name.md rename to docs/reference/main/generative-ai.functiondeclaration.name.md diff --git a/docs/reference/generative-ai.functiondeclaration.parameters.md b/docs/reference/main/generative-ai.functiondeclaration.parameters.md similarity index 100% rename from docs/reference/generative-ai.functiondeclaration.parameters.md rename to docs/reference/main/generative-ai.functiondeclaration.parameters.md diff --git a/docs/reference/generative-ai.functiondeclarationschema.description.md b/docs/reference/main/generative-ai.functiondeclarationschema.description.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschema.description.md rename to docs/reference/main/generative-ai.functiondeclarationschema.description.md diff --git a/docs/reference/generative-ai.functiondeclarationschema.md b/docs/reference/main/generative-ai.functiondeclarationschema.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschema.md rename to docs/reference/main/generative-ai.functiondeclarationschema.md diff --git a/docs/reference/generative-ai.functiondeclarationschema.properties.md b/docs/reference/main/generative-ai.functiondeclarationschema.properties.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschema.properties.md rename to docs/reference/main/generative-ai.functiondeclarationschema.properties.md diff --git a/docs/reference/generative-ai.functiondeclarationschema.required.md b/docs/reference/main/generative-ai.functiondeclarationschema.required.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschema.required.md rename to docs/reference/main/generative-ai.functiondeclarationschema.required.md diff --git a/docs/reference/generative-ai.functiondeclarationschema.type.md b/docs/reference/main/generative-ai.functiondeclarationschema.type.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschema.type.md rename to docs/reference/main/generative-ai.functiondeclarationschema.type.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.description.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.description.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.description.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.description.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.enum.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.enum.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.enum.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.enum.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.example.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.example.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.example.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.example.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.format.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.format.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.format.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.format.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.items.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.items.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.items.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.items.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.nullable.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.nullable.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.nullable.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.nullable.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.properties.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.properties.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.properties.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.properties.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.required.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.required.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.required.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.required.md diff --git a/docs/reference/generative-ai.functiondeclarationschemaproperty.type.md b/docs/reference/main/generative-ai.functiondeclarationschemaproperty.type.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschemaproperty.type.md rename to docs/reference/main/generative-ai.functiondeclarationschemaproperty.type.md diff --git a/docs/reference/generative-ai.functiondeclarationschematype.md b/docs/reference/main/generative-ai.functiondeclarationschematype.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationschematype.md rename to docs/reference/main/generative-ai.functiondeclarationschematype.md diff --git a/docs/reference/generative-ai.functiondeclarationstool.functiondeclarations.md b/docs/reference/main/generative-ai.functiondeclarationstool.functiondeclarations.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationstool.functiondeclarations.md rename to docs/reference/main/generative-ai.functiondeclarationstool.functiondeclarations.md diff --git a/docs/reference/generative-ai.functiondeclarationstool.md b/docs/reference/main/generative-ai.functiondeclarationstool.md similarity index 100% rename from docs/reference/generative-ai.functiondeclarationstool.md rename to docs/reference/main/generative-ai.functiondeclarationstool.md diff --git a/docs/reference/generative-ai.functionresponse.md b/docs/reference/main/generative-ai.functionresponse.md similarity index 100% rename from docs/reference/generative-ai.functionresponse.md rename to docs/reference/main/generative-ai.functionresponse.md diff --git a/docs/reference/generative-ai.functionresponse.name.md b/docs/reference/main/generative-ai.functionresponse.name.md similarity index 100% rename from docs/reference/generative-ai.functionresponse.name.md rename to docs/reference/main/generative-ai.functionresponse.name.md diff --git a/docs/reference/generative-ai.functionresponse.response.md b/docs/reference/main/generative-ai.functionresponse.response.md similarity index 100% rename from docs/reference/generative-ai.functionresponse.response.md rename to docs/reference/main/generative-ai.functionresponse.response.md diff --git a/docs/reference/main/generative-ai.functionresponsepart.filedata.md b/docs/reference/main/generative-ai.functionresponsepart.filedata.md new file mode 100644 index 00000000..4bc8cf98 --- /dev/null +++ b/docs/reference/main/generative-ai.functionresponsepart.filedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionResponsePart](./generative-ai.functionresponsepart.md) > [fileData](./generative-ai.functionresponsepart.filedata.md) + +## FunctionResponsePart.fileData property + +**Signature:** + +```typescript +fileData?: never; +``` diff --git a/docs/reference/generative-ai.functionresponsepart.functioncall.md b/docs/reference/main/generative-ai.functionresponsepart.functioncall.md similarity index 100% rename from docs/reference/generative-ai.functionresponsepart.functioncall.md rename to docs/reference/main/generative-ai.functionresponsepart.functioncall.md diff --git a/docs/reference/generative-ai.functionresponsepart.functionresponse.md b/docs/reference/main/generative-ai.functionresponsepart.functionresponse.md similarity index 100% rename from docs/reference/generative-ai.functionresponsepart.functionresponse.md rename to docs/reference/main/generative-ai.functionresponsepart.functionresponse.md diff --git a/docs/reference/generative-ai.functionresponsepart.inlinedata.md b/docs/reference/main/generative-ai.functionresponsepart.inlinedata.md similarity index 100% rename from docs/reference/generative-ai.functionresponsepart.inlinedata.md rename to docs/reference/main/generative-ai.functionresponsepart.inlinedata.md diff --git a/docs/reference/generative-ai.functionresponsepart.md b/docs/reference/main/generative-ai.functionresponsepart.md similarity index 88% rename from docs/reference/generative-ai.functionresponsepart.md rename to docs/reference/main/generative-ai.functionresponsepart.md index f5947c8f..ad834102 100644 --- a/docs/reference/generative-ai.functionresponsepart.md +++ b/docs/reference/main/generative-ai.functionresponsepart.md @@ -16,6 +16,7 @@ export interface FunctionResponsePart | Property | Modifiers | Type | Description | | --- | --- | --- | --- | +| [fileData?](./generative-ai.functionresponsepart.filedata.md) | | never | _(Optional)_ | | [functionCall?](./generative-ai.functionresponsepart.functioncall.md) | | never | _(Optional)_ | | [functionResponse](./generative-ai.functionresponsepart.functionresponse.md) | | [FunctionResponse](./generative-ai.functionresponse.md) | | | [inlineData?](./generative-ai.functionresponsepart.inlinedata.md) | | never | _(Optional)_ | diff --git a/docs/reference/generative-ai.functionresponsepart.text.md b/docs/reference/main/generative-ai.functionresponsepart.text.md similarity index 100% rename from docs/reference/generative-ai.functionresponsepart.text.md rename to docs/reference/main/generative-ai.functionresponsepart.text.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.citationmetadata.md b/docs/reference/main/generative-ai.generatecontentcandidate.citationmetadata.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.citationmetadata.md rename to docs/reference/main/generative-ai.generatecontentcandidate.citationmetadata.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.content.md b/docs/reference/main/generative-ai.generatecontentcandidate.content.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.content.md rename to docs/reference/main/generative-ai.generatecontentcandidate.content.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.finishmessage.md b/docs/reference/main/generative-ai.generatecontentcandidate.finishmessage.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.finishmessage.md rename to docs/reference/main/generative-ai.generatecontentcandidate.finishmessage.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.finishreason.md b/docs/reference/main/generative-ai.generatecontentcandidate.finishreason.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.finishreason.md rename to docs/reference/main/generative-ai.generatecontentcandidate.finishreason.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.index.md b/docs/reference/main/generative-ai.generatecontentcandidate.index.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.index.md rename to docs/reference/main/generative-ai.generatecontentcandidate.index.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.md b/docs/reference/main/generative-ai.generatecontentcandidate.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.md rename to docs/reference/main/generative-ai.generatecontentcandidate.md diff --git a/docs/reference/generative-ai.generatecontentcandidate.safetyratings.md b/docs/reference/main/generative-ai.generatecontentcandidate.safetyratings.md similarity index 100% rename from docs/reference/generative-ai.generatecontentcandidate.safetyratings.md rename to docs/reference/main/generative-ai.generatecontentcandidate.safetyratings.md diff --git a/docs/reference/generative-ai.generatecontentrequest.contents.md b/docs/reference/main/generative-ai.generatecontentrequest.contents.md similarity index 100% rename from docs/reference/generative-ai.generatecontentrequest.contents.md rename to docs/reference/main/generative-ai.generatecontentrequest.contents.md diff --git a/docs/reference/generative-ai.generatecontentrequest.md b/docs/reference/main/generative-ai.generatecontentrequest.md similarity index 100% rename from docs/reference/generative-ai.generatecontentrequest.md rename to docs/reference/main/generative-ai.generatecontentrequest.md diff --git a/docs/reference/generative-ai.generatecontentrequest.systeminstruction.md b/docs/reference/main/generative-ai.generatecontentrequest.systeminstruction.md similarity index 100% rename from docs/reference/generative-ai.generatecontentrequest.systeminstruction.md rename to docs/reference/main/generative-ai.generatecontentrequest.systeminstruction.md diff --git a/docs/reference/generative-ai.generatecontentrequest.toolconfig.md b/docs/reference/main/generative-ai.generatecontentrequest.toolconfig.md similarity index 100% rename from docs/reference/generative-ai.generatecontentrequest.toolconfig.md rename to docs/reference/main/generative-ai.generatecontentrequest.toolconfig.md diff --git a/docs/reference/generative-ai.generatecontentrequest.tools.md b/docs/reference/main/generative-ai.generatecontentrequest.tools.md similarity index 100% rename from docs/reference/generative-ai.generatecontentrequest.tools.md rename to docs/reference/main/generative-ai.generatecontentrequest.tools.md diff --git a/docs/reference/generative-ai.generatecontentresponse.candidates.md b/docs/reference/main/generative-ai.generatecontentresponse.candidates.md similarity index 100% rename from docs/reference/generative-ai.generatecontentresponse.candidates.md rename to docs/reference/main/generative-ai.generatecontentresponse.candidates.md diff --git a/docs/reference/generative-ai.generatecontentresponse.md b/docs/reference/main/generative-ai.generatecontentresponse.md similarity index 100% rename from docs/reference/generative-ai.generatecontentresponse.md rename to docs/reference/main/generative-ai.generatecontentresponse.md diff --git a/docs/reference/generative-ai.generatecontentresponse.promptfeedback.md b/docs/reference/main/generative-ai.generatecontentresponse.promptfeedback.md similarity index 100% rename from docs/reference/generative-ai.generatecontentresponse.promptfeedback.md rename to docs/reference/main/generative-ai.generatecontentresponse.promptfeedback.md diff --git a/docs/reference/generative-ai.generatecontentresult.md b/docs/reference/main/generative-ai.generatecontentresult.md similarity index 100% rename from docs/reference/generative-ai.generatecontentresult.md rename to docs/reference/main/generative-ai.generatecontentresult.md diff --git a/docs/reference/generative-ai.generatecontentresult.response.md b/docs/reference/main/generative-ai.generatecontentresult.response.md similarity index 100% rename from docs/reference/generative-ai.generatecontentresult.response.md rename to docs/reference/main/generative-ai.generatecontentresult.response.md diff --git a/docs/reference/generative-ai.generatecontentstreamresult.md b/docs/reference/main/generative-ai.generatecontentstreamresult.md similarity index 100% rename from docs/reference/generative-ai.generatecontentstreamresult.md rename to docs/reference/main/generative-ai.generatecontentstreamresult.md diff --git a/docs/reference/generative-ai.generatecontentstreamresult.response.md b/docs/reference/main/generative-ai.generatecontentstreamresult.response.md similarity index 100% rename from docs/reference/generative-ai.generatecontentstreamresult.response.md rename to docs/reference/main/generative-ai.generatecontentstreamresult.response.md diff --git a/docs/reference/generative-ai.generatecontentstreamresult.stream.md b/docs/reference/main/generative-ai.generatecontentstreamresult.stream.md similarity index 100% rename from docs/reference/generative-ai.generatecontentstreamresult.stream.md rename to docs/reference/main/generative-ai.generatecontentstreamresult.stream.md diff --git a/docs/reference/generative-ai.generationconfig.candidatecount.md b/docs/reference/main/generative-ai.generationconfig.candidatecount.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.candidatecount.md rename to docs/reference/main/generative-ai.generationconfig.candidatecount.md diff --git a/docs/reference/generative-ai.generationconfig.maxoutputtokens.md b/docs/reference/main/generative-ai.generationconfig.maxoutputtokens.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.maxoutputtokens.md rename to docs/reference/main/generative-ai.generationconfig.maxoutputtokens.md diff --git a/docs/reference/generative-ai.generationconfig.md b/docs/reference/main/generative-ai.generationconfig.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.md rename to docs/reference/main/generative-ai.generationconfig.md diff --git a/docs/reference/generative-ai.generationconfig.stopsequences.md b/docs/reference/main/generative-ai.generationconfig.stopsequences.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.stopsequences.md rename to docs/reference/main/generative-ai.generationconfig.stopsequences.md diff --git a/docs/reference/generative-ai.generationconfig.temperature.md b/docs/reference/main/generative-ai.generationconfig.temperature.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.temperature.md rename to docs/reference/main/generative-ai.generationconfig.temperature.md diff --git a/docs/reference/generative-ai.generationconfig.topk.md b/docs/reference/main/generative-ai.generationconfig.topk.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.topk.md rename to docs/reference/main/generative-ai.generationconfig.topk.md diff --git a/docs/reference/generative-ai.generationconfig.topp.md b/docs/reference/main/generative-ai.generationconfig.topp.md similarity index 100% rename from docs/reference/generative-ai.generationconfig.topp.md rename to docs/reference/main/generative-ai.generationconfig.topp.md diff --git a/docs/reference/generative-ai.generativecontentblob.data.md b/docs/reference/main/generative-ai.generativecontentblob.data.md similarity index 100% rename from docs/reference/generative-ai.generativecontentblob.data.md rename to docs/reference/main/generative-ai.generativecontentblob.data.md diff --git a/docs/reference/generative-ai.generativecontentblob.md b/docs/reference/main/generative-ai.generativecontentblob.md similarity index 100% rename from docs/reference/generative-ai.generativecontentblob.md rename to docs/reference/main/generative-ai.generativecontentblob.md diff --git a/docs/reference/generative-ai.generativecontentblob.mimetype.md b/docs/reference/main/generative-ai.generativecontentblob.mimetype.md similarity index 100% rename from docs/reference/generative-ai.generativecontentblob.mimetype.md rename to docs/reference/main/generative-ai.generativecontentblob.mimetype.md diff --git a/docs/reference/generative-ai.generativemodel._constructor_.md b/docs/reference/main/generative-ai.generativemodel._constructor_.md similarity index 100% rename from docs/reference/generative-ai.generativemodel._constructor_.md rename to docs/reference/main/generative-ai.generativemodel._constructor_.md diff --git a/docs/reference/generative-ai.generativemodel.apikey.md b/docs/reference/main/generative-ai.generativemodel.apikey.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.apikey.md rename to docs/reference/main/generative-ai.generativemodel.apikey.md diff --git a/docs/reference/generative-ai.generativemodel.batchembedcontents.md b/docs/reference/main/generative-ai.generativemodel.batchembedcontents.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.batchembedcontents.md rename to docs/reference/main/generative-ai.generativemodel.batchembedcontents.md diff --git a/docs/reference/generative-ai.generativemodel.counttokens.md b/docs/reference/main/generative-ai.generativemodel.counttokens.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.counttokens.md rename to docs/reference/main/generative-ai.generativemodel.counttokens.md diff --git a/docs/reference/generative-ai.generativemodel.embedcontent.md b/docs/reference/main/generative-ai.generativemodel.embedcontent.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.embedcontent.md rename to docs/reference/main/generative-ai.generativemodel.embedcontent.md diff --git a/docs/reference/generative-ai.generativemodel.generatecontent.md b/docs/reference/main/generative-ai.generativemodel.generatecontent.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.generatecontent.md rename to docs/reference/main/generative-ai.generativemodel.generatecontent.md diff --git a/docs/reference/generative-ai.generativemodel.generatecontentstream.md b/docs/reference/main/generative-ai.generativemodel.generatecontentstream.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.generatecontentstream.md rename to docs/reference/main/generative-ai.generativemodel.generatecontentstream.md diff --git a/docs/reference/generative-ai.generativemodel.generationconfig.md b/docs/reference/main/generative-ai.generativemodel.generationconfig.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.generationconfig.md rename to docs/reference/main/generative-ai.generativemodel.generationconfig.md diff --git a/docs/reference/generative-ai.generativemodel.md b/docs/reference/main/generative-ai.generativemodel.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.md rename to docs/reference/main/generative-ai.generativemodel.md diff --git a/docs/reference/generative-ai.generativemodel.model.md b/docs/reference/main/generative-ai.generativemodel.model.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.model.md rename to docs/reference/main/generative-ai.generativemodel.model.md diff --git a/docs/reference/generative-ai.generativemodel.requestoptions.md b/docs/reference/main/generative-ai.generativemodel.requestoptions.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.requestoptions.md rename to docs/reference/main/generative-ai.generativemodel.requestoptions.md diff --git a/docs/reference/generative-ai.generativemodel.safetysettings.md b/docs/reference/main/generative-ai.generativemodel.safetysettings.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.safetysettings.md rename to docs/reference/main/generative-ai.generativemodel.safetysettings.md diff --git a/docs/reference/generative-ai.generativemodel.startchat.md b/docs/reference/main/generative-ai.generativemodel.startchat.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.startchat.md rename to docs/reference/main/generative-ai.generativemodel.startchat.md diff --git a/docs/reference/generative-ai.generativemodel.systeminstruction.md b/docs/reference/main/generative-ai.generativemodel.systeminstruction.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.systeminstruction.md rename to docs/reference/main/generative-ai.generativemodel.systeminstruction.md diff --git a/docs/reference/generative-ai.generativemodel.toolconfig.md b/docs/reference/main/generative-ai.generativemodel.toolconfig.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.toolconfig.md rename to docs/reference/main/generative-ai.generativemodel.toolconfig.md diff --git a/docs/reference/generative-ai.generativemodel.tools.md b/docs/reference/main/generative-ai.generativemodel.tools.md similarity index 100% rename from docs/reference/generative-ai.generativemodel.tools.md rename to docs/reference/main/generative-ai.generativemodel.tools.md diff --git a/docs/reference/generative-ai.googlegenerativeai._constructor_.md b/docs/reference/main/generative-ai.googlegenerativeai._constructor_.md similarity index 100% rename from docs/reference/generative-ai.googlegenerativeai._constructor_.md rename to docs/reference/main/generative-ai.googlegenerativeai._constructor_.md diff --git a/docs/reference/generative-ai.googlegenerativeai.apikey.md b/docs/reference/main/generative-ai.googlegenerativeai.apikey.md similarity index 100% rename from docs/reference/generative-ai.googlegenerativeai.apikey.md rename to docs/reference/main/generative-ai.googlegenerativeai.apikey.md diff --git a/docs/reference/generative-ai.googlegenerativeai.getgenerativemodel.md b/docs/reference/main/generative-ai.googlegenerativeai.getgenerativemodel.md similarity index 100% rename from docs/reference/generative-ai.googlegenerativeai.getgenerativemodel.md rename to docs/reference/main/generative-ai.googlegenerativeai.getgenerativemodel.md diff --git a/docs/reference/generative-ai.googlegenerativeai.md b/docs/reference/main/generative-ai.googlegenerativeai.md similarity index 100% rename from docs/reference/generative-ai.googlegenerativeai.md rename to docs/reference/main/generative-ai.googlegenerativeai.md diff --git a/docs/reference/generative-ai.harmblockthreshold.md b/docs/reference/main/generative-ai.harmblockthreshold.md similarity index 100% rename from docs/reference/generative-ai.harmblockthreshold.md rename to docs/reference/main/generative-ai.harmblockthreshold.md diff --git a/docs/reference/generative-ai.harmcategory.md b/docs/reference/main/generative-ai.harmcategory.md similarity index 100% rename from docs/reference/generative-ai.harmcategory.md rename to docs/reference/main/generative-ai.harmcategory.md diff --git a/docs/reference/generative-ai.harmprobability.md b/docs/reference/main/generative-ai.harmprobability.md similarity index 100% rename from docs/reference/generative-ai.harmprobability.md rename to docs/reference/main/generative-ai.harmprobability.md diff --git a/docs/reference/main/generative-ai.inlinedatapart.filedata.md b/docs/reference/main/generative-ai.inlinedatapart.filedata.md new file mode 100644 index 00000000..2e23c247 --- /dev/null +++ b/docs/reference/main/generative-ai.inlinedatapart.filedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [InlineDataPart](./generative-ai.inlinedatapart.md) > [fileData](./generative-ai.inlinedatapart.filedata.md) + +## InlineDataPart.fileData property + +**Signature:** + +```typescript +fileData?: never; +``` diff --git a/docs/reference/generative-ai.inlinedatapart.functioncall.md b/docs/reference/main/generative-ai.inlinedatapart.functioncall.md similarity index 100% rename from docs/reference/generative-ai.inlinedatapart.functioncall.md rename to docs/reference/main/generative-ai.inlinedatapart.functioncall.md diff --git a/docs/reference/generative-ai.inlinedatapart.functionresponse.md b/docs/reference/main/generative-ai.inlinedatapart.functionresponse.md similarity index 100% rename from docs/reference/generative-ai.inlinedatapart.functionresponse.md rename to docs/reference/main/generative-ai.inlinedatapart.functionresponse.md diff --git a/docs/reference/generative-ai.inlinedatapart.inlinedata.md b/docs/reference/main/generative-ai.inlinedatapart.inlinedata.md similarity index 100% rename from docs/reference/generative-ai.inlinedatapart.inlinedata.md rename to docs/reference/main/generative-ai.inlinedatapart.inlinedata.md diff --git a/docs/reference/generative-ai.inlinedatapart.md b/docs/reference/main/generative-ai.inlinedatapart.md similarity index 88% rename from docs/reference/generative-ai.inlinedatapart.md rename to docs/reference/main/generative-ai.inlinedatapart.md index 57925b30..3a95731e 100644 --- a/docs/reference/generative-ai.inlinedatapart.md +++ b/docs/reference/main/generative-ai.inlinedatapart.md @@ -16,6 +16,7 @@ export interface InlineDataPart | Property | Modifiers | Type | Description | | --- | --- | --- | --- | +| [fileData?](./generative-ai.inlinedatapart.filedata.md) | | never | _(Optional)_ | | [functionCall?](./generative-ai.inlinedatapart.functioncall.md) | | never | _(Optional)_ | | [functionResponse?](./generative-ai.inlinedatapart.functionresponse.md) | | never | _(Optional)_ | | [inlineData](./generative-ai.inlinedatapart.inlinedata.md) | | [GenerativeContentBlob](./generative-ai.generativecontentblob.md) | | diff --git a/docs/reference/generative-ai.inlinedatapart.text.md b/docs/reference/main/generative-ai.inlinedatapart.text.md similarity index 100% rename from docs/reference/generative-ai.inlinedatapart.text.md rename to docs/reference/main/generative-ai.inlinedatapart.text.md diff --git a/docs/reference/generative-ai.md b/docs/reference/main/generative-ai.md similarity index 95% rename from docs/reference/generative-ai.md rename to docs/reference/main/generative-ai.md index 2e39232b..a231bee1 100644 --- a/docs/reference/generative-ai.md +++ b/docs/reference/main/generative-ai.md @@ -41,6 +41,8 @@ | [EmbedContentRequest](./generative-ai.embedcontentrequest.md) | Params for calling [GenerativeModel.embedContent()](./generative-ai.generativemodel.embedcontent.md) | | [EmbedContentResponse](./generative-ai.embedcontentresponse.md) | Response from calling [GenerativeModel.embedContent()](./generative-ai.generativemodel.embedcontent.md). | | [EnhancedGenerateContentResponse](./generative-ai.enhancedgeneratecontentresponse.md) | Response object wrapped with helper methods. | +| [FileData](./generative-ai.filedata.md) | Data pointing to a file uploaded with the Files API. | +| [FileDataPart](./generative-ai.filedatapart.md) | Content part interface if the part represents FunctionResponse. | | [FunctionCall](./generative-ai.functioncall.md) | A predicted \[FunctionCall\] returned from the model that contains a string representing the \[FunctionDeclaration.name\] and a structured JSON object containing the parameters and their values. | | [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) | | | [FunctionCallPart](./generative-ai.functioncallpart.md) | Content part interface if the part represents FunctionResponse. | @@ -60,7 +62,7 @@ | [InlineDataPart](./generative-ai.inlinedatapart.md) | Content part interface if the part represents an image. | | [ModelParams](./generative-ai.modelparams.md) | Params passed to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md). | | [PromptFeedback](./generative-ai.promptfeedback.md) | If the prompt was blocked, this will be populated with blockReason and the relevant safetyRatings. | -| [RequestOptions](./generative-ai.requestoptions.md) | Params passed to [GoogleGenerativeAI.getGenerativeModel()](./generative-ai.googlegenerativeai.getgenerativemodel.md). | +| [RequestOptions](./generative-ai.requestoptions.md) | Params passed to getGenerativeModel() or GoogleAIFileManager(). | | [SafetyRating](./generative-ai.safetyrating.md) | A safety rating associated with a [GenerateContentCandidate](./generative-ai.generatecontentcandidate.md) | | [SafetySetting](./generative-ai.safetysetting.md) | Safety setting that can be sent as part of request parameters. | | [StartChatParams](./generative-ai.startchatparams.md) | Params for [GenerativeModel.startChat()](./generative-ai.generativemodel.startchat.md). | diff --git a/docs/reference/generative-ai.modelparams.md b/docs/reference/main/generative-ai.modelparams.md similarity index 100% rename from docs/reference/generative-ai.modelparams.md rename to docs/reference/main/generative-ai.modelparams.md diff --git a/docs/reference/generative-ai.modelparams.model.md b/docs/reference/main/generative-ai.modelparams.model.md similarity index 100% rename from docs/reference/generative-ai.modelparams.model.md rename to docs/reference/main/generative-ai.modelparams.model.md diff --git a/docs/reference/generative-ai.modelparams.systeminstruction.md b/docs/reference/main/generative-ai.modelparams.systeminstruction.md similarity index 100% rename from docs/reference/generative-ai.modelparams.systeminstruction.md rename to docs/reference/main/generative-ai.modelparams.systeminstruction.md diff --git a/docs/reference/generative-ai.modelparams.toolconfig.md b/docs/reference/main/generative-ai.modelparams.toolconfig.md similarity index 100% rename from docs/reference/generative-ai.modelparams.toolconfig.md rename to docs/reference/main/generative-ai.modelparams.toolconfig.md diff --git a/docs/reference/generative-ai.modelparams.tools.md b/docs/reference/main/generative-ai.modelparams.tools.md similarity index 100% rename from docs/reference/generative-ai.modelparams.tools.md rename to docs/reference/main/generative-ai.modelparams.tools.md diff --git a/docs/reference/generative-ai.part.md b/docs/reference/main/generative-ai.part.md similarity index 75% rename from docs/reference/generative-ai.part.md rename to docs/reference/main/generative-ai.part.md index fc4146f0..3ffb1baf 100644 --- a/docs/reference/generative-ai.part.md +++ b/docs/reference/main/generative-ai.part.md @@ -9,7 +9,7 @@ Content part - includes text or image part types. **Signature:** ```typescript -export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart; +export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart; ``` -**References:** [TextPart](./generative-ai.textpart.md), [InlineDataPart](./generative-ai.inlinedatapart.md), [FunctionCallPart](./generative-ai.functioncallpart.md), [FunctionResponsePart](./generative-ai.functionresponsepart.md) +**References:** [TextPart](./generative-ai.textpart.md), [InlineDataPart](./generative-ai.inlinedatapart.md), [FunctionCallPart](./generative-ai.functioncallpart.md), [FunctionResponsePart](./generative-ai.functionresponsepart.md), [FileDataPart](./generative-ai.filedatapart.md) diff --git a/docs/reference/generative-ai.possible_roles.md b/docs/reference/main/generative-ai.possible_roles.md similarity index 100% rename from docs/reference/generative-ai.possible_roles.md rename to docs/reference/main/generative-ai.possible_roles.md diff --git a/docs/reference/generative-ai.promptfeedback.blockreason.md b/docs/reference/main/generative-ai.promptfeedback.blockreason.md similarity index 100% rename from docs/reference/generative-ai.promptfeedback.blockreason.md rename to docs/reference/main/generative-ai.promptfeedback.blockreason.md diff --git a/docs/reference/generative-ai.promptfeedback.blockreasonmessage.md b/docs/reference/main/generative-ai.promptfeedback.blockreasonmessage.md similarity index 100% rename from docs/reference/generative-ai.promptfeedback.blockreasonmessage.md rename to docs/reference/main/generative-ai.promptfeedback.blockreasonmessage.md diff --git a/docs/reference/generative-ai.promptfeedback.md b/docs/reference/main/generative-ai.promptfeedback.md similarity index 100% rename from docs/reference/generative-ai.promptfeedback.md rename to docs/reference/main/generative-ai.promptfeedback.md diff --git a/docs/reference/generative-ai.promptfeedback.safetyratings.md b/docs/reference/main/generative-ai.promptfeedback.safetyratings.md similarity index 100% rename from docs/reference/generative-ai.promptfeedback.safetyratings.md rename to docs/reference/main/generative-ai.promptfeedback.safetyratings.md diff --git a/docs/reference/main/generative-ai.requestoptions.apiclient.md b/docs/reference/main/generative-ai.requestoptions.apiclient.md new file mode 100644 index 00000000..96f3d52a --- /dev/null +++ b/docs/reference/main/generative-ai.requestoptions.apiclient.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [apiClient](./generative-ai.requestoptions.apiclient.md) + +## RequestOptions.apiClient property + +Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs. + +**Signature:** + +```typescript +apiClient?: string; +``` diff --git a/docs/reference/main/generative-ai.requestoptions.apiversion.md b/docs/reference/main/generative-ai.requestoptions.apiversion.md new file mode 100644 index 00000000..2edf5f19 --- /dev/null +++ b/docs/reference/main/generative-ai.requestoptions.apiversion.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [apiVersion](./generative-ai.requestoptions.apiversion.md) + +## RequestOptions.apiVersion property + +Version of API endpoint to call (e.g. "v1" or "v1beta"). If not specified, defaults to latest stable version. + +**Signature:** + +```typescript +apiVersion?: string; +``` diff --git a/docs/reference/main/generative-ai.requestoptions.baseurl.md b/docs/reference/main/generative-ai.requestoptions.baseurl.md new file mode 100644 index 00000000..412a0e9f --- /dev/null +++ b/docs/reference/main/generative-ai.requestoptions.baseurl.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [baseUrl](./generative-ai.requestoptions.baseurl.md) + +## RequestOptions.baseUrl property + +Base endpoint url. Defaults to "https://generativelanguage.googleapis.com" + +**Signature:** + +```typescript +baseUrl?: string; +``` diff --git a/docs/reference/main/generative-ai.requestoptions.md b/docs/reference/main/generative-ai.requestoptions.md new file mode 100644 index 00000000..7809e3a0 --- /dev/null +++ b/docs/reference/main/generative-ai.requestoptions.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) + +## RequestOptions interface + +Params passed to getGenerativeModel() or GoogleAIFileManager(). + +**Signature:** + +```typescript +export interface RequestOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiClient?](./generative-ai.requestoptions.apiclient.md) | | string | _(Optional)_ Additional attribution information to include in the x-goog-api-client header. Used by wrapper SDKs. | +| [apiVersion?](./generative-ai.requestoptions.apiversion.md) | | string | _(Optional)_ Version of API endpoint to call (e.g. "v1" or "v1beta"). If not specified, defaults to latest stable version. | +| [baseUrl?](./generative-ai.requestoptions.baseurl.md) | | string | _(Optional)_ Base endpoint url. Defaults to "https://generativelanguage.googleapis.com" | +| [timeout?](./generative-ai.requestoptions.timeout.md) | | number | _(Optional)_ Request timeout in milliseconds. | + diff --git a/docs/reference/main/generative-ai.requestoptions.timeout.md b/docs/reference/main/generative-ai.requestoptions.timeout.md new file mode 100644 index 00000000..60526d20 --- /dev/null +++ b/docs/reference/main/generative-ai.requestoptions.timeout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RequestOptions](./generative-ai.requestoptions.md) > [timeout](./generative-ai.requestoptions.timeout.md) + +## RequestOptions.timeout property + +Request timeout in milliseconds. + +**Signature:** + +```typescript +timeout?: number; +``` diff --git a/docs/reference/generative-ai.safetyrating.category.md b/docs/reference/main/generative-ai.safetyrating.category.md similarity index 100% rename from docs/reference/generative-ai.safetyrating.category.md rename to docs/reference/main/generative-ai.safetyrating.category.md diff --git a/docs/reference/generative-ai.safetyrating.md b/docs/reference/main/generative-ai.safetyrating.md similarity index 100% rename from docs/reference/generative-ai.safetyrating.md rename to docs/reference/main/generative-ai.safetyrating.md diff --git a/docs/reference/generative-ai.safetyrating.probability.md b/docs/reference/main/generative-ai.safetyrating.probability.md similarity index 100% rename from docs/reference/generative-ai.safetyrating.probability.md rename to docs/reference/main/generative-ai.safetyrating.probability.md diff --git a/docs/reference/generative-ai.safetysetting.category.md b/docs/reference/main/generative-ai.safetysetting.category.md similarity index 100% rename from docs/reference/generative-ai.safetysetting.category.md rename to docs/reference/main/generative-ai.safetysetting.category.md diff --git a/docs/reference/generative-ai.safetysetting.md b/docs/reference/main/generative-ai.safetysetting.md similarity index 100% rename from docs/reference/generative-ai.safetysetting.md rename to docs/reference/main/generative-ai.safetysetting.md diff --git a/docs/reference/generative-ai.safetysetting.threshold.md b/docs/reference/main/generative-ai.safetysetting.threshold.md similarity index 100% rename from docs/reference/generative-ai.safetysetting.threshold.md rename to docs/reference/main/generative-ai.safetysetting.threshold.md diff --git a/docs/reference/generative-ai.startchatparams.history.md b/docs/reference/main/generative-ai.startchatparams.history.md similarity index 100% rename from docs/reference/generative-ai.startchatparams.history.md rename to docs/reference/main/generative-ai.startchatparams.history.md diff --git a/docs/reference/generative-ai.startchatparams.md b/docs/reference/main/generative-ai.startchatparams.md similarity index 100% rename from docs/reference/generative-ai.startchatparams.md rename to docs/reference/main/generative-ai.startchatparams.md diff --git a/docs/reference/generative-ai.startchatparams.systeminstruction.md b/docs/reference/main/generative-ai.startchatparams.systeminstruction.md similarity index 100% rename from docs/reference/generative-ai.startchatparams.systeminstruction.md rename to docs/reference/main/generative-ai.startchatparams.systeminstruction.md diff --git a/docs/reference/generative-ai.startchatparams.toolconfig.md b/docs/reference/main/generative-ai.startchatparams.toolconfig.md similarity index 100% rename from docs/reference/generative-ai.startchatparams.toolconfig.md rename to docs/reference/main/generative-ai.startchatparams.toolconfig.md diff --git a/docs/reference/generative-ai.startchatparams.tools.md b/docs/reference/main/generative-ai.startchatparams.tools.md similarity index 100% rename from docs/reference/generative-ai.startchatparams.tools.md rename to docs/reference/main/generative-ai.startchatparams.tools.md diff --git a/docs/reference/generative-ai.tasktype.md b/docs/reference/main/generative-ai.tasktype.md similarity index 100% rename from docs/reference/generative-ai.tasktype.md rename to docs/reference/main/generative-ai.tasktype.md diff --git a/docs/reference/main/generative-ai.textpart.filedata.md b/docs/reference/main/generative-ai.textpart.filedata.md new file mode 100644 index 00000000..b1c482bc --- /dev/null +++ b/docs/reference/main/generative-ai.textpart.filedata.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [TextPart](./generative-ai.textpart.md) > [fileData](./generative-ai.textpart.filedata.md) + +## TextPart.fileData property + +**Signature:** + +```typescript +fileData?: never; +``` diff --git a/docs/reference/generative-ai.textpart.functioncall.md b/docs/reference/main/generative-ai.textpart.functioncall.md similarity index 100% rename from docs/reference/generative-ai.textpart.functioncall.md rename to docs/reference/main/generative-ai.textpart.functioncall.md diff --git a/docs/reference/generative-ai.textpart.functionresponse.md b/docs/reference/main/generative-ai.textpart.functionresponse.md similarity index 100% rename from docs/reference/generative-ai.textpart.functionresponse.md rename to docs/reference/main/generative-ai.textpart.functionresponse.md diff --git a/docs/reference/generative-ai.textpart.inlinedata.md b/docs/reference/main/generative-ai.textpart.inlinedata.md similarity index 100% rename from docs/reference/generative-ai.textpart.inlinedata.md rename to docs/reference/main/generative-ai.textpart.inlinedata.md diff --git a/docs/reference/generative-ai.textpart.md b/docs/reference/main/generative-ai.textpart.md similarity index 87% rename from docs/reference/generative-ai.textpart.md rename to docs/reference/main/generative-ai.textpart.md index 6e13dfea..1e8dd0e8 100644 --- a/docs/reference/generative-ai.textpart.md +++ b/docs/reference/main/generative-ai.textpart.md @@ -16,6 +16,7 @@ export interface TextPart | Property | Modifiers | Type | Description | | --- | --- | --- | --- | +| [fileData?](./generative-ai.textpart.filedata.md) | | never | _(Optional)_ | | [functionCall?](./generative-ai.textpart.functioncall.md) | | never | _(Optional)_ | | [functionResponse?](./generative-ai.textpart.functionresponse.md) | | never | _(Optional)_ | | [inlineData?](./generative-ai.textpart.inlinedata.md) | | never | _(Optional)_ | diff --git a/docs/reference/generative-ai.textpart.text.md b/docs/reference/main/generative-ai.textpart.text.md similarity index 100% rename from docs/reference/generative-ai.textpart.text.md rename to docs/reference/main/generative-ai.textpart.text.md diff --git a/docs/reference/generative-ai.tool.md b/docs/reference/main/generative-ai.tool.md similarity index 100% rename from docs/reference/generative-ai.tool.md rename to docs/reference/main/generative-ai.tool.md diff --git a/docs/reference/generative-ai.toolconfig.functioncallingconfig.md b/docs/reference/main/generative-ai.toolconfig.functioncallingconfig.md similarity index 100% rename from docs/reference/generative-ai.toolconfig.functioncallingconfig.md rename to docs/reference/main/generative-ai.toolconfig.functioncallingconfig.md diff --git a/docs/reference/generative-ai.toolconfig.md b/docs/reference/main/generative-ai.toolconfig.md similarity index 100% rename from docs/reference/generative-ai.toolconfig.md rename to docs/reference/main/generative-ai.toolconfig.md diff --git a/docs/reference/main/index.md b/docs/reference/main/index.md new file mode 100644 index 00000000..cbcce1e9 --- /dev/null +++ b/docs/reference/main/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@google/generative-ai](./generative-ai.md) | | + diff --git a/packages/main/README.md b/packages/main/README.md index c843a0c7..3e965a5a 100644 --- a/packages/main/README.md +++ b/packages/main/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](/main/packages/main/CHANGELOG.md)