| Name | llama-index-packs-finchat JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | llama-index packs implementation of a hierarchical agent for finance chat. |
| upload_time | 2024-11-18 02:02:02 |
| maintainer | 345ishaan |
| docs_url | None |
| author | Ishan Gupta |
| requires_python | <3.12,>=3.9 |
| license | MIT |
| keywords |
agent
finance
finchat
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Finance Chat Llama Pack based on OpenAIAgent
This LlamaPack implements a hierarchical agent based on LLM for financial chat and information extraction purposed.
LLM agent is connected to various open financial apis as well as daily updated SP500 postgres SQL database storing
opening & closing price, volume as well as past earnings.
Based on the query, the agent reasons and routes to available tools or runs SQL query to retrieve information and
combine information to answer.
### Installation
```bash
pip install llama-index llama-index-packs-finchat
```
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack FinanceChatPack --download-dir ./finchat_pack
```
You can then inspect the files at `./finchat_pack` and use them as a template for your own project.
## Code Usage
You can download the pack to a the `./finchat_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
FinanceChatPack = download_llama_pack("FinanceChatPack", "./finchat_pack")
```
To use this tool, you'll need a few API keys:
- POLYGON_API_KEY -- <https://polygon.io/>
- FINNHUB_API_KEY -- <https://finnhub.io/>
- ALPHA_VANTAGE_API_KEY -- <https://www.alphavantage.co/>
- NEWSAPI_API_KEY -- <https://newsapi.org/>
- POSTGRES_DB_URI -- 'postgresql://postgres.xhlcobfkbhtwmckmszqp:fingptpassword#123@aws-0-us-east-1.pooler.supabase.com:5432/postgres' (You can also host your own postgres SQL DB with the same table signatures. To use different signatures, modification is required in giving query examples for SQL code generation.)
```python
fin_agent = FinanceChatPack(
POLYGON_API_KEY,
FINNHUB_API_KEY,
ALPHA_VANTAGE_API_KEY,
NEWSAPI_API_KEY,
OPENAI_API_KEY,
)
```
From here, you can use the pack, or inspect and modify the pack in `./finchat_pack`.
The `run()` function chats with the agent and sends the response of the input query.
```python
response = fin_agent.run("<query>")
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-packs-finchat",
"maintainer": "345ishaan",
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "agent, finance, finchat",
"author": "Ishan Gupta",
"author_email": "345ishaan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4e/c5/0c219fb3555ab5db253e902a6b1db940c049a1f6b3c46c78729220296994/llama_index_packs_finchat-0.3.0.tar.gz",
"platform": null,
"description": "# Finance Chat Llama Pack based on OpenAIAgent\n\nThis LlamaPack implements a hierarchical agent based on LLM for financial chat and information extraction purposed.\n\nLLM agent is connected to various open financial apis as well as daily updated SP500 postgres SQL database storing\nopening & closing price, volume as well as past earnings.\n\nBased on the query, the agent reasons and routes to available tools or runs SQL query to retrieve information and\ncombine information to answer.\n\n### Installation\n\n```bash\npip install llama-index llama-index-packs-finchat\n```\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack FinanceChatPack --download-dir ./finchat_pack\n```\n\nYou can then inspect the files at `./finchat_pack` and use them as a template for your own project.\n\n## Code Usage\n\nYou can download the pack to a the `./finchat_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\nFinanceChatPack = download_llama_pack(\"FinanceChatPack\", \"./finchat_pack\")\n```\n\nTo use this tool, you'll need a few API keys:\n\n- POLYGON_API_KEY -- <https://polygon.io/>\n- FINNHUB_API_KEY -- <https://finnhub.io/>\n- ALPHA_VANTAGE_API_KEY -- <https://www.alphavantage.co/>\n- NEWSAPI_API_KEY -- <https://newsapi.org/>\n- POSTGRES_DB_URI -- 'postgresql://postgres.xhlcobfkbhtwmckmszqp:fingptpassword#123@aws-0-us-east-1.pooler.supabase.com:5432/postgres' (You can also host your own postgres SQL DB with the same table signatures. To use different signatures, modification is required in giving query examples for SQL code generation.)\n\n```python\nfin_agent = FinanceChatPack(\n POLYGON_API_KEY,\n FINNHUB_API_KEY,\n ALPHA_VANTAGE_API_KEY,\n NEWSAPI_API_KEY,\n OPENAI_API_KEY,\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./finchat_pack`.\n\nThe `run()` function chats with the agent and sends the response of the input query.\n\n```python\nresponse = fin_agent.run(\"<query>\")\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs implementation of a hierarchical agent for finance chat.",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [
"agent",
" finance",
" finchat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76e5b3ad1bbeb3a031d014861db74f1d1799396dc4a9c27822c408c8ef5aa7ed",
"md5": "3c236e04544f78048be330499f58e891",
"sha256": "e62cd454e88f57a01f4a15ec3525b9c60c161783a336da76077ce52039b314a8"
},
"downloads": -1,
"filename": "llama_index_packs_finchat-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c236e04544f78048be330499f58e891",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 6763,
"upload_time": "2024-11-18T02:02:02",
"upload_time_iso_8601": "2024-11-18T02:02:02.014390Z",
"url": "https://files.pythonhosted.org/packages/76/e5/b3ad1bbeb3a031d014861db74f1d1799396dc4a9c27822c408c8ef5aa7ed/llama_index_packs_finchat-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ec50c219fb3555ab5db253e902a6b1db940c049a1f6b3c46c78729220296994",
"md5": "41617bd97d506b666633d61d84e41e2e",
"sha256": "87f7df9fed670f8676de4cbceb537940ce25184a074035b7f1ff438a10cfb8ef"
},
"downloads": -1,
"filename": "llama_index_packs_finchat-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "41617bd97d506b666633d61d84e41e2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 6518,
"upload_time": "2024-11-18T02:02:02",
"upload_time_iso_8601": "2024-11-18T02:02:02.827867Z",
"url": "https://files.pythonhosted.org/packages/4e/c5/0c219fb3555ab5db253e902a6b1db940c049a1f6b3c46c78729220296994/llama_index_packs_finchat-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 02:02:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-finchat"
}
