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.

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

Dedicated docs for Record Managers #4416

Closed
MJDeligan opened this issue Feb 15, 2024 · 6 comments
Closed

Dedicated docs for Record Managers #4416

MJDeligan opened this issue Feb 15, 2024 · 6 comments
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@MJDeligan
Copy link
Contributor

Following discussions on #4409 and #4398 and the introduction of a new integration in #4321, it might be worth to have dedicated doc pages for record managers to better highlight their usage and particularities.

Copy link

dosubot bot commented Feb 15, 2024

🤖

That sounds like a great idea! If you're interested in contributing to the documentation for record managers, feel free to create a pull request with your proposed changes. Your insights and contributions would be valuable in improving the documentation for this feature. Thank you for considering this contribution!

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@dosubot dosubot bot added the auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Feb 15, 2024
@mkesper
Copy link

mkesper commented Feb 15, 2024

What I find confusing re the API is that PostgresRecordManager and PGVectorStore seem to be completely unrelated, when, in fact, they aren't (at least for my understanding).

@MJDeligan
Copy link
Contributor Author

The record manager is what enables the Indexing function to have memory of what documents have already been vectorised and when. This way we can tell the vector store to only re-vectorise new/changed documents and delete old ones. So PGVectorStore and PostgresRecordManager work together (and can even share the same database) to achieve the indexing behaviour, but the specific implementation of vector store and record manager does not matter. You could just as well use a Pinecone vector store with the PostgresRecordManager or swap the record manager for the SQLiteRecordManager. Vectorstores are also used independently whereas the record managers are only used with the Indexing API

@jacoblee93
Copy link
Collaborator

I agree! I would be down to add something under https://js.langchain.com/docs/integrations/components/indexing!

I can have a look at adding some pages next week. As a heads up, we are also looking into a more unified abstraction as well (vectorstores, indexes, docstores) for this type of pipeline workflow.

@MJDeligan
Copy link
Contributor Author

I can have a look at adding some pages next week. As a heads up, we are also looking into a more unified abstraction as well (vectorstores, indexes, docstores) for this type of pipeline workflow.

Sounds great! Let me know if I can help.

@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label May 20, 2024
Copy link

dosubot bot commented May 20, 2024

Hi, @MJDeligan,

I'm helping the langchainjs team manage their backlog and am marking this issue as stale. From what I understand, the issue proposes creating dedicated documentation pages for record managers to better showcase their usage and unique features. There have been discussions and the introduction of a new integration, with users expressing interest in contributing to the documentation and discussing the relationship between PostgresRecordManager and PGVectorStore. However, it seems that the issue remains unresolved at this time.

Could you please confirm if this issue is still relevant to the latest version of the langchainjs repository? If it is, please let the langchainjs team know by commenting on the issue. Otherwise, feel free to close the issue yourself, or it will be automatically closed in 7 days. Thank you!

@dosubot dosubot bot closed this as not planned Won't fix, can't repro, duplicate, stale May 31, 2024
@dosubot dosubot bot removed the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

No branches or pull requests

3 participants