Skip to content

Conversation

@wenjin272
Copy link
Collaborator

@wenjin272 wenjin272 commented Jan 23, 2026

No

Purpose of change

Update document for vector store.

Tests

No

API

No

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

@github-actions github-actions bot added priority/major Default priority of the PR or issue. fixVersion/0.2.0 The feature or bug should be implemented/fixed in the 0.2.0 version. doc-included Your PR already contains the necessary documentation updates. labels Jan 23, 2026
Copy link
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wenjin272
After adding the collection and document management operations, the overall structure of this doc become a bit weird.

I'd suggest to re-organize the structure as follows:

  • Overview
    • use cases: practically current content of the overview section
    • concepts / terminology: explain what is collection & document
  • How to use
    • declare: decorators & resource descriptors
    • query
    • manage collections
    • manage documents
  • bulit-in providers
  • custom providers

The text contents look good to me.

Args:
collection_name: The target collection. If not provided, use defualt collection.
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code snippet is an example of MyVectorStore that implements BaseVectorStore. It's not an interface declaration. In that sense, implementation should be provided for all these methods.

The implementation can be a simple demonstration, like:

def size(self, ...):
    size = ...
    return size

or

def delete(self, ...):
    // delete the document
    pass

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.2.0 The feature or bug should be implemented/fixed in the 0.2.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants