Fix vector delete API documentation to show single key deletion

[devin-ai-integration]

Fix Vector Delete API Documentation to Show Single Key Deletion

Problem

The documentation for both JavaScript and Python SDKs incorrectly shows the vector delete API as supporting multiple IDs:

• JavaScript: delete(name: string, ...ids: string[])
• Python: delete(name: str, *ids: str)

However, the actual implementations in both SDKs only support single key deletion:

• JavaScript: delete(name: string, key: string)
• Python: delete(name: str, key: str)

This inconsistency was introduced when PR #125 in sdk-js was initially designed to support multiple IDs but was later reverted back to single key deletion based on backend API limitations. The documentation was never updated to reflect this change.

Solution

Updated all documentation to accurately reflect the single key deletion API:

Changes Made

1. JavaScript SDK API Reference (content/SDKs/javascript/api-reference.mdx)

   • Changed method signature from delete(name: string, ...ids: string[]) to delete(name: string, key: string)
   • Updated parameter description and example code
   • Clarified return value as 0 or 1

2. Python SDK API Reference (content/SDKs/python/api-reference.mdx)

   • Changed method signature from delete(name: str, *ids: str) to delete(name: str, key: str)
   • Updated parameter description and example code
   • Clarified return value as 0 or 1

3. JavaScript SDK Examples (content/SDKs/javascript/examples/index.mdx)

   • Fixed vector delete example to use single key deletion
   • Updated error messages and comments for clarity

4. Python SDK Examples (content/SDKs/python/examples/index.mdx)

   • Improved vector delete example for clarity
   • Updated variable names and comments

Verification

• Both SDK implementations already correctly use single key deletion
• Interface definitions in sdk-js types.ts already match the implementation
• All documentation now accurately reflects the actual API behavior
• Backend Catalyst API only supports single key deletion, confirming this is the correct approach

Link to Devin run

https://app.devin.ai/sessions/d6871f24d93e498baeada2ec360b1bec

Requested by

jhaynie@agentuity.com

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	docs	0f5880b	Commit Preview URL	Jun 10 2025, 02:40 PM