docs: add docloader codelab #18
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
the
api: cloudsql-mysql
kurtisvg
added
the
type: feature request
jackwotherspoon
requested changes
Feb 14, 2024
There was a problem hiding this comment.
@loeng2023 A few things on my second pass.
- I think we want to simplify this notebook and try to remove as many SQLAlchemy engine execution statements as possible. Ideally all
.executecommands happen internally in our library and users in this notebook only use our APIs. - Right now document saver and loader are quite intermingled. We should clean this up so that we follow the outline given by Averi. Basic usage should cover all DocLoader APIs and only show "load via table name" and "load via query". All document saver API ref and examples should be moved to
Advanced Usage
docs/document_loader.ipynb
Outdated
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "Save langchain documents with `MySQLDocumentSaver.add_documents(<documents>)`." |
There was a problem hiding this comment.
based on Averi's notebook doc Basic Usage should only cover the following:
- Setting up connection object, if needed
- Load via table name
- Load via query
Document saver should be in Advanced Usage.
There was a problem hiding this comment.
But we cannot load documents without saving them first. Moving saver into basic usage makes the demo experience smoother.
loeng2023
force-pushed
the
doc-loader-doc
branch
from
e1c8dc7 to
3176d57
Compare
kurtisvg
changed the title
kurtisvg
approved these changes
Feb 16, 2024
jackwotherspoon
approved these changes
Feb 16, 2024
loeng2023
force-pushed
the
doc-loader-doc
branch
from
597f9fc to
fd4b678
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/blob/doc-loader-doc/docs/document_loader.ipynb