Skip to content

Add README, pydoc and notebook #3

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

Merged
merged 1 commit into from
Apr 7, 2025
Merged

Add README, pydoc and notebook #3

merged 1 commit into from
Apr 7, 2025

Conversation

cbornet
Copy link
Collaborator

@cbornet cbornet commented Mar 22, 2025

This pull request introduces the LangChain integrations for using Vectorize, including updates to the documentation, code, and an example notebook. The most important changes are grouped by theme below.

Documentation and Setup:

  • Added a new README.md section for installation and setup instructions for the langchain-vectorize package.
  • Updated the VectorizeRetriever class docstring to include detailed setup, initialization arguments, and usage examples.

Code Enhancements:

  • Imported VectorizeRetriever in the __init__.py file and added it to the __all__ list for easier access.

Example Notebook:

  • Added a new Jupyter notebook langchain_retriever.ipynb demonstrating how to use the LangChain Vectorize retriever, including setup, configuration, and usage examples.

Usage Improvements:

  • Modified the invoke method in VectorizeRetriever to include a more descriptive query example.

@cbornet
Copy link
Collaborator Author

cbornet commented Apr 6, 2025

@nicoloboschi do you have time to review ?

Copy link
Collaborator

@nicoloboschi nicoloboschi left a comment

Choose a reason for hiding this comment

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

LGTM

@nicoloboschi nicoloboschi merged commit 0e870cc into main Apr 7, 2025
7 checks passed
@cbornet cbornet deleted the notebook branch April 7, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants