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

DOC: Incorrect API Reference Link in /docs/how_to/vectorstore_retriever/ #27196

Closed
2 tasks done
PPraneesh opened this issue Oct 8, 2024 · 2 comments
Closed
2 tasks done
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@PPraneesh
Copy link

URL

https://python.langchain.com/docs/how_to/vectorstore_retriever/

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

There is an incorrect URL in the anchor tag for the VectorStoreRetriever class in the "How to use a vectorstore as a retriever" documentation page.
Location of the Issue :
The problematic link can be found in this section of the documentation:
https://python.langchain.com/docs/how_to/vectorstore_retriever/#:~:text=VectorStoreRetriever
Current (Incorrect) URL:
https://python.langchain.com/api_reference/core/vectorstores/langchain_core.vectorstores.VectorStoreRetriever.html
Correct URL:
https://python.langchain.com/api_reference/core/vectorstores/langchain_core.vectorstores.base.VectorStoreRetriever.html
The correct URL includes .base in the path, which is missing in the current documentation.

Idea or request for content:

Please update the markdown cell in the Jupyter notebook to use the correct URL for the VectorStoreRetriever class. The markdown should be modified as follows:

This creates a retriever (specifically a [VectorStoreRetriever](https://python.langchain.com/api_reference/core/vectorstores/langchain_core.vectorstores.base.VectorStoreRetriever.html)), which we can use in the usual way:
@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Oct 8, 2024
@PPraneesh PPraneesh changed the title DOC: Incorrect anchor tag URL for VectorStoreRetriever in Vector Store Retriever documentation DOC: Incorrect API Reference Link in /docs/how_to/vectorstore_retriever/ Oct 8, 2024
@connorpark24
Copy link
Contributor

I can fix this.

eyurtsev pushed a commit that referenced this issue Oct 19, 2024
#27477)

Description: updated docs
[here](https://python.langchain.com/docs/how_to/vectorstore_retriever/#:~:text=VectorStoreRetriever)
for creating VectorStoreRetrievers. The URL was missing a `.base`, and
now works as expected.

This was a fix for Issue #27196
@PPraneesh
Copy link
Author

This issue is resolved and merged
#27477

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

No branches or pull requests

2 participants