Skip to content

Commit

Permalink
Merge pull request #18 from upstash/DX-762
Browse files Browse the repository at this point in the history
docs: update readme
  • Loading branch information
ogzhanolguncu authored Mar 19, 2024
2 parents 1cbbb6e + 79f4c75 commit 35c1993
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Upstash Vector Node.js Client · ![license](https://img.shields.io/npm/l/%40upstash%2Fvector) [![Tests](https://github.com/upstash/vector-js/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/vector-js/actions/workflows/tests.yaml) ![npm (scoped)](https://img.shields.io/npm/v/@upstash/vector) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/vector) ![npm weekly download](https://img.shields.io/npm/dw/%40upstash%2Fvector)

> [!NOTE]
> **This project is in GA Stage.**
> [!NOTE] > **This project is in GA Stage.**
>
> The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes. The Upstash team is committed to maintaining and improving its functionality.
Expand Down Expand Up @@ -69,8 +68,11 @@ const results = await index.query<Metadata>({
includeVectors: true,
includeMetadata: true
topK: 1,
filter: "genre = 'fantasy' and title = 'Lord of the Rings'"
})

// If you wanna learn more about filtering check: [Metadata Filtering](https://upstash.com/docs/vector/features/filtering)

//Update Data
await index.upsert({
id: "upstash-rocks",
Expand Down Expand Up @@ -107,6 +109,10 @@ await index.info();
await index.random();
```

## Metadata Filtering

If you wanna learn more about filtering check: [Metadata Filtering](https://upstash.com/docs/vector/features/filtering)

## Troubleshooting

We have a [Discord](upstash.com/discord) for common problems. If you can't find a solution, please [open an issue](https://github.com/upstash/vector-js/issues/new).
Expand Down
Binary file modified bun.lockb
Binary file not shown.

0 comments on commit 35c1993

Please sign in to comment.