OpenInference LlamaIndex Instrumentation
Project description
OpenInference LlamaIndex Instrumentation
Python auto-instrumentation library for LlamaIndex.
These traces are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as arize-phoenix
.
Installation
pip install openinference-instrumentation-llama-index
Compatibility
llama-index version | openinference-instrumentation-llama-index version |
---|---|
>=0.10.43 | >=2.0.0 |
>=0.10.0, <0.10.43 | >=1.0.0, <0.2 |
>=0.9.14, <0.10.0 | 0.1.3 |
Quickstart
Install packages needed for this demonstration.
python -m pip install --upgrade \
openinference-instrumentation-llama-index \
opentelemetry-sdk \
opentelemetry-exporter-otlp \
"opentelemetry-proto>=1.12.0" \
arize-phoenix
Start the Phoenix app in the background as a collector. By default, it listens on http://localhost:6006
. You can visit the app via a browser at the same address.
The Phoenix app does not send data over the internet. It only operates locally on your machine.
python -m phoenix.server.main serve
The following Python code sets up the LlamaIndexInstrumentor
to trace llama-index
and send the traces to Phoenix at the endpoint shown below.
from openinference.instrumentation.llama_index import LlamaIndexInstrumentor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk import trace as trace_sdk
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
endpoint = "http://127.0.0.1:6006/v1/traces"
tracer_provider = trace_sdk.TracerProvider()
tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
LlamaIndexInstrumentor().instrument(tracer_provider=tracer_provider)
To demonstrate tracing, we'll use LlamaIndex below to query a document.
First, download a text file.
import tempfile
from urllib.request import urlretrieve
from llama_index.core import SimpleDirectoryReader
url = "https://raw.githubusercontent.com/Arize-ai/phoenix-assets/main/data/paul_graham/paul_graham_essay.txt"
with tempfile.NamedTemporaryFile() as tf:
urlretrieve(url, tf.name)
documents = SimpleDirectoryReader(input_files=[tf.name]).load_data()
Next, we'll query using OpenAI. To do that you need to set up your OpenAI API key in an environment variable.
import os
os.environ["OPENAI_API_KEY"] = "<your openai key>"
Now we can query the indexed documents.
from llama_index.core import VectorStoreIndex
query_engine = VectorStoreIndex.from_documents(documents).as_query_engine()
print(query_engine.query("What did the author do growing up?"))
Visit the Phoenix app at http://localhost:6006
to see the traces.
More Info
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openinference_instrumentation_llama_index-2.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00f3e5116760c4144226fc2a41f04a63bd614844c6f1dbda3488dc211ed1d109 |
|
MD5 | 567a8cadbf249589f51e3e8f46904c9e |
|
BLAKE2b-256 | 467bf32d391ce66109a46123cc5fbe8e852f1965acf32d63f8f762a918db3f7a |
Hashes for openinference_instrumentation_llama_index-2.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3136c0da2092f1e85745639494518f1ddad99d11316281ad23f72a75db628141 |
|
MD5 | 89ab96347fd3d2dcc96bba25fc4e78e4 |
|
BLAKE2b-256 | 29005118f934345a13964b569a0a9d13e3758f7364738cd14119e94204688860 |