Add README, pydoc and notebook #3
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
README.mdsection for installation and setup instructions for thelangchain-vectorizepackage.VectorizeRetrieverclass docstring to include detailed setup, initialization arguments, and usage examples.Code Enhancements:
VectorizeRetrieverin the__init__.pyfile and added it to the__all__list for easier access.Example Notebook:
langchain_retriever.ipynbdemonstrating how to use the LangChain Vectorize retriever, including setup, configuration, and usage examples.Usage Improvements:
invokemethod inVectorizeRetrieverto include a more descriptive query example.