Skip to content

Commit adcf0b1

Browse files
committed
docs(others) 📝: made notebook sharing and source add drive feature as experimental.
1 parent 47273af commit adcf0b1

3 files changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The NotebookLM Kit provides a clean, service-based interface to all NotebookLM f
5959
<td><a href="examples/notebook-delete.ts">notebook-delete.ts</a></td>
6060
</tr>
6161
<tr>
62-
<td>Share Notebook</td>
62+
<td>Share Notebook <small>⚠️ Experimental</small></td>
6363
<td><code>sdk.notebooks.share()</code></td>
6464
<td><a href="examples/notebook-share.ts">notebook-share.ts</a></td>
6565
</tr>
@@ -94,7 +94,7 @@ The NotebookLM Kit provides a clean, service-based interface to all NotebookLM f
9494
<td><a href="examples/source-add-file.ts">source-add-file.ts</a></td>
9595
</tr>
9696
<tr>
97-
<td>Add Drive Source</td>
97+
<td>Add Drive Source <small>⚠️ Experimental</small></td>
9898
<td><code>sdk.sources.add.drive()</code></td>
9999
<td><a href="examples/source-add-drive.ts">source-add-drive.ts</a></td>
100100
</tr>
@@ -382,7 +382,7 @@ npx tsx examples/chat-basic.ts <notebook-id> "What are the key findings?" --no-s
382382
| Create Notebook | Create a new notebook (auto-generates title if empty) | [`sdk.notebooks.create(options)`](#create-notebook) | [notebook-create.ts](examples/notebook-create.ts) |
383383
| Update Notebook | Update notebook title or emoji | [`sdk.notebooks.update(notebookId, options)`](#update-notebook) | [notebook-update.ts](examples/notebook-update.ts) |
384384
| Delete Notebook | Delete one or more notebooks | [`sdk.notebooks.delete(notebookIds)`](#delete-notebook) | [notebook-delete.ts](examples/notebook-delete.ts) |
385-
| Share Notebook | Share notebook with users or enable link sharing | [`sdk.notebooks.share(notebookId, options)`](#share-notebook) | [notebook-share.ts](examples/notebook-share.ts) |
385+
| Share Notebook <small>⚠️ Experimental</small> | Share notebook with users or enable link sharing | [`sdk.notebooks.share(notebookId, options)`](#share-notebook) | [notebook-share.ts](examples/notebook-share.ts) |
386386

387387
### `sdk.sources` - Source Management
388388

@@ -394,7 +394,7 @@ npx tsx examples/chat-basic.ts <notebook-id> "What are the key findings?" --no-s
394394
| Add Text | Add a source from text content | [`sdk.sources.add.text(notebookId, options)`](#add-text-source) | [source-add-text.ts](examples/source-add-text.ts) |
395395
| Add File | Add a source from a file (PDF, image, etc.) | [`sdk.sources.add.file(notebookId, options)`](#add-file-source) | [source-add-file.ts](examples/source-add-file.ts) |
396396
| Add YouTube | Add a YouTube video as a source | [`sdk.sources.add.youtube(notebookId, options)`](#add-youtube-source) | [source-add-youtube.ts](examples/source-add-youtube.ts) |
397-
| Add Google Drive | Add a Google Drive file as a source | [`sdk.sources.add.drive(notebookId, options)`](#add-google-drive-source) | [source-add-drive.ts](examples/source-add-drive.ts) |
397+
| Add Google Drive <small>⚠️ Experimental</small> | Add a Google Drive file as a source | [`sdk.sources.add.drive(notebookId, options)`](#add-google-drive-source) | [source-add-drive.ts](examples/source-add-drive.ts) |
398398
| Batch Add | Add multiple sources at once | [`sdk.sources.add.batch(notebookId, options)`](#batch-add-sources) | [source-add-batch.ts](examples/source-add-batch.ts) |
399399
| Web Search (Simple) | Search web and wait for results | [`sdk.sources.add.web.searchAndWait(notebookId, options)`](#web-search-simple) | [source-web-search.ts](examples/source-web-search.ts) |
400400
| Web Search (Advanced) | Multi-step web search workflow | [`sdk.sources.add.web.search()`](#web-search-advanced)`getResults()``addDiscovered()` | [source-web-search-advanced.ts](examples/source-web-search-advanced.ts) |
@@ -1056,6 +1056,8 @@ console.log(`Deleted ${result.count} notebooks: ${result.deleted.join(', ')}`)
10561056

10571057
### Share Notebook
10581058

1059+
> **⚠️ Experimental:** This feature is experimental and may have limitations or breaking changes in future versions.
1060+
10591061
**Method:** `sdk.notebooks.share(notebookId, options)`
10601062

10611063
**Example:** [notebook-share.ts](examples/notebook-share.ts)
@@ -1556,6 +1558,8 @@ const sourceId = await sdk.sources.add.youtube('notebook-id', {
15561558

15571559
### Add Google Drive Source
15581560

1561+
> **⚠️ Experimental:** This feature is experimental and may have limitations or breaking changes in future versions.
1562+
15591563
**Method:** `sdk.sources.add.drive(notebookId, options)`
15601564

15611565
**Parameters:**
@@ -1613,7 +1617,7 @@ Adds multiple sources at once. Supports mixed source types (URLs, text, files, Y
16131617
- `{ type: 'text', title: string, content: string }` - Text source
16141618
- `{ type: 'file', content: Buffer | string, fileName: string, mimeType?: string }` - File source
16151619
- `{ type: 'youtube', urlOrId: string, title?: string }` - YouTube source
1616-
- `{ type: 'gdrive', fileId: string, title?: string, mimeType?: string }` - Google Drive source
1620+
- `{ type: 'gdrive', fileId: string, title?: string, mimeType?: string }` - Google Drive source <small>⚠️ Experimental</small>
16171621

16181622
**Usage:**
16191623
```typescript
@@ -1660,12 +1664,12 @@ const sourceIds = await sdk.sources.add.batch('notebook-id', {
16601664

16611665
**Source Types:**
16621666
- `SearchSourceType.WEB` - Search web (default)
1663-
- `SearchSourceType.GOOGLE_DRIVE` - Search Google Drive (FAST mode only)
1667+
- `SearchSourceType.GOOGLE_DRIVE` - Search Google Drive (FAST mode only) <small>⚠️ Experimental</small>
16641668

16651669
**Return Fields:**
16661670
- `sessionId: string` - Required for adding sources (use with `addDiscovered()`)
16671671
- `web: DiscoveredWebSource[]` - Discovered web sources
1668-
- `drive: DiscoveredDriveSource[]` - Discovered Google Drive sources
1672+
- `drive: DiscoveredDriveSource[]` - Discovered Google Drive sources <small>⚠️ Experimental</small>
16691673

16701674
<details>
16711675
<summary><strong>Notes</strong></summary>

examples/notebook-share.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ async function main() {
130130
let sdk: Awaited<ReturnType<typeof createSDK>> | null = null;
131131

132132
try {
133+
console.log('⚠️ EXPERIMENTAL FEATURE: Notebook Sharing\n');
134+
console.log('⚠️ This feature is experimental and may have limitations or breaking changes.\n');
133135
console.log('=== Notebook Sharing ===\n');
134136

135137
// Get notebook ID

examples/source-add-drive.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ async function main() {
152152
try {
153153
await sdk.connect(); // Initialize SDK with authentication
154154

155+
console.log('⚠️ EXPERIMENTAL FEATURE: Google Drive Source\n');
156+
console.log('⚠️ This feature is experimental and may have limitations or breaking changes.\n');
155157
console.log('=== Adding Google Drive Source ===\n');
156158

157159
// Prompt for required fields

0 commit comments

Comments
 (0)