Skip to content

Commit

Permalink
Quick update to README re: list endpoint (#293)
Browse files Browse the repository at this point in the history
## Problem

It's often unclear to users that the `list` endpoint (i.e. query by
vector ID) does not necessarily return the vector that matches the
passed ID.

## Solution

Clarify that.

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [x] Non-code change (docs, etc)
- [ ] None of the above: (explain here)


---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
  - https://app.asana.com/0/0/1208439494339495
  • Loading branch information
aulorbe authored Oct 7, 2024
1 parent c2b24c8 commit 03de66c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,8 @@ const results = await index.query({ topK: 3, vector: [0.22, 0.66] });

#### Querying by record id

You can query using the vector values of an existing record in the index by passing a record id.
You can query using the vector values of an existing record in the index by passing a record ID. Please note that
the record with the specified ID [may be in this operation's response](https://docs.pinecone.io/troubleshooting/limitations-of-querying-by-id).

```typescript
import { Pinecone } from '@pinecone-database/pinecone';
Expand Down

0 comments on commit 03de66c

Please sign in to comment.