# Arize-Phoenix LlamaPack
This LlamaPack instruments your LlamaIndex app for LLM tracing with [Phoenix](https://github.com/Arize-ai/phoenix), an open-source LLM observability library from [Arize AI](https://phoenix.arize.com/).
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack ArizePhoenixQueryEnginePack --download-dir ./arize_pack
```
You can then inspect the files at `./arize_pack` and use them as a template for your own project!
## Code Usage
You can download the pack to a the `./arize_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
ArizePhoenixQueryEnginePack = download_llama_pack(
"ArizePhoenixQueryEnginePack", "./arize_pack"
)
```
You can then inspect the files at `./arize_pack` or continue on to use the module.
```python
import os
from llama_index.core.node_parser import SentenceSplitter
from llama_index.readers.web import SimpleWebPageReader
from tqdm.auto import tqdm
```
Configure your OpenAI API key.
```python
os.environ["OPENAI_API_KEY"] = "copy-your-openai-api-key-here"
```
Parse your documents into a list of nodes and pass to your LlamaPack. In this example, use nodes from a Paul Graham essay as input.
```python
documents = SimpleWebPageReader().load_data(
[
"https://raw.githubusercontent.com/jerryjliu/llama_index/adb054429f642cc7bbfcb66d4c232e072325eeab/examples/paul_graham_essay/data/paul_graham_essay.txt"
]
)
parser = SentenceSplitter()
nodes = parser.get_nodes_from_documents(documents)
phoenix_pack = ArizePhoenixQueryEnginePack(nodes=nodes)
```
Run a set of queries via the pack's `run` method, which delegates to the underlying query engine.
```python
queries = [
"What did Paul Graham do growing up?",
"When and how did Paul Graham's mother die?",
"What, in Paul Graham's opinion, is the most distinctive thing about YC?",
"When and how did Paul Graham meet Jessica Livingston?",
"What is Bel, and when and where was it written?",
]
for query in tqdm(queries):
print("Query")
print("=====")
print(query)
print()
response = phoenix_pack.run(query)
print("Response")
print("========")
print(response)
print()
```
View your trace data in the Phoenix UI.
```python
phoenix_session_url = phoenix_pack.get_modules()["session_url"]
print(f"Open the Phoenix UI to view your trace data: {phoenix_session_url}")
```
You can access the internals of the LlamaPack, including your Phoenix session and your query engine, via the `get_modules` method.
```python
phoenix_pack.get_modules()
```
Check out the [Phoenix documentation](https://docs.arize.com/phoenix/) for more information!
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-arize-phoenix-query-engine",
"maintainer": "axiomofjoy",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "arize,engine,index,phoenix,query",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/22/46/cdbe2c2399f477418e7e40ba281e7459c05d6add1c2c2a517f44bcf3f5f4/llama_index_packs_arize_phoenix_query_engine-0.1.4.tar.gz",
"platform": null,
"description": "# Arize-Phoenix LlamaPack\n\nThis LlamaPack instruments your LlamaIndex app for LLM tracing with [Phoenix](https://github.com/Arize-ai/phoenix), an open-source LLM observability library from [Arize AI](https://phoenix.arize.com/).\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 ArizePhoenixQueryEnginePack --download-dir ./arize_pack\n```\n\nYou can then inspect the files at `./arize_pack` and use them as a template for your own project!\n\n## Code Usage\n\nYou can download the pack to a the `./arize_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nArizePhoenixQueryEnginePack = download_llama_pack(\n \"ArizePhoenixQueryEnginePack\", \"./arize_pack\"\n)\n```\n\nYou can then inspect the files at `./arize_pack` or continue on to use the module.\n\n```python\nimport os\n\nfrom llama_index.core.node_parser import SentenceSplitter\nfrom llama_index.readers.web import SimpleWebPageReader\nfrom tqdm.auto import tqdm\n```\n\nConfigure your OpenAI API key.\n\n```python\nos.environ[\"OPENAI_API_KEY\"] = \"copy-your-openai-api-key-here\"\n```\n\nParse your documents into a list of nodes and pass to your LlamaPack. In this example, use nodes from a Paul Graham essay as input.\n\n```python\ndocuments = SimpleWebPageReader().load_data(\n [\n \"https://raw.githubusercontent.com/jerryjliu/llama_index/adb054429f642cc7bbfcb66d4c232e072325eeab/examples/paul_graham_essay/data/paul_graham_essay.txt\"\n ]\n)\nparser = SentenceSplitter()\nnodes = parser.get_nodes_from_documents(documents)\nphoenix_pack = ArizePhoenixQueryEnginePack(nodes=nodes)\n```\n\nRun a set of queries via the pack's `run` method, which delegates to the underlying query engine.\n\n```python\nqueries = [\n \"What did Paul Graham do growing up?\",\n \"When and how did Paul Graham's mother die?\",\n \"What, in Paul Graham's opinion, is the most distinctive thing about YC?\",\n \"When and how did Paul Graham meet Jessica Livingston?\",\n \"What is Bel, and when and where was it written?\",\n]\nfor query in tqdm(queries):\n print(\"Query\")\n print(\"=====\")\n print(query)\n print()\n response = phoenix_pack.run(query)\n print(\"Response\")\n print(\"========\")\n print(response)\n print()\n```\n\nView your trace data in the Phoenix UI.\n\n```python\nphoenix_session_url = phoenix_pack.get_modules()[\"session_url\"]\nprint(f\"Open the Phoenix UI to view your trace data: {phoenix_session_url}\")\n```\n\nYou can access the internals of the LlamaPack, including your Phoenix session and your query engine, via the `get_modules` method.\n\n```python\nphoenix_pack.get_modules()\n```\n\nCheck out the [Phoenix documentation](https://docs.arize.com/phoenix/) for more information!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs arize_phoenix_query_engine integration",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"arize",
"engine",
"index",
"phoenix",
"query"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27a59e37569a433ed1e56f67b663efbdbd8083471cdf471438426290be03c539",
"md5": "ce26aadf2682c8d84ac325775eedb666",
"sha256": "23535a39c2e4274e370e3c44b1ebda2f64d6e39f0149d9a30d333c9d9bd7e651"
},
"downloads": -1,
"filename": "llama_index_packs_arize_phoenix_query_engine-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce26aadf2682c8d84ac325775eedb666",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 3935,
"upload_time": "2024-02-22T03:14:19",
"upload_time_iso_8601": "2024-02-22T03:14:19.706332Z",
"url": "https://files.pythonhosted.org/packages/27/a5/9e37569a433ed1e56f67b663efbdbd8083471cdf471438426290be03c539/llama_index_packs_arize_phoenix_query_engine-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2246cdbe2c2399f477418e7e40ba281e7459c05d6add1c2c2a517f44bcf3f5f4",
"md5": "d857ece0978b6af02ab2fe1654b9e7e9",
"sha256": "c58aeb6b79537a9326050432b3f73e49c506921f35e367882863ca07aa2b4077"
},
"downloads": -1,
"filename": "llama_index_packs_arize_phoenix_query_engine-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "d857ece0978b6af02ab2fe1654b9e7e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<3.12",
"size": 3492,
"upload_time": "2024-02-22T03:14:20",
"upload_time_iso_8601": "2024-02-22T03:14:20.871909Z",
"url": "https://files.pythonhosted.org/packages/22/46/cdbe2c2399f477418e7e40ba281e7459c05d6add1c2c2a517f44bcf3f5f4/llama_index_packs_arize_phoenix_query_engine-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 03:14:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-arize-phoenix-query-engine"
}
JSON