From 075c92764a04f841f1d7a2ac03287ff0b957a503 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Thu, 21 Dec 2023 11:37:45 -0800
Subject: [PATCH 01/14] =?UTF-8?q?=F0=9F=93=A6=20upgrade=20SDK=20to=200.5.3?=
 =?UTF-8?q?=20(#3)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* tests

* 📦 update ionic-sdk-python

* 🏷️ bump version
---
 ionic_langchain/tool.py  | 20 ++++++++--------
 poetry.lock              |  6 ++---
 pyproject.toml           |  2 +-
 tests/test_ionic.py      | 51 ++++++++++++++++++++++++++++++++++++++++
 tests/test_ionic_tool.py | 13 ++++++++++
 5 files changed, 78 insertions(+), 14 deletions(-)
 create mode 100644 tests/test_ionic.py
 create mode 100644 tests/test_ionic_tool.py

diff --git a/ionic_langchain/tool.py b/ionic_langchain/tool.py
index 6983cb5..e601850 100644
--- a/ionic_langchain/tool.py
+++ b/ionic_langchain/tool.py
@@ -1,5 +1,5 @@
 import dataclasses
-from typing import Any
+from typing import Any, Optional
 
 from ionic import Ionic as IonicSDK
 from ionic.models.components import QueryAPIRequest, Query
@@ -12,26 +12,26 @@
 class Ionic:
     _sdk: IonicSDK
 
-    def __init__(self):
-        self._sdk = IonicSDK()
+    def __init__(self, sdk: Optional[IonicSDK] = None):
+        if sdk:
+            self._sdk = sdk
+        else:
+            self._sdk = IonicSDK()
 
-    def query(self, queries: str) -> dict[str, Any]:
+    def query(self, queries: str) -> list[dict[str, Any]]:
         """
         FIXME: handle non-200 responses
         TODO: better typing in response
         """
         request = QueryAPIRequest(
-            queries=[
-                Query(query=query)
-                for query in queries.split(", ")
-            ],
+            queries=[Query(query=query) for query in queries.split(", ")],
         )
         response: QueryResponse = self._sdk.query(
             request=request,
             security=QuerySecurity(),
         )
 
-        return dataclasses.asdict(response)
+        return [dataclasses.asdict(r) for r in response.query_api_response.results]
 
 
 # TODO StructuredTool or BaseTool
@@ -50,5 +50,5 @@ def tool(self) -> Tool:
             func=self._ionic.query,
             name="Ionic Shopping",
             description=TOOL_PROMPT,
-            verbose=True
+            verbose=True,
         )
