使用 Opik 记录跟踪¶

在本指南中，我们将下载 Paul Graham 的文章并将其用作数据源。然后我们将开始使用 LlamaIndex 查询这些文章，并将跟踪记录到 Opik。

在 Comet.com 上创建账户¶

Comet 提供了 Opik 平台的托管版本，只需创建一个账户并获取您的 API 密钥。

您也可以在本地运行 Opik 平台，有关更多信息请参阅安装指南。

In [ ]

import os
import getpass

if "OPIK_API_KEY" not in os.environ:
    os.environ["OPIK_API_KEY"] = getpass.getpass("Opik API Key: ")
if "OPIK_WORKSPACE" not in os.environ:
    os.environ["OPIK_WORKSPACE"] = input(
        "Comet workspace (often the same as your username): "
    )

import os import getpass if "OPIK_API_KEY" not in os.environ: os.environ["OPIK_API_KEY"] = getpass.getpass("Opik API Key: ") if "OPIK_WORKSPACE" not in os.environ: os.environ["OPIK_WORKSPACE"] = input( "Comet workspace (often the same as your username): " )

如果您在本地运行 Opik 平台，只需设置

In [ ]

# import os
# os.environ["OPIK_URL_OVERRIDE"] = "http://localhost:5173/api"

# import os # os.environ["OPIK_URL_OVERRIDE"] = "http://localhost:5173/api"

准备我们的环境¶

首先，我们将安装必要的库，下载 Chinook 数据库并设置不同的 API 密钥。

In [ ]

%pip install opik llama-index llama-index-agent-openai llama-index-llms-openai --upgrade --quiet

%pip install opik llama-index llama-index-agent-openai llama-index-llms-openai --upgrade --quiet

并配置所需的环境变量

In [ ]

import os
import getpass

if "OPENAI_API_KEY" not in os.environ:
    os.environ["OPENAI_API_KEY"] = getpass.getpass(
        "Enter your OpenAI API key: "
    )

import os import getpass if "OPENAI_API_KEY" not in os.environ: os.environ["OPENAI_API_KEY"] = getpass.getpass( "Enter your OpenAI API key: " )

此外，我们将下载 Paul Graham 的文章。

In [ ]

import os
import requests

# Create directory if it doesn't exist
os.makedirs("./data/paul_graham/", exist_ok=True)

# Download the file using requests
url = "https://raw.githubusercontent.com/run-llama/llama_index/main/docs/docs/examples/data/paul_graham/paul_graham_essay.txt"
response = requests.get(url)
with open("./data/paul_graham/paul_graham_essay.txt", "wb") as f:
    f.write(response.content)

import os import requests # Create directory if it doesn't exist os.makedirs("./data/paul_graham/", exist_ok=True) # Download the file using requests url = "https://raw.githubusercontent.com/run-llama/llama_index/main/docs/docs/examples/data/paul_graham/paul_graham_essay.txt" response = requests.get(url) with open("./data/paul_graham/paul_graham_essay.txt", "wb") as f: f.write(response.content)

使用 LlamaIndex¶

配置 Opik 集成¶

您可以直接调用 Opik 回调函数来使用它：

In [ ]

from llama_index.core import set_global_handler

# You should provide your OPIK API key and Workspace using the following environment variables:
# OPIK_API_KEY, OPIK_WORKSPACE
set_global_handler(
    "opik",
)

from llama_index.core import set_global_handler # You should provide your OPIK API key and Workspace using the following environment variables: # OPIK_API_KEY, OPIK_WORKSPACE set_global_handler( "opik", )

回调处理程序配置完成后，所有跟踪将自动记录到 Opik。

使用 LLamaIndex¶

第一步是将数据加载到 LlamaIndex 中。我们将使用 SimpleDirectoryReader 从 data/paul_graham 目录加载数据。我们还将创建向量存储来索引所有加载的文档。

In [ ]

from llama_index.core import VectorStoreIndex, SimpleDirectoryReader

documents = SimpleDirectoryReader("./data/paul_graham").load_data()
index = VectorStoreIndex.from_documents(documents)
query_engine = index.as_query_engine()

from llama_index.core import VectorStoreIndex, SimpleDirectoryReader documents = SimpleDirectoryReader("./data/paul_graham").load_data() index = VectorStoreIndex.from_documents(documents) query_engine = index.as_query_engine()

现在我们可以使用 query_engine 对象查询索引。

In [ ]

response = query_engine.query("What did the author do growing up?")
print(response)

response = query_engine.query("What did the author do growing up?") print(response)

您现在可以访问 Opik 应用程序查看跟踪。