📖 [ION-283] document langchain tool #5
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
added 2 commits
December 21, 2023 13:49
Idea here being we control which SDK version is being used but allow developers to have higher patch versions of langchain. https://python-poetry.org/docs/dependency-specification/#tilde-requirements
gmkohler
requested review from
gwitwer,
jdmccarty,
owensims1 and
stewartjarod
gmkohler
commented
Dec 21, 2023
| # Ionic Langchain | ||
|
|
||
| Pre-release. Do not use this. | ||
| Ionic Langchain provides a wrapper around the Ionic Commerce's SDK for use as a `Tool` in a custom Langchain agent. This tool will enable e-commerce for your agent, allowing your users to ask for product recommendations and purchase products through the agent chat interface. |
Contributor
Author
There was a problem hiding this comment.
@jdmccarty I opted to write my own copy here but please suggest improvements. As a developer the website copy doesn't tell me a lot in plain english about what the tool is doing.
gmkohler
commented
Dec 21, 2023
| ## Usage | ||
|
|
||
| Pre-release. Do not use this. | ||
| ```python |
Contributor
Author
There was a problem hiding this comment.
more or less adapting what we have written in our demobot; happy to make modifications.
gmkohler
commented
Dec 21, 2023
| ## Installation | ||
|
|
||
| Pre-release. Do not use this. | ||
| This tool requires at least `langchain@0.0.350` and can work with any greater patch release the `0.0.x` series. |
Contributor
Author
There was a problem hiding this comment.
I've never written a public package; not sure about python version compatibility or how we should be managing that. I figure we don't need that right away but IMO worth figuring out.
Contributor
There was a problem hiding this comment.
We should only support the latest LTS for the start.
When someone pays us money and needs a specific version that's another story imo.
gmkohler
commented
Dec 21, 2023
| readme = "README.md" | ||
| packages = [{include = "ionic_langchain"}] | ||
|
|
||
| [tool.poetry.dependencies] |
Contributor
Author
There was a problem hiding this comment.
Do we want to add more metadata here in the effort towards publishing on PyPI?
https://packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata
gmkohler
commented
Dec 21, 2023
stewartjarod
approved these changes
Dec 21, 2023
gmkohler
changed the title
gmkohler
changed the title
Closed
stewartjarod
added a commit
that referenced
this pull request
Jan 18, 2024
* 📦 upgrade SDK to 0.5.3 (#3) * tests * 📦 update ionic-sdk-python * 🏷️ bump version * inject ionic into tool (#4) * let ionic be injected into tool * 🏷️ bump version * 📖 [ION-283] document langchain tool (#5) * 📦 fleixble langchain dependency; pinned sdk Idea here being we control which SDK version is being used but allow developers to have higher patch versions of langchain. https://python-poetry.org/docs/dependency-specification/#tilde-requirements * 📖 first pass at documentation * Update README.md * 👷♂️📦🏷️ [ION-285] workflow for publishing new releases (#7) * 👷♂️📦 workflow for publishing new releases Right now this requires manually bumping poetry and creating a git release but I added a couple of guardrails so that we ensure we only publish when the poetry package version matches the github release reference. Future iteration will move the version bumping and release cutting to the workflow. * 🏷️ bump verison to 0.1.3 want something to test with when this merges * set workflow up for iterative testing * dry run for publishing * warn instead of fail if tag checks fail * 👷♂️ [ION-285] release publication workflow fixups (#8) * 📌 pin python version * 🐛 use ref_name instead of ref ref is a lot longer, e.g. 'refs/heads/gmkohler/ION-285' found with debug logging * 🏷️ bump patch version want to compare with new release * 👷♂️ [ION-285] Revert "set workflow up for iterative testing" (#10) * Revert "set workflow up for iterative testing" This reverts commit 49cc39f. * 🏷️ bump version to 0.1.5 want to test the release guardrails * 👷♂️ [ION-285] adjust github expressions (#11) * tidy expressions up think it all needs to be interpolated * 🏷️ poetry version patch need to verify new changes * 👷♂️ [ION-285] automate version bumping / tagging in release workflow (#9) * 👷♂️ bump version within workflow * ☑️ use type: choice for release input This should enforce a dropdown * fix release-action name * tidy release step * 🏷️ prepare version v0.1.7 for release * 🏷️ prepare version v0.1.8 for release * 📖 add sentence re: python version support (#12) * 📖 install library from PyPI instead of GitHub (#13) * Reduce min python version (#14) * version * readme * whoops * working example (#15) --------- Co-authored-by: Gregory M Kohler <gregory@ionicapi.com> Co-authored-by: gmkohler <gmkohler@users.noreply.github.com> Co-authored-by: Owen Sims <owen@ionicapi.com>
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.
Not sure what should live in here versus mintlify.
Any and all suggestions are welcome for improving the docs.
I broke out "publish" into a separate ticket ION-285. If we make the repo private after publishing to PyPI then I'd imagine we should move all of this to Mintlify and change these docs to focus on developing it.