Skip to content

Commit

Permalink
Add Dify documentation to Opik (#879)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lothiraldan authored Dec 12, 2024
1 parent dc0dd33 commit a128a1c
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_label: Dify
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Dify Integration

Learn how to connect Opik with Dify to monitor your applications' performance.

## Setup Instructions

Follow these simple steps to connect Dify with Opik:

1. Select the Dify app you want to monitor
2. Select **Monitoring** from the side menu
3. Click on **Tracing app performance**
4. Click on **Configure** for Opik
5. Enter your connection details based on your Opik version:

![How to configure Dify settings](/img/tracing/dify_configuration.png)

<Tabs>
<TabItem value="Hosted Opik" title="Hosted Opik">

Fill in these fields:
- **API Key**: Your Comet API Key
- **Project**: Your preferred project name (if left empty, it will be created automatically)
- **Workspace**: Your Comet Workspace name (must already exist)
- **URL**: Your Opik installation URL (make sure it ends with `/api/`)

</TabItem>

<TabItem value="Self-Hosted Opik" title="Self-Hosted Opik">

Fill in these fields:
- **API Key**: Leave this empty
- **Project**: Your preferred project name (if left empty, it will be created automatically)
- **Workspace**: Type `default`
- **URL**: Your Opik installation URL (make sure it ends with `/api/`)

</TabItem>

</Tabs>

## How to View Your Traces

After setup, you can view your application traces by:

1. Opening the **Monitoring** section from the side menu
2. Finding and clicking the **OPIK** button in the top-right corner
3. Selecting **View** to open your Opik project dashboard

![How to view your Opik project](/img/tracing/dify_view_project.png)
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Opik aims to make it as easy as possible to log, view and evaluate your LLM trac
| Predibase | Fine-tune and serve open-source LLMs | [Documentation](/tracing/integrations/predibase.md) | [![Open Quickstart In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/comet-ml/opik/blob/master/apps/opik-documentation/documentation/docs/cookbook/predibase.ipynb) |
| Ragas | Evaluation framework for your Retrieval Augmented Generation (RAG) pipelines | [Documentation](/tracing/integrations/ragas.md) | [![Open Quickstart In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/comet-ml/opik/blob/master/apps/opik-documentation/documentation/docs/cookbook/ragas.ipynb) |
| watsonx | Log traces for all watsonx LLM calls | [Documentation](/tracing/integrations/watsonx.md) | [![Open Quickstart In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/comet-ml/opik/blob/master/apps/opik-documentation/documentation/docs/cookbook/watsonx.ipynb) |
| Dify | Log traces and LLM calls for your Dify Apps | [Documentation](/tracing/integrations/dify.mdx) | |

If you would like to see more integrations, please open an issue on our [GitHub repository](https://github.com/comet-ml/opik/issues/new/choose).
1 change: 1 addition & 0 deletions apps/opik-documentation/documentation/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ const sidebars: SidebarsConfig = {
"tracing/integrations/langchain", // Everything after this one should be ordered by name
"tracing/integrations/anthropic",
"tracing/integrations/bedrock",
"tracing/integrations/dify",
"tracing/integrations/gemini",
"tracing/integrations/groq",
"tracing/integrations/langgraph",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a128a1c

Please sign in to comment.