Skip to content

Commit

Permalink
edit/add readme for saas examples (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
QianZhu authored Apr 8, 2024
1 parent a14e975 commit bb1e91e
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 4 deletions.
3 changes: 2 additions & 1 deletion examples/RAG_Reranking/lancedb_cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ os.environ["LANCEDB_API_KEY"] = getpass.getpass("Enter Your LANCEDB API Key:")

replace the following lines in main.py with your project slug and api key"
```
db_url = "db://your-project-name"
db_url="db://your-project-slug-name"
api_key="sk_..."
region="us-east-1"
```

### Run the script
Expand Down
28 changes: 28 additions & 0 deletions examples/js-transformers/lancedb_cloud/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Vector embedding search using TransformersJS
![image](https://github.com/lancedb/vectordb-recipes/assets/43097991/41c1dea3-ad28-42c1-969f-a81146f202e9)


### Set credentials
if you would like to set api key through an environment variable:
```
export LANCEDB_API_KEY="sk_..."
```

replace the following lines in index.js with your project slug and api key"
```
db_url: "db://your-project-slug-name"
api_key: "sk_..."
region: "us-east-1"
```

### Setup
Install node dependencies
```javascript
npm install
```

### Javascript
Run the script
```javascript
node index.js
```
5 changes: 3 additions & 2 deletions examples/movie-recommender/lancedb_cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ export LANCEDB_API_KEY="sk_..."

replace the following lines in main.py with your project slug and api key"
```
db_url = "db://your-project-name"
api_key="sk_..."
db_url="db://your-project-slug-name"
api_key="sk_..."
region="us-east-1"
```

### Python
Expand Down
3 changes: 2 additions & 1 deletion examples/product-recommender/lancedb_cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ os.environ["LANCEDB_API_KEY"] = getpass.getpass("Enter Your LANCEDB API Key:")

replace the following lines in main.py with your project slug and api key"
```
db_url = "db://your-project-name"
db_url="db://your-project-slug-name"
api_key="sk_..."
region="us-east-1"
```

Run the script
Expand Down

0 comments on commit bb1e91e

Please sign in to comment.