Added new type to retrieve document

[pec1985]

Summary by CodeRabbit

• New Features
  • Enhanced search results to include additional document and embeddings information, providing more detailed data when retrieving search results.

[coderabbitai]

Walkthrough

A new interface, VectorSearchResultWithDocument, was added to extend VectorSearchResult with optional document and embeddings properties. The get method in the VectorStorage interface was updated to return this new extended type, reflecting the inclusion of additional information in its result.

Changes

File(s)	Change Summary
src/types.ts	Added VectorSearchResultWithDocument interface; updated VectorStorage.get return type to use it

Suggested reviewers

• robindiddams
• NobbyBop

Poem

A hop and a skip, some types now enhanced,
With documents and vectors, our storage advanced.
The interface grows, new fields in tow,
Now queries return more than we used to know.
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 903ad28 and 614a786.

📒 Files selected for processing (1)

• src/types.ts (2 hunks)

🔇 Additional comments (3)

src/types.ts (3)

362-371: Well-designed interface extension.

The new VectorSearchResultWithDocument interface cleanly extends the base VectorSearchResult with optional properties for document content and embeddings. The optional nature of these fields provides flexibility while maintaining backward compatibility.

---

402-405: Consider consistency between get and search methods.

The get method now returns VectorSearchResultWithDocument while the search method still returns VectorSearchResult[]. This inconsistency might be intentional (e.g., for performance reasons in search), but please verify this design choice is appropriate for your use case.

Should the search method also return VectorSearchResultWithDocument[] for consistency, or is the current design intentional?

---

393-393: To broaden our search beyond ast-grep, let’s use rg to locate any references or implementations of VectorStorage and the old get signature:

#!/bin/bash
# 1. All occurrences of the VectorStorage interface
rg -n "VectorStorage" --glob '*.ts'

# 2. Classes implementing VectorStorage
rg -n "implements\s+VectorStorage" --glob '*.ts'

# 3. Any get methods still returning the old VectorSearchResult type
rg -n "get\(.*\):\s*Promise<\s*VectorSearchResult" --glob '*.ts'

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch VECTOR-TYPES

---

🪧 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? Create a ticket on our support page 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 docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for 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.