Skip to content

Commit 869c525

Browse files
authored
Update README.md for the GDrive example for live update capability. (#253)
1 parent 7ea8c26 commit 869c525

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

examples/gdrive_text_embedding/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Simple example for cocoindex: build embedding index based on Google Drive files.
1+
This example builds embedding index based on Google Drive files.
2+
It continuously updates the index as files are added / updated / deleted in the source folders:
3+
it keeps the index in sync with the source folders effortlessly.
24

35
## Prerequisite
46

@@ -25,35 +27,39 @@ Before running the example, you need to:
2527

2628
Install dependencies:
2729

28-
```bash
30+
```sh
2931
pip install -e .
3032
```
3133

3234
Setup:
3335

34-
```bash
36+
```sh
3537
python main.py cocoindex setup
3638
```
3739

38-
Update index:
39-
40-
```bash
41-
python main.py cocoindex update
42-
```
43-
4440
Run:
4541

46-
```bash
42+
```sh
4743
python main.py
4844
```
4945

46+
During running, it will keep observing changes in the source folders and update the index automatically.
47+
At the same time, it accepts queries from the terminal, and performs search on top of the up-to-date index.
48+
49+
5050
## CocoInsight
5151
CocoInsight is in Early Access now (Free) 😊 You found us! A quick 3 minute video tutorial about CocoInsight: [Watch on YouTube](https://youtu.be/ZnmyoHslBSc?si=pPLXWALztkA710r9).
5252

5353
Run CocoInsight to understand your RAG data pipeline:
5454

55-
```
55+
```sh
5656
python main.py cocoindex server -c https://cocoindex.io
5757
```
5858

59+
You can also add a `-L` flag to make the server keep updating the index to reflect source changes at the same time:
60+
61+
```sh
62+
python main.py cocoindex server -c https://cocoindex.io -L
63+
```
64+
5965
Then open the CocoInsight UI at [https://cocoindex.io/cocoinsight](https://cocoindex.io/cocoinsight).

0 commit comments

Comments
 (0)