Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small fix in deleteAll documentation regardning namespaces #314

Merged
merged 3 commits into from
Dec 19, 2024
Merged

Small fix in deleteAll documentation regardning namespaces #314

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ae338a
Small fix in deleteAll documentation regardning namespaces
kehanzhang Nov 26, 2024
e42f86d
Quick fix to remove duplication
aulorbe Dec 19, 2024
6412fa1
Merge branch 'main' into main
aulorbe Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions src/data/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,8 @@ export class Index<T extends RecordMetadata = RecordMetadata> {
*
* await index.deleteAll();
*
* // Records from namespace 'foo' are now deleted. Records in other namespaces are not modified.
* // Records from the default namespace '' are now deleted. Records in other namespaces are not modified.
*
* await index.describeIndexStats();
* // {
* // namespaces: {
Expand All @@ -278,10 +279,6 @@ export class Index<T extends RecordMetadata = RecordMetadata> {
* // indexFullness: 0,
* // totalRecordCount: 1
* // }
*
* await index.deleteAll();
* // Since no namespace was specified, records in default namespace '' are now deleted.
*
* ```
* @throws {@link Errors.PineconeConnectionError} when network problems or an outage of Pinecone's APIs prevent the request from being completed.
* @returns A promise that resolves when the delete is completed.
Expand Down