Merge main/ion 281

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Publish new release
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: Type of release (see the semantic versioning guides if you need help determining the appropriate choice)
+        type: choice
+        default: patch
+        # see https://python-poetry.org/docs/cli/#version for more options if we want to enhance the release workflow
+        options:
+          - patch
+          - minor
+          - major
+jobs:
+  publish-release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+      - name: Set up python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: .python-version
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: "1.6.1"
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      - name: upgrade library version
+        id: upgrade-version
+        run: |
+         poetry version ${{ github.event.inputs.release_type }} -s \
+         | awk '{ print "version_tag=v" $1 }' >> $GITHUB_OUTPUT
+      - name: commit version upgrade to main
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: main
+          commit_message: 🏷️ prepare version ${{ steps.upgrade-version.outputs.version_tag }} for release
+          tagging_message: ${{ steps.upgrade-version.outputs.version_tag }}
+      - name: create release for new version tag
+        uses: ncipollo/release-action@v1
+        with:
+          generateReleaseNotes: true
+          tag: ${{ steps.upgrade-version.outputs.version_tag }}
+      - name: Build release
+        id: build-release
+        run: poetry build
+      - name: Publish version to PyPI
+        id: publish-release
+        # TODO investigate OIDC https://docs.pypi.org/trusted-publishers/
+        run: poetry publish -u __token__ -p ${{ secrets.PYPI_API_TOKEN }}
+

.python-version

@@ -0,0 +1 @@
+3.8.10

README.md

@@ -1,15 +1,72 @@
 # 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.
 
 ## 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.
+
+We currently support python 3.8.10 and above, but if you need support for a lower version, please open an issue and we will add support.
+
+You can install the package from PyPI using `pip`:
+
+```sh
+python3 -m pip install ionic-langchain
+```
+
+or `poetry`:
+
+```sh
+poetry add ionic-langchain
+```
 
 ## Usage
 
-Pre-release. Do not use this.
+```python
+import os
+from typing import List
+
+from ionic_langchain.tool import IonicTool
+from langchain.agents import AgentType, Tool
+from langchain.agents import initialize_agent
+from langchain.chat_models import ChatOpenAI
+
+tools =  [
+    IonicTool().tool(),
+    # your other tools,
+]
+
+agent = initialize_agent(
+    tools=tools,
+    llm=ChatOpenAI(openai_api_key="your_key_here", temperature=0.7),
+    agent=AgentType.CHAT_ZERO_SHOT_REACT_DESCRIPTION,
+    handle_parsing_errors=True,
+    verbose=True,
+)
+
+
+input = "Where can I get tide pods"
+
+agent.run(input=input)
+```
+
+_Please see the [langchain agent docs](https://python.langchain.com/docs/modules/agents/) for more details on how to build and run agents_
+
+### Customizing the SDK
+
+`ionic_langchain.tool.IonicTool`'s constructor accepts an instance of `ionic_langchain.tool.Ionic`, a wrapper around [our SDK](https://pypi.org/project/Ionic-API-SDK/).  `ionic_langchain.tool.Ionic`, in turn accepts an  instance of that SDK, so you can provide the tool with a custom configuration:
+
+```python
+import os
+from ionic.sdk import Ionic as IonicSDK
+from ionic_langchain.tool import Ionic, IonicTool
+
+
+sdk = IonicSDK(api_key_header=os.environ.get("IONIC_API_KEY"))
+ionic = Ionic(sdk=sdk)
+tool = IonicTool(ionic=ionic).tool()
+```
 
 ## Development
 
-Pre-release. Do not use this.
+Coming soon. Please feel free to open an issue.

ionic_langchain/prompt.py

@@ -1,19 +1,11 @@
 TOOL_PROMPT = """
-    Ionic is an ecommerce shopping tool. Assistant uses the Ionic Shopping tool to find, discover, and compare products from thousands of online retailers. Assistant should use the tool when the user is looking for a product recommendation or trying to find a specific product.
+    Ionic is an ecommerce shopping tool. Assistant uses the Ionic Commerce Shopping Tool to find, discover, and compare products from thousands of online retailers. Assistant should use the tool when the user is looking for a product recommendation or trying to find a specific product.
 
     Ionic Tool input is a stringified List of each search value, for example `['coffee beans']` or `['coffee beans', 'coffee grinder']` and returns results for each search.
 
     If the human asks for what items are needed for an activity or project, you can provide product recommendations alongside your response about the required items instead of waiting for the user to follow up after. 
     For example, if the user asks 'what do I need to go camping?', you would compile your list of product requirements for camping (e.g. 'tent', 'stove', 'sleeping bag'), and before responding to user you might use Ionic Tool for
-    recommendations on those items. Avoid using Ionic for general topics like 'camping gear' when you or the user have already begun listing specific items. If the user's request is broad or vague, you should ask clarifying questions before using tool.
-
-    You should build the query input based on the latest topic of conversation. If a new topic or product search is started, you would create a new query.
-
-    If you get an error while attempting to create a response due to the message being too long, reduce the number of products by 1 and try again until it succeeds. 
-
-    Always include the debug token provided by the API below the recommendations.
+    recommendations on those items. Avoid using Ionic for general topics like 'camping gear' when you or the user have already begun listing specific items. If the user's request is broad or vague, you should ask clarifying questions before using tool. You should build the query input based on the latest topic of conversation. If a new topic or product search is started, you would create a new query.
 
     Always end your message with a friendly message asking if the user is satisfied with the results or if they have additional requirements.
-
-    DO NOT SEARCH GOOGLE OR AMAZON OR ANY OTHER WEBSITE. ONLY USE IONIC FOR SHOPPING
 """