From f261b739a9e774970aaf3a744b884946653cfc63 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 2 Apr 2025 16:26:17 -0400 Subject: [PATCH] docs: update arize phoenix variable (#7383) * phoenix-api-key * space * add-tabs * finish-sentence * numbering * code-review --- .../Integrations/Arize/integrations-arize.md | 53 +++++++++++++++---- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/docs/docs/Integrations/Arize/integrations-arize.md b/docs/docs/Integrations/Arize/integrations-arize.md index 49dd7e28d..95c3cfcc5 100644 --- a/docs/docs/Integrations/Arize/integrations-arize.md +++ b/docs/docs/Integrations/Arize/integrations-arize.md @@ -3,34 +3,67 @@ title: Integrate Arize with Langflow slug: /integrations-arize --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Arize is a tool built on [OpenTelemetry](https://opentelemetry.io/) and [OpenInference](https://docs.arize.com/phoenix/reference/open-inference) for monitoring and optimizing LLM applications. -To add tracing to your Langflow application, add the `ARIZE_SPACE_ID` and `ARIZE_API_KEY` environment variables to your Langflow application. +To add tracing to your Langflow application, add Arize environment variables to your Langflow application. +Arize begins monitoring and collecting telemetry data from your LLM applications automatically. ## Prerequisites -* If you are using the [standard Arize platform](https://docs.arize.com/arize), you need an **Arize Space ID** and **API API Key**. -* If you are using the open-source [Arize Phoenix platform](https://docs.arize.com/phoenix), you need an Arize Phoenix API key and a project name. +* If you are using the [standard Arize platform](https://docs.arize.com/arize), you need an **Arize Space ID** and **Arize API Key**. +* If you are using the open-source [Arize Phoenix platform](https://docs.arize.com/phoenix), you need an **Arize Phoenix API key**. ## Connect Arize to Langflow -1. To retrieve your **Arize Space ID** and **API API Key**, navigate to the [Arize dashboard](https://app.arize.com/). + + + +1. To retrieve your **Arize Space ID** and **Arize API Key**, navigate to the [Arize dashboard](https://app.arize.com/). 2. Click **Settings**, and then click **Space Settings and Keys**. 3. Copy the **SpaceID** and **API Key (Ingestion Service Account Key)** values. 4. Create a `.env` file in the root of your Langflow application. 5. Add the `ARIZE_SPACE_ID` and `ARIZE_API_KEY` environment variables to your Langflow application. -You do not need to specify the **Arize Project** name if you're using the standard Arize platform. The **Project** name in Arize is the same as the Langflow **Flow** name. +You do not need to specify the **Arize Project** name if you're using the standard Arize platform. +Replace the following: + +* YOUR_ARIZE_SPACE_ID: the **SpaceID** value copied from Arize +* YOUR_ARIZE_API_KEY: the **API Key** value copied from Arize ```bash -export ARIZE_SPACE_ID= -export ARIZE_API_KEY= +ARIZE_SPACE_ID=YOUR_ARIZE_SPACE_ID +ARIZE_API_KEY=YOUR_ARIZE_API_KEY ``` - -6. Start your Langflow application with the values from the `.env` file. - +6. Save the `.env` file. +7. Start your Langflow application with the values from the `.env` file. ```bash uv run langflow run --env-file .env ``` + + + +1. To retrieve your **Arize Phoenix API key**, navigate to the [Arize dashboard](https://app.phoenix.arize.com/). +2. Click **API Key**. +3. Copy the **API Key** value. +4. Create a `.env` file in the root of your Langflow application. +5. Add the `PHOENIX_API_KEY` environment variable to your application instead. +Replace `YOUR_PHOENIX_API_KEY` with the Arize Phoenix API key that you copied from the Arize Phoenix platform. + +```bash +PHOENIX_API_KEY=YOUR_PHOENIX_API_KEY +``` + +6. Save the `.env` file. +7. Start your Langflow application with the values from the `.env` file. +```bash +uv run langflow run --env-file .env +``` + + + +For more information, see the [Arize documentation](https://docs.arize.com/phoenix/tracing/integrations-tracing/langflow#go-to-arize-phoenix). ## Run a flow and view metrics in Arize