| Name | llama-index-tools-ionic-shopping JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | llama-index tools ionic shopping integration |
| upload_time | 2024-08-22 07:33:29 |
| maintainer | stewartjarod |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Tools Integration: Ionic Shopping
```bash
pip install llama-index-tools-ionic-shopping
```
[Ionic](https://ioniccommerce.com) is a plug and play ecommerce marketplace for AI Assistants.
By including the Ionic Tool in your agent, you are effortlessly providing your users with the ability
to shop and transact directly within your agent, and you’ll get a cut of the transaction.
## Attribution
Llearn more about how [Ionic attributes sales](https://docs.ioniccommerce.com/guides/attribution)
to your agent. Provide your Ionic API Key when instantiating the tool:
```python
from llama_index.tools.ionic_shopping import IonicShoppingToolSpec
ionic_tool = IonicShoppingToolSpec(api_key="<my Ionic API Key>").to_tool_list()
```
## Usage
Try it out using the [Jupyter notebook](https://github.com/run-llama/llama_index/blob/main/llama-index-integrations/tools/llama-index-tools-ionic-shopping/examples/ionic_shopping.ipynb).
```python
import openai
from llama_index.core.agent import (
OpenAIAgent,
) # requires llama-index-agent-openai
from llama_index.tools.ionic_shopping import IonicShoppingToolSpec
openai.api_key = "sk-api-key"
ionic_tool = IonicShoppingToolSpec(api_key="<my Ionic API Key>").to_tool_list()
agent = OpenAIAgent.from_tools(ionic_tool)
print(
agent.chat(
"I'm looking for a 5k monitor can you find me 3 options between $600 and $1000"
)
)
```
`query`: used to search for products and to get product recommendations
Your users can use natural language to specify how many results they would like to see
and what their budget is.
For more information on setting up your Agent with Ionic, see the [Ionic documentation](https://docs.ioniccommerce.com).
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-tools-ionic-shopping",
"maintainer": "stewartjarod",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/5a/43/1a94eccc87b92785a132d26d76bd70e66afcd5b9864159fa782fa78a527e/llama_index_tools_ionic_shopping-0.2.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Tools Integration: Ionic Shopping\n\n```bash\npip install llama-index-tools-ionic-shopping\n```\n\n[Ionic](https://ioniccommerce.com) is a plug and play ecommerce marketplace for AI Assistants.\nBy including the Ionic Tool in your agent, you are effortlessly providing your users with the ability\nto shop and transact directly within your agent, and you\u2019ll get a cut of the transaction.\n\n## Attribution\n\nLlearn more about how [Ionic attributes sales](https://docs.ioniccommerce.com/guides/attribution)\nto your agent. Provide your Ionic API Key when instantiating the tool:\n\n```python\nfrom llama_index.tools.ionic_shopping import IonicShoppingToolSpec\n\nionic_tool = IonicShoppingToolSpec(api_key=\"<my Ionic API Key>\").to_tool_list()\n```\n\n## Usage\n\nTry it out using the [Jupyter notebook](https://github.com/run-llama/llama_index/blob/main/llama-index-integrations/tools/llama-index-tools-ionic-shopping/examples/ionic_shopping.ipynb).\n\n```python\nimport openai\nfrom llama_index.core.agent import (\n OpenAIAgent,\n) # requires llama-index-agent-openai\nfrom llama_index.tools.ionic_shopping import IonicShoppingToolSpec\n\nopenai.api_key = \"sk-api-key\"\n\nionic_tool = IonicShoppingToolSpec(api_key=\"<my Ionic API Key>\").to_tool_list()\n\nagent = OpenAIAgent.from_tools(ionic_tool)\nprint(\n agent.chat(\n \"I'm looking for a 5k monitor can you find me 3 options between $600 and $1000\"\n )\n)\n```\n\n`query`: used to search for products and to get product recommendations\n\nYour users can use natural language to specify how many results they would like to see\nand what their budget is.\n\nFor more information on setting up your Agent with Ionic, see the [Ionic documentation](https://docs.ioniccommerce.com).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index tools ionic shopping integration",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9652ae2a4464dd348d584b0c46f3c0595c63b614ae87860eb7662b7d8bb7b615",
"md5": "541bda0a559b6b0ba8abc7b19a62957f",
"sha256": "d027a9e48dd57d25cf24aaed904895dacb901f68a4bdc55b8884e98373097c96"
},
"downloads": -1,
"filename": "llama_index_tools_ionic_shopping-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "541bda0a559b6b0ba8abc7b19a62957f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3170,
"upload_time": "2024-08-22T07:33:28",
"upload_time_iso_8601": "2024-08-22T07:33:28.361259Z",
"url": "https://files.pythonhosted.org/packages/96/52/ae2a4464dd348d584b0c46f3c0595c63b614ae87860eb7662b7d8bb7b615/llama_index_tools_ionic_shopping-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a431a94eccc87b92785a132d26d76bd70e66afcd5b9864159fa782fa78a527e",
"md5": "129f439db44036fdef34a402457ba2fb",
"sha256": "52501423876aeb23aafb69a02de48fd3b03f0004055addc5f859b6f00cbde467"
},
"downloads": -1,
"filename": "llama_index_tools_ionic_shopping-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "129f439db44036fdef34a402457ba2fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 2852,
"upload_time": "2024-08-22T07:33:29",
"upload_time_iso_8601": "2024-08-22T07:33:29.707294Z",
"url": "https://files.pythonhosted.org/packages/5a/43/1a94eccc87b92785a132d26d76bd70e66afcd5b9864159fa782fa78a527e/llama_index_tools_ionic_shopping-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 07:33:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-tools-ionic-shopping"
}