diff --git a/poetry.lock b/poetry.lock
index 4f9eb22..0f4c314 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -453,13 +453,13 @@ files = [
 
 [[package]]
 name = "ionic-api-sdk"
-version = "0.5.2"
+version = "0.5.3"
 description = "Python Client SDK"
 optional = false
 python-versions = ">=3.8"
 files = [
-    {file = "Ionic-API-SDK-0.5.2.tar.gz", hash = "sha256:c52df7e680628bafb685b8af8f1332eebaa6d3c1df749a82fe6930285a0efc65"},
-    {file = "Ionic_API_SDK-0.5.2-py3-none-any.whl", hash = "sha256:9508ba1cb63ff8f366acac3455f73fd3a4d0afde639b48f24559b20e3f1aea15"},
+    {file = "Ionic-API-SDK-0.5.3.tar.gz", hash = "sha256:f57e9e6150b0839d34eafbc8e2039b5bdfdb0eb8a87f8ccf72c4501104297f08"},
+    {file = "Ionic_API_SDK-0.5.3-py3-none-any.whl", hash = "sha256:afa5e3f8bf66e809d30180133ad04d896465dbeeaeee1bb24bad0bc651383722"},
 ]
 
 [package.dependencies]
diff --git a/pyproject.toml b/pyproject.toml
index 505d5c4..5b57bd5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.0"
+version = "0.1.1"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"
diff --git a/tests/test_ionic.py b/tests/test_ionic.py
new file mode 100644
index 0000000..dbaff34
--- /dev/null
+++ b/tests/test_ionic.py
@@ -0,0 +1,51 @@
+import pytest
+from ionic import Ionic as IonicSdk
+from ionic.models.errors import HTTPValidationError
+
+from ionic_langchain.tool import Ionic
+
+
+def test_ionic_num_results():
+    """
+    requires server to be running (i.e. not compatible with CI)
+    """
+    ionic = Ionic(
+        sdk=IonicSdk(server_url="http://localhost:8080"),
+    )
+    results = ionic.query(queries="Reindeer Jerky, Salmon Jerky")
+
+    assert len(results) == 2, "results are returned for each query"
+    reindeer_jerky_result = results[0]
+    assert (
+        reindeer_jerky_result["query"]["query"] == "Reindeer Jerky"
+    ), "query should be included in response object"
+    assert reindeer_jerky_result["query"]["num_results"] is None
+    assert reindeer_jerky_result["query"]["max_price"] is None
+    assert reindeer_jerky_result["query"]["min_price"] is None
+    assert "products" in reindeer_jerky_result
+    assert (
+        len(reindeer_jerky_result["products"]) == 5
+    ), "num_results should be the server default"
+
+
+@pytest.mark.skip("we aren't yet passing in the validated params")
+def test_ionic_bad_input():
+    """
+    requires server to be running
+    """
+    ionic = Ionic(
+        sdk=IonicSdk(
+            server_url="http://localhost:8080",
+        ),
+    )
+
+    with pytest.raises(HTTPValidationError) as exc_info:
+        ionic.query(queries="")
+
+    problems = [det.loc[-1] for det in exc_info.value.detail]
+    assert len(problems) == 3, "all problems are included in error"
+    assert sorted(problems) == [
+        "max_price",
+        "min_price",
+        "num_results",
+    ]
diff --git a/tests/test_ionic_tool.py b/tests/test_ionic_tool.py
new file mode 100644
index 0000000..ecee650
--- /dev/null
+++ b/tests/test_ionic_tool.py
@@ -0,0 +1,13 @@
+import pytest
+
+from ionic_langchain.tool import IonicTool
+
+
+def test_ionic_tool_is_valid():
+    """
+    sanity check to ensure tool is valid
+    """
+    try:
+        IonicTool().tool()
+    except Exception:
+        pytest.fail("unexpected exception %s initializing IonicTool#tool")
\ No newline at end of file

From fcb7ee8ed868f632c6ba11c72aed47b3ec53d3ff Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Thu, 21 Dec 2023 11:49:33 -0800
Subject: [PATCH 02/14] inject ionic into tool (#4)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* let ionic be injected into tool

* 🏷️ bump version
---
 ionic_langchain/tool.py | 7 +++++--
 pyproject.toml          | 2 +-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/ionic_langchain/tool.py b/ionic_langchain/tool.py
index e601850..03b1c47 100644
--- a/ionic_langchain/tool.py
+++ b/ionic_langchain/tool.py
@@ -42,8 +42,11 @@ def query(self, queries: str) -> list[dict[str, Any]]:
 class IonicTool:
     _ionic: Ionic
 
-    def __init__(self):
-        self._ionic = Ionic()
+    def __init__(self, ionic: Optional[Ionic] = None):
+        if ionic:
+            self._ionic = ionic
+        else:
+            self._ionic = Ionic()
 
     def tool(self) -> Tool:
         return Tool(
diff --git a/pyproject.toml b/pyproject.toml
index 5b57bd5..814e31b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.1"
+version = "0.1.2"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 1ad389b86b70812e022f710f9e9895a41190b3b6 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Tue, 2 Jan 2024 10:47:49 -0800
Subject: [PATCH 03/14] =?UTF-8?q?=F0=9F=93=96=20[ION-283]=20document=20lan?=
 =?UTF-8?q?gchain=20tool=20(#5)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 📦 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
---
 README.md      | 67 +++++++++++++++++++++++++++++++++++++++++++++++---
 poetry.lock    | 10 ++++----
 pyproject.toml |  4 +--
 3 files changed, 70 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index a24e0ac..82bacab 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,74 @@
 # 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.
+
+You can install the package from GitHub using `pip`:
+
+```sh
+python3 -m pip install git+https://github.com/ioniccommerce/ionic_langchain.git#v0.1.2
+```
+
+or `poetry`:
+
+```sh
+poetry add git+https://github.com/ioniccommerce/ionic_langchain.git#v0.1.2
+```
 
 ## 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
+from langchain.memory import ConversationBufferWindowMemory, RedisChatMessageHistory
+
+
+tools: List[Tool] =  [
+    IonicTool().tool(),
+    # others,
+]
+redis_memory = RedisChatMessageHistory(url=os.environ.get("REDIS_URL"),session_id="chatId"),
+memory = ConversationBufferWindowMemory(
+    k=12,
+    return_messages=True,
+    chat_memory=redis_memory,
+    memory_key="chat_history",
+)
+
+agent = initialize_agent(
+    tools=tools,
+    llm=ChatOpenAI(openai_api_key=os.environ.get("OPENAI_API_KEY"),temperature=0.5),
+    agent=AgentType.CHAT_CONVERSATIONAL_REACT_DESCRIPTION,
+    memory=memory,
+    handle_parsing_errors=True,
+    verbose=True,
+)
+
+agent.run(input="Roadhouse VHS")
+```
+### 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.
+Ionic Langchain is not currently accepting external contributions.  Contact us via [this form](https://ionicapi.com/contact) if you would like to contribute.
diff --git a/poetry.lock b/poetry.lock
index 0f4c314..41fb9cc 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -519,13 +519,13 @@ files = [
 
 [[package]]
 name = "langchain"
-version = "0.0.350"
+version = "0.0.352"
 description = "Building applications with LLMs through composability"
 optional = false
 python-versions = ">=3.8.1,<4.0"
 files = [
-    {file = "langchain-0.0.350-py3-none-any.whl", hash = "sha256:11b605f325a4271a7815baaec05bc7622e3ad1f10f26b05c752cafa27663ed38"},
-    {file = "langchain-0.0.350.tar.gz", hash = "sha256:f0e68a92d200bb722586688ab7b411b2430bd98ad265ca03b264e7e7acbb6c01"},
+    {file = "langchain-0.0.352-py3-none-any.whl", hash = "sha256:43ab580e1223e5d7c3495b3c0cb79e2f3a0ecb52caf8126271fb10d42cede2d0"},
+    {file = "langchain-0.0.352.tar.gz", hash = "sha256:8928d7b63d73af9681fe1b2a2b99b84238efef61ed537de666160fd001f41efd"},
 ]
 
 [package.dependencies]
@@ -534,7 +534,7 @@ dataclasses-json = ">=0.5.7,<0.7"
 jsonpatch = ">=1.33,<2.0"
 langchain-community = ">=0.0.2,<0.1"
 langchain-core = ">=0.1,<0.2"
-langsmith = ">=0.0.63,<0.1.0"
+langsmith = ">=0.0.70,<0.1.0"
 numpy = ">=1,<2"
 pydantic = ">=1,<3"
 PyYAML = ">=5.3"
@@ -1292,4 +1292,4 @@ multidict = ">=4.0"
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.11"
-content-hash = "34ba224fd185ba84f4c6142a1924b934d6944d4713e6d298392f57c9ae7cd2a3"
+content-hash = "57edf40b36d52151927170f79c7fa0e91a8c9d67c83c24de084340b23e93a098"
diff --git a/pyproject.toml b/pyproject.toml
index 814e31b..65b209d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,8 +8,8 @@ packages = [{include = "ionic_langchain"}]
 
 [tool.poetry.dependencies]
 python = "^3.11"
-langchain = "0.0.350"
-ionic-api-sdk = "^0.5.2"
+langchain = "~0.0.352"
+ionic-api-sdk = "0.5.2"
 
 
 [build-system]

From 77d7363c3958612d0e2330da4ebe2792795db9aa Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Wed, 3 Jan 2024 14:07:14 -0800
Subject: [PATCH 04/14] =?UTF-8?q?=F0=9F=91=B7=E2=80=8D=E2=99=82=EF=B8=8F?=
 =?UTF-8?q?=F0=9F=93=A6=F0=9F=8F=B7=EF=B8=8F=20[ION-285]=20workflow=20for?=
 =?UTF-8?q?=20publishing=20new=20releases=20(#7)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 👷‍♂️📦 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
---
 .github/workflows/release.yml | 47 +++++++++++++++++++++++++++++++++++
 pyproject.toml                |  2 +-
 2 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/release.yml

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 0000000..baff34a
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,47 @@
+on:
+  workflow_dispatch:
+jobs:
+  publish-release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Ensure valid tag reference
+        if: ${{ github.ref_type != 'tag' }} || ${{ !startsWith(github.ref_name, 'v') }}
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.notice('you can only run the publish workflow from a release tag (vX.Y.Z)')
+      - 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: output library version
+        id: output-version
+        # prefix with v to match tag convention
+        run: poetry version -s | awk '{ print "version=v" $1 }' >> $GITHUB_OUTPUT
+      - name: check library version
+        if: ${{ steps.output-version.outputs.version }} != ${{ github.ref }}
+        id: check-version
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.notice('library version does not match the github tag')
+      - name: Build release
+        id: build-release
+        run: poetry build
+      - name: Publish version to PyPI
+        id: publish-release
+        run: poetry publish -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} --dry-run
+
diff --git a/pyproject.toml b/pyproject.toml
index 65b209d..cfdb03c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.2"
+version = "0.1.3"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 577e1e73a7fd101ce0aa703f4ef2f7a0d9e488c0 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Wed, 3 Jan 2024 14:29:56 -0800
Subject: [PATCH 05/14] =?UTF-8?q?=F0=9F=91=B7=E2=80=8D=E2=99=82=EF=B8=8F?=
 =?UTF-8?q?=20[ION-285]=20release=20publication=20workflow=20fixups=20(#8)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 📌 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
---
 .github/workflows/release.yml | 3 ++-
 .python-version               | 1 +
 pyproject.toml                | 2 +-
 3 files changed, 4 insertions(+), 2 deletions(-)
 create mode 100644 .python-version

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index baff34a..14abe39 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,3 +1,4 @@
+name: Publish new release
 on:
   workflow_dispatch:
 jobs:
@@ -32,7 +33,7 @@ jobs:
         # prefix with v to match tag convention
         run: poetry version -s | awk '{ print "version=v" $1 }' >> $GITHUB_OUTPUT
       - name: check library version
-        if: ${{ steps.output-version.outputs.version }} != ${{ github.ref }}
+        if: ${{ steps.output-version.outputs.version }} != ${{ github.ref_name }}
         id: check-version
         uses: actions/github-script@v7
         with:
diff --git a/.python-version b/.python-version
new file mode 100644
index 0000000..92536a9
--- /dev/null
+++ b/.python-version
@@ -0,0 +1 @@
+3.12.0
diff --git a/pyproject.toml b/pyproject.toml
index cfdb03c..8a11015 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.3"
+version = "0.1.4"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From c22a8c0de71f2828abf1e61520fe480e4bec4097 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Wed, 3 Jan 2024 14:55:48 -0800
Subject: [PATCH 06/14] =?UTF-8?q?=F0=9F=91=B7=E2=80=8D=E2=99=82=EF=B8=8F?=
 =?UTF-8?q?=20[ION-285]=20Revert=20"set=20workflow=20up=20for=20iterative?=
 =?UTF-8?q?=20testing"=20(#10)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Revert "set workflow up for iterative testing"

This reverts commit 49cc39f1aad62e3bfa37dad07d4ef7e608679323.

* 🏷️ bump version to 0.1.5

want to test the release guardrails
---
 .github/workflows/release.yml | 6 +++---
 pyproject.toml                | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 14abe39..a5e7242 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -12,7 +12,7 @@ jobs:
         uses: actions/github-script@v7
         with:
           script: |
-            core.notice('you can only run the publish workflow from a release tag (vX.Y.Z)')
+            core.setFailed('you can only run the publish workflow from a release tag (vX.Y.Z)')
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
@@ -38,11 +38,11 @@ jobs:
         uses: actions/github-script@v7
         with:
           script: |
-            core.notice('library version does not match the github tag')
+            core.setFailed('library version does not match the github tag')
       - name: Build release
         id: build-release
         run: poetry build
       - name: Publish version to PyPI
         id: publish-release
-        run: poetry publish -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} --dry-run
+        run: poetry publish -u __token__ -p ${{ secrets.PYPI_API_TOKEN }}
 
diff --git a/pyproject.toml b/pyproject.toml
index 8a11015..39d8639 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.4"
+version = "0.1.5"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 640c6024cc68515fea8e6d804d8336ff95b1e88e Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Wed, 3 Jan 2024 15:02:01 -0800
Subject: [PATCH 07/14] =?UTF-8?q?=F0=9F=91=B7=E2=80=8D=E2=99=82=EF=B8=8F?=
 =?UTF-8?q?=20[ION-285]=20adjust=20github=20expressions=20(#11)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* tidy expressions up

think it all needs to be interpolated

* 🏷️ poetry version patch

need to verify new changes
---
 .github/workflows/release.yml | 4 ++--
 pyproject.toml                | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index a5e7242..c3d55ed 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Ensure valid tag reference
-        if: ${{ github.ref_type != 'tag' }} || ${{ !startsWith(github.ref_name, 'v') }}
+        if: ${{ github.ref_type != 'tag' || !startsWith(github.ref_name, 'v') }}
         uses: actions/github-script@v7
         with:
           script: |
@@ -33,7 +33,7 @@ jobs:
         # prefix with v to match tag convention
         run: poetry version -s | awk '{ print "version=v" $1 }' >> $GITHUB_OUTPUT
       - name: check library version
-        if: ${{ steps.output-version.outputs.version }} != ${{ github.ref_name }}
+        if: ${{ steps.output-version.outputs.version != github.ref_name }}
         id: check-version
         uses: actions/github-script@v7
         with:
diff --git a/pyproject.toml b/pyproject.toml
index 39d8639..0101ea9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.5"
+version = "0.1.6"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 1271e23b98eefc5338ab2bdc6b1cec21c7f53809 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Wed, 3 Jan 2024 16:05:16 -0800
Subject: [PATCH 08/14] =?UTF-8?q?=F0=9F=91=B7=E2=80=8D=E2=99=82=EF=B8=8F?=
 =?UTF-8?q?=20[ION-285]=20automate=20version=20bumping=20/=20tagging=20in?=
 =?UTF-8?q?=20release=20workflow=20(#9)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 👷‍♂️ bump version within workflow

* ☑️ use type: choice for release input

This should enforce a dropdown

* fix release-action name

* tidy release step
---
 .github/workflows/release.yml | 42 ++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index c3d55ed..783d1e4 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,18 +1,22 @@
 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: Ensure valid tag reference
-        if: ${{ github.ref_type != 'tag' || !startsWith(github.ref_name, 'v') }}
-        uses: actions/github-script@v7
-        with:
-          script: |
-            core.setFailed('you can only run the publish workflow from a release tag (vX.Y.Z)')
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
@@ -28,21 +32,27 @@ jobs:
           virtualenvs-create: true
           virtualenvs-in-project: true
           installer-parallel: true
-      - name: output library version
-        id: output-version
-        # prefix with v to match tag convention
-        run: poetry version -s | awk '{ print "version=v" $1 }' >> $GITHUB_OUTPUT
-      - name: check library version
-        if: ${{ steps.output-version.outputs.version != github.ref_name }}
-        id: check-version
-        uses: actions/github-script@v7
+      - 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:
-          script: |
-            core.setFailed('library version does not match the github tag')
+          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 }}
 

From cba93e9d83b5e810f83bd28a490d2e196489e2aa Mon Sep 17 00:00:00 2001
From: gmkohler <gmkohler@users.noreply.github.com>
Date: Thu, 4 Jan 2024 00:06:09 +0000
Subject: [PATCH 09/14] =?UTF-8?q?=F0=9F=8F=B7=EF=B8=8F=20prepare=20version?=
 =?UTF-8?q?=20v0.1.7=20for=20release?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 pyproject.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 0101ea9..6956bb6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.6"
+version = "0.1.7"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 1b42669be5d479cbb00ff33ddd664a812302daa2 Mon Sep 17 00:00:00 2001
From: gmkohler <gmkohler@users.noreply.github.com>
Date: Thu, 4 Jan 2024 17:28:07 +0000
Subject: [PATCH 10/14] =?UTF-8?q?=F0=9F=8F=B7=EF=B8=8F=20prepare=20version?=
 =?UTF-8?q?=20v0.1.8=20for=20release?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 pyproject.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 6956bb6..793bbaa 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ionic-langchain"
-version = "0.1.7"
+version = "0.1.8"
 description = ""
 authors = ["Owen Sims <owen@ionicapi.com>"]
 readme = "README.md"

From 443489be0e7f88fa990bf191e857719cf44e3e49 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Mon, 8 Jan 2024 11:36:41 -0800
Subject: [PATCH 11/14] =?UTF-8?q?=F0=9F=93=96=20add=20sentence=20re:=20pyt?=
 =?UTF-8?q?hon=20version=20support=20(#12)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 82bacab..67b132f 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ Ionic Langchain provides a wrapper around the Ionic Commerce's SDK for use as a
 
 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.11 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 GitHub using `pip`:
 
 ```sh

From 2f6d5c4c06bbffcea2d8f56166f5b3ad32aee932 Mon Sep 17 00:00:00 2001
From: Gregory M Kohler <gregory@ionicapi.com>
Date: Mon, 8 Jan 2024 11:40:58 -0800
Subject: [PATCH 12/14] =?UTF-8?q?=F0=9F=93=96=20install=20library=20from?=
 =?UTF-8?q?=20PyPI=20instead=20of=20GitHub=20(#13)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 67b132f..5db66b9 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,16 @@ This tool requires at least `langchain@0.0.350` and can work with any greater pa
 
 We currently support python 3.11 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 GitHub using `pip`:
+You can install the package from PyPI using `pip`:
 
 ```sh
-python3 -m pip install git+https://github.com/ioniccommerce/ionic_langchain.git#v0.1.2
+python3 -m pip install ionic-langchain
 ```
 
 or `poetry`:
 
 ```sh
-poetry add git+https://github.com/ioniccommerce/ionic_langchain.git#v0.1.2
+poetry add ionic-langchain
 ```
 
 ## Usage

From 76d04484ed29950bec5f8e66c1f0706104414f9c Mon Sep 17 00:00:00 2001
From: Owen Sims <owen@ionicapi.com>
Date: Mon, 8 Jan 2024 14:54:44 -0500
Subject: [PATCH 13/14] Reduce min python version (#14)

* version

* readme

* whoops
---
 .python-version           |   2 +-
 README.md                 |   4 +-
 ionic_langchain/prompt.py |  12 +--
 ionic_langchain/tool.py   |   9 +-
 poetry.lock               | 194 +++++++++++++++++++++++++++-----------
 pyproject.toml            |   3 +-
 6 files changed, 148 insertions(+), 76 deletions(-)

diff --git a/.python-version b/.python-version
index 92536a9..d20cc2b 100644
--- a/.python-version
+++ b/.python-version
@@ -1 +1 @@
-3.12.0
+3.8.10
diff --git a/README.md b/README.md
index 5db66b9..7966cb2 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Ionic Langchain provides a wrapper around the Ionic Commerce's SDK for use as a
 
 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.11 and above, but if you need support for a lower version, please open an issue and we will add support.
+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`:
 
@@ -73,4 +73,4 @@ tool = IonicTool(ionic=ionic).tool()
 
 ## Development
 
-Ionic Langchain is not currently accepting external contributions.  Contact us via [this form](https://ionicapi.com/contact) if you would like to contribute.
+Coming soon. Please feel free to open an issue.
diff --git a/ionic_langchain/prompt.py b/ionic_langchain/prompt.py
index 05397df..9159d3d 100644
--- a/ionic_langchain/prompt.py
+++ b/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
 """
diff --git a/ionic_langchain/tool.py b/ionic_langchain/tool.py
index 03b1c47..b0acd09 100644
--- a/ionic_langchain/tool.py
+++ b/ionic_langchain/tool.py
@@ -18,7 +18,7 @@ def __init__(self, sdk: Optional[IonicSDK] = None):
         else:
             self._sdk = IonicSDK()
 
-    def query(self, queries: str) -> list[dict[str, Any]]:
+    def query(self, queries: str) -> list:
         """
         FIXME: handle non-200 responses
         TODO: better typing in response
@@ -34,11 +34,6 @@ def query(self, queries: str) -> list[dict[str, Any]]:
         return [dataclasses.asdict(r) for r in response.query_api_response.results]
 
 
-# TODO StructuredTool or BaseTool
-# https://github.com/langchain-ai/langchain/issues/4197
-# https://python.langchain.com/docs/modules/agents/tools/multi_input_tool
-
-
 class IonicTool:
     _ionic: Ionic
 
@@ -51,7 +46,7 @@ def __init__(self, ionic: Optional[Ionic] = None):
     def tool(self) -> Tool:
         return Tool(
             func=self._ionic.query,
-            name="Ionic Shopping",
+            name="Ionic Commerce Shopping Tool",
             description=TOOL_PROMPT,
             verbose=True,
         )
diff --git a/poetry.lock b/poetry.lock
index 41fb9cc..12f3a03 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand.
 
 [[package]]
 name = "aiohttp"
@@ -87,6 +87,7 @@ files = [
 
 [package.dependencies]
 aiosignal = ">=1.1.2"
+async-timeout = {version = ">=4.0,<5.0", markers = "python_version < \"3.11\""}
 attrs = ">=17.3.0"
 frozenlist = ">=1.1.1"
 multidict = ">=4.5,<7.0"
@@ -120,6 +121,9 @@ files = [
     {file = "annotated_types-0.6.0.tar.gz", hash = "sha256:563339e807e53ffd9c267e99fc6d9ea23eb8443c08f112651963e24e22f84a5d"},
 ]
 
+[package.dependencies]
+typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.9\""}
+
 [[package]]
 name = "anyio"
 version = "4.2.0"
@@ -132,14 +136,27 @@ files = [
 ]
 
 [package.dependencies]
+exceptiongroup = {version = ">=1.0.2", markers = "python_version < \"3.11\""}
 idna = ">=2.8"
 sniffio = ">=1.1"
+typing-extensions = {version = ">=4.1", markers = "python_version < \"3.11\""}
 
 [package.extras]
 doc = ["Sphinx (>=7)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"]
 test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (>=0.17)"]
 trio = ["trio (>=0.23)"]
 
+[[package]]
+name = "async-timeout"
+version = "4.0.3"
+description = "Timeout context manager for asyncio programs"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "async-timeout-4.0.3.tar.gz", hash = "sha256:4640d96be84d82d02ed59ea2b7105a0f7b33abe8703703cd0ab0bf87c427522f"},
+    {file = "async_timeout-4.0.3-py3-none-any.whl", hash = "sha256:7405140ff1230c310e51dc27b3145b9092d659ce68ff733fb0cefe3ee42be028"},
+]
+
 [[package]]
 name = "attrs"
 version = "23.1.0"
@@ -268,6 +285,17 @@ files = [
     {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"},
 ]
 
+[[package]]
+name = "colorama"
+version = "0.4.6"
+description = "Cross-platform colored terminal text."
+optional = false
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+files = [
+    {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
+    {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
+]
+
 [[package]]
 name = "dataclasses-json"
 version = "0.6.3"
@@ -283,6 +311,20 @@ files = [
 marshmallow = ">=3.18.0,<4.0.0"
 typing-inspect = ">=0.4.0,<1"
 
+[[package]]
+name = "exceptiongroup"
+version = "1.2.0"
+description = "Backport of PEP 654 (exception groups)"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "exceptiongroup-1.2.0-py3-none-any.whl", hash = "sha256:4bfd3996ac73b41e9b9628b04e079f193850720ea5945fc96a08633c66912f14"},
+    {file = "exceptiongroup-1.2.0.tar.gz", hash = "sha256:91f5c769735f051a4290d52edd0858999b57e5876e9f85937691bd4c9fa3ed68"},
+]
+
+[package.extras]
+test = ["pytest (>=6)"]
+
 [[package]]
 name = "frozenlist"
 version = "1.4.1"
@@ -451,15 +493,26 @@ files = [
     {file = "idna-3.6.tar.gz", hash = "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca"},
 ]
 
+[[package]]
+name = "iniconfig"
+version = "2.0.0"
+description = "brain-dead simple config-ini parsing"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
+    {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
+]
+
 [[package]]
 name = "ionic-api-sdk"
-version = "0.5.3"
+version = "0.5.2"
 description = "Python Client SDK"
 optional = false
 python-versions = ">=3.8"
 files = [
-    {file = "Ionic-API-SDK-0.5.3.tar.gz", hash = "sha256:f57e9e6150b0839d34eafbc8e2039b5bdfdb0eb8a87f8ccf72c4501104297f08"},
-    {file = "Ionic_API_SDK-0.5.3-py3-none-any.whl", hash = "sha256:afa5e3f8bf66e809d30180133ad04d896465dbeeaeee1bb24bad0bc651383722"},
+    {file = "Ionic-API-SDK-0.5.2.tar.gz", hash = "sha256:c52df7e680628bafb685b8af8f1332eebaa6d3c1df749a82fe6930285a0efc65"},
+    {file = "Ionic_API_SDK-0.5.2-py3-none-any.whl", hash = "sha256:9508ba1cb63ff8f366acac3455f73fd3a4d0afde639b48f24559b20e3f1aea15"},
 ]
 
 [package.dependencies]
@@ -530,6 +583,7 @@ files = [
 
 [package.dependencies]
 aiohttp = ">=3.8.3,<4.0.0"
+async-timeout = {version = ">=4.0.0,<5.0.0", markers = "python_version < \"3.11\""}
 dataclasses-json = ">=0.5.7,<0.7"
 jsonpatch = ">=1.33,<2.0"
 langchain-community = ">=0.0.2,<0.1"
@@ -737,47 +791,39 @@ files = [
 
 [[package]]
 name = "numpy"
-version = "1.26.2"
+version = "1.24.4"
 description = "Fundamental package for array computing in Python"
 optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.8"
 files = [
-    {file = "numpy-1.26.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:3703fc9258a4a122d17043e57b35e5ef1c5a5837c3db8be396c82e04c1cf9b0f"},
-    {file = "numpy-1.26.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:cc392fdcbd21d4be6ae1bb4475a03ce3b025cd49a9be5345d76d7585aea69440"},
-    {file = "numpy-1.26.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:36340109af8da8805d8851ef1d74761b3b88e81a9bd80b290bbfed61bd2b4f75"},
-    {file = "numpy-1.26.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bcc008217145b3d77abd3e4d5ef586e3bdfba8fe17940769f8aa09b99e856c00"},
-    {file = "numpy-1.26.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:3ced40d4e9e18242f70dd02d739e44698df3dcb010d31f495ff00a31ef6014fe"},
-    {file = "numpy-1.26.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b272d4cecc32c9e19911891446b72e986157e6a1809b7b56518b4f3755267523"},
-    {file = "numpy-1.26.2-cp310-cp310-win32.whl", hash = "sha256:22f8fc02fdbc829e7a8c578dd8d2e15a9074b630d4da29cda483337e300e3ee9"},
-    {file = "numpy-1.26.2-cp310-cp310-win_amd64.whl", hash = "sha256:26c9d33f8e8b846d5a65dd068c14e04018d05533b348d9eaeef6c1bd787f9919"},
-    {file = "numpy-1.26.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b96e7b9c624ef3ae2ae0e04fa9b460f6b9f17ad8b4bec6d7756510f1f6c0c841"},
-    {file = "numpy-1.26.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:aa18428111fb9a591d7a9cc1b48150097ba6a7e8299fb56bdf574df650e7d1f1"},
-    {file = "numpy-1.26.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:06fa1ed84aa60ea6ef9f91ba57b5ed963c3729534e6e54055fc151fad0423f0a"},
-    {file = "numpy-1.26.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:96ca5482c3dbdd051bcd1fce8034603d6ebfc125a7bd59f55b40d8f5d246832b"},
-    {file = "numpy-1.26.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:854ab91a2906ef29dc3925a064fcd365c7b4da743f84b123002f6139bcb3f8a7"},
-    {file = "numpy-1.26.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f43740ab089277d403aa07567be138fc2a89d4d9892d113b76153e0e412409f8"},
-    {file = "numpy-1.26.2-cp311-cp311-win32.whl", hash = "sha256:a2bbc29fcb1771cd7b7425f98b05307776a6baf43035d3b80c4b0f29e9545186"},
-    {file = "numpy-1.26.2-cp311-cp311-win_amd64.whl", hash = "sha256:2b3fca8a5b00184828d12b073af4d0fc5fdd94b1632c2477526f6bd7842d700d"},
-    {file = "numpy-1.26.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:a4cd6ed4a339c21f1d1b0fdf13426cb3b284555c27ac2f156dfdaaa7e16bfab0"},
-    {file = "numpy-1.26.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5d5244aabd6ed7f312268b9247be47343a654ebea52a60f002dc70c769048e75"},
-    {file = "numpy-1.26.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6a3cdb4d9c70e6b8c0814239ead47da00934666f668426fc6e94cce869e13fd7"},
-    {file = "numpy-1.26.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aa317b2325f7aa0a9471663e6093c210cb2ae9c0ad824732b307d2c51983d5b6"},
-    {file = "numpy-1.26.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:174a8880739c16c925799c018f3f55b8130c1f7c8e75ab0a6fa9d41cab092fd6"},
-    {file = "numpy-1.26.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:f79b231bf5c16b1f39c7f4875e1ded36abee1591e98742b05d8a0fb55d8a3eec"},
-    {file = "numpy-1.26.2-cp312-cp312-win32.whl", hash = "sha256:4a06263321dfd3598cacb252f51e521a8cb4b6df471bb12a7ee5cbab20ea9167"},
-    {file = "numpy-1.26.2-cp312-cp312-win_amd64.whl", hash = "sha256:b04f5dc6b3efdaab541f7857351aac359e6ae3c126e2edb376929bd3b7f92d7e"},
-    {file = "numpy-1.26.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:4eb8df4bf8d3d90d091e0146f6c28492b0be84da3e409ebef54349f71ed271ef"},
-    {file = "numpy-1.26.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1a13860fdcd95de7cf58bd6f8bc5a5ef81c0b0625eb2c9a783948847abbef2c2"},
-    {file = "numpy-1.26.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:64308ebc366a8ed63fd0bf426b6a9468060962f1a4339ab1074c228fa6ade8e3"},
-    {file = "numpy-1.26.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baf8aab04a2c0e859da118f0b38617e5ee65d75b83795055fb66c0d5e9e9b818"},
-    {file = "numpy-1.26.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d73a3abcac238250091b11caef9ad12413dab01669511779bc9b29261dd50210"},
-    {file = "numpy-1.26.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:b361d369fc7e5e1714cf827b731ca32bff8d411212fccd29ad98ad622449cc36"},
-    {file = "numpy-1.26.2-cp39-cp39-win32.whl", hash = "sha256:bd3f0091e845164a20bd5a326860c840fe2af79fa12e0469a12768a3ec578d80"},
-    {file = "numpy-1.26.2-cp39-cp39-win_amd64.whl", hash = "sha256:2beef57fb031dcc0dc8fa4fe297a742027b954949cabb52a2a376c144e5e6060"},
-    {file = "numpy-1.26.2-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:1cc3d5029a30fb5f06704ad6b23b35e11309491c999838c31f124fee32107c79"},
-    {file = "numpy-1.26.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:94cc3c222bb9fb5a12e334d0479b97bb2df446fbe622b470928f5284ffca3f8d"},
-    {file = "numpy-1.26.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:fe6b44fb8fcdf7eda4ef4461b97b3f63c466b27ab151bec2366db8b197387841"},
-    {file = "numpy-1.26.2.tar.gz", hash = "sha256:f65738447676ab5777f11e6bbbdb8ce11b785e105f690bc45966574816b6d3ea"},
+    {file = "numpy-1.24.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:c0bfb52d2169d58c1cdb8cc1f16989101639b34c7d3ce60ed70b19c63eba0b64"},
+    {file = "numpy-1.24.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ed094d4f0c177b1b8e7aa9cba7d6ceed51c0e569a5318ac0ca9a090680a6a1b1"},
+    {file = "numpy-1.24.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:79fc682a374c4a8ed08b331bef9c5f582585d1048fa6d80bc6c35bc384eee9b4"},
+    {file = "numpy-1.24.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ffe43c74893dbf38c2b0a1f5428760a1a9c98285553c89e12d70a96a7f3a4d6"},
+    {file = "numpy-1.24.4-cp310-cp310-win32.whl", hash = "sha256:4c21decb6ea94057331e111a5bed9a79d335658c27ce2adb580fb4d54f2ad9bc"},
+    {file = "numpy-1.24.4-cp310-cp310-win_amd64.whl", hash = "sha256:b4bea75e47d9586d31e892a7401f76e909712a0fd510f58f5337bea9572c571e"},
+    {file = "numpy-1.24.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f136bab9c2cfd8da131132c2cf6cc27331dd6fae65f95f69dcd4ae3c3639c810"},
+    {file = "numpy-1.24.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e2926dac25b313635e4d6cf4dc4e51c8c0ebfed60b801c799ffc4c32bf3d1254"},
+    {file = "numpy-1.24.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:222e40d0e2548690405b0b3c7b21d1169117391c2e82c378467ef9ab4c8f0da7"},
+    {file = "numpy-1.24.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7215847ce88a85ce39baf9e89070cb860c98fdddacbaa6c0da3ffb31b3350bd5"},
+    {file = "numpy-1.24.4-cp311-cp311-win32.whl", hash = "sha256:4979217d7de511a8d57f4b4b5b2b965f707768440c17cb70fbf254c4b225238d"},
+    {file = "numpy-1.24.4-cp311-cp311-win_amd64.whl", hash = "sha256:b7b1fc9864d7d39e28f41d089bfd6353cb5f27ecd9905348c24187a768c79694"},
+    {file = "numpy-1.24.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1452241c290f3e2a312c137a9999cdbf63f78864d63c79039bda65ee86943f61"},
+    {file = "numpy-1.24.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:04640dab83f7c6c85abf9cd729c5b65f1ebd0ccf9de90b270cd61935eef0197f"},
+    {file = "numpy-1.24.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a5425b114831d1e77e4b5d812b69d11d962e104095a5b9c3b641a218abcc050e"},
+    {file = "numpy-1.24.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd80e219fd4c71fc3699fc1dadac5dcf4fd882bfc6f7ec53d30fa197b8ee22dc"},
+    {file = "numpy-1.24.4-cp38-cp38-win32.whl", hash = "sha256:4602244f345453db537be5314d3983dbf5834a9701b7723ec28923e2889e0bb2"},
+    {file = "numpy-1.24.4-cp38-cp38-win_amd64.whl", hash = "sha256:692f2e0f55794943c5bfff12b3f56f99af76f902fc47487bdfe97856de51a706"},
+    {file = "numpy-1.24.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:2541312fbf09977f3b3ad449c4e5f4bb55d0dbf79226d7724211acc905049400"},
+    {file = "numpy-1.24.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:9667575fb6d13c95f1b36aca12c5ee3356bf001b714fc354eb5465ce1609e62f"},
+    {file = "numpy-1.24.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f3a86ed21e4f87050382c7bc96571755193c4c1392490744ac73d660e8f564a9"},
+    {file = "numpy-1.24.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d11efb4dbecbdf22508d55e48d9c8384db795e1b7b51ea735289ff96613ff74d"},
+    {file = "numpy-1.24.4-cp39-cp39-win32.whl", hash = "sha256:6620c0acd41dbcb368610bb2f4d83145674040025e5536954782467100aa8835"},
+    {file = "numpy-1.24.4-cp39-cp39-win_amd64.whl", hash = "sha256:befe2bf740fd8373cf56149a5c23a0f601e82869598d41f8e188a0e9869926f8"},
+    {file = "numpy-1.24.4-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:31f13e25b4e304632a4619d0e0777662c2ffea99fcae2029556b17d8ff958aef"},
+    {file = "numpy-1.24.4-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95f7ac6540e95bc440ad77f56e520da5bf877f87dca58bd095288dce8940532a"},
+    {file = "numpy-1.24.4-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:e98f220aa76ca2a977fe435f5b04d7b3470c0a2e6312907b37ba6068f26787f2"},
+    {file = "numpy-1.24.4.tar.gz", hash = "sha256:80f5e3a4e498641401868df4208b74581206afbee7cf7b8329daae82676d9463"},
 ]
 
 [[package]]
@@ -791,6 +837,21 @@ files = [
     {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"},
 ]
 
+[[package]]
+name = "pluggy"
+version = "1.3.0"
+description = "plugin and hook calling mechanisms for python"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pluggy-1.3.0-py3-none-any.whl", hash = "sha256:d89c696a773f8bd377d18e5ecda92b7a3793cbe66c87060a6fb58c7b6e1061f7"},
+    {file = "pluggy-1.3.0.tar.gz", hash = "sha256:cf61ae8f126ac6f7c451172cf30e3e43d3ca77615509771b3a984a0730651e12"},
+]
+
+[package.extras]
+dev = ["pre-commit", "tox"]
+testing = ["pytest", "pytest-benchmark"]
+
 [[package]]
 name = "pydantic"
 version = "2.5.2"
@@ -927,6 +988,28 @@ files = [
 [package.dependencies]
 typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0"
 
+[[package]]
+name = "pytest"
+version = "7.4.4"
+description = "pytest: simple powerful testing with Python"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"},
+    {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "sys_platform == \"win32\""}
+exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
+iniconfig = "*"
+packaging = "*"
+pluggy = ">=0.12,<2.0"
+tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
+
+[package.extras]
+testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
+
 [[package]]
 name = "python-dateutil"
 version = "2.8.2"
@@ -953,7 +1036,6 @@ files = [
     {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"},
     {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"},
     {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"},
-    {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"},
     {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"},
     {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"},
     {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"},
@@ -961,15 +1043,8 @@ files = [
     {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"},
     {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"},
     {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"},
-    {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"},
     {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"},
     {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"},
-    {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"},
-    {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"},
-    {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"},
-    {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"},
-    {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"},
-    {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"},
     {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"},
     {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"},
     {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"},
@@ -986,7 +1061,6 @@ files = [
     {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"},
     {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"},
     {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"},
-    {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"},
     {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"},
     {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"},
     {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"},
@@ -994,7 +1068,6 @@ files = [
     {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"},
     {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"},
     {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"},
-    {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"},
     {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"},
     {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"},
     {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"},
@@ -1102,7 +1175,7 @@ files = [
 ]
 
 [package.dependencies]
-greenlet = {version = "!=0.4.17", markers = "platform_machine == \"aarch64\" or platform_machine == \"ppc64le\" or platform_machine == \"x86_64\" or platform_machine == \"amd64\" or platform_machine == \"AMD64\" or platform_machine == \"win32\" or platform_machine == \"WIN32\""}
+greenlet = {version = "!=0.4.17", markers = "platform_machine == \"win32\" or platform_machine == \"WIN32\" or platform_machine == \"AMD64\" or platform_machine == \"amd64\" or platform_machine == \"x86_64\" or platform_machine == \"ppc64le\" or platform_machine == \"aarch64\""}
 typing-extensions = ">=4.2.0"
 
 [package.extras]
@@ -1144,6 +1217,17 @@ files = [
 [package.extras]
 doc = ["reno", "sphinx", "tornado (>=4.5)"]
 
+[[package]]
+name = "tomli"
+version = "2.0.1"
+description = "A lil' TOML parser"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
+    {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
+]
+
 [[package]]
 name = "typing-extensions"
 version = "4.9.0"
@@ -1291,5 +1375,5 @@ multidict = ">=4.0"
 
 [metadata]
 lock-version = "2.0"
-python-versions = "^3.11"
-content-hash = "57edf40b36d52151927170f79c7fa0e91a8c9d67c83c24de084340b23e93a098"
+python-versions = "^3.8.10"
+content-hash = "d895f60bb14284bb061c4ff08b5316f6a34bc1bb9bedcb0c226e289cf1a7c20b"
diff --git a/pyproject.toml b/pyproject.toml
index 793bbaa..22dad75 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -7,9 +7,10 @@ readme = "README.md"
 packages = [{include = "ionic_langchain"}]
 
 [tool.poetry.dependencies]
-python = "^3.11"
+python = "^3.8.10"
 langchain = "~0.0.352"
 ionic-api-sdk = "0.5.2"
+pytest = "^7.4.4"
 
 
 [build-system]

From 569d83bef84250776dc2d250a18b8703219d9ebd Mon Sep 17 00:00:00 2001
From: Owen Sims <owen@ionicapi.com>
Date: Tue, 9 Jan 2024 13:34:19 -0500
Subject: [PATCH 14/14] working example (#15)

---
 README.md | 26 +++++++++++---------------
 1 file changed, 11 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 7966cb2..c29ce25 100644
--- a/README.md
+++ b/README.md
@@ -30,32 +30,28 @@ from ionic_langchain.tool import IonicTool
 from langchain.agents import AgentType, Tool
 from langchain.agents import initialize_agent
 from langchain.chat_models import ChatOpenAI
-from langchain.memory import ConversationBufferWindowMemory, RedisChatMessageHistory
 
-
-tools: List[Tool] =  [
+tools =  [
     IonicTool().tool(),
-    # others,
+    # your other tools,
 ]
-redis_memory = RedisChatMessageHistory(url=os.environ.get("REDIS_URL"),session_id="chatId"),
-memory = ConversationBufferWindowMemory(
-    k=12,
-    return_messages=True,
-    chat_memory=redis_memory,
-    memory_key="chat_history",
-)
 
 agent = initialize_agent(
     tools=tools,
-    llm=ChatOpenAI(openai_api_key=os.environ.get("OPENAI_API_KEY"),temperature=0.5),
-    agent=AgentType.CHAT_CONVERSATIONAL_REACT_DESCRIPTION,
-    memory=memory,
+    llm=ChatOpenAI(openai_api_key="your_key_here", temperature=0.7),
+    agent=AgentType.CHAT_ZERO_SHOT_REACT_DESCRIPTION,
     handle_parsing_errors=True,
     verbose=True,
 )
 
-agent.run(input="Roadhouse VHS")
+
+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: