> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Opik の統合

> このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/cloud/use-dify/monitor/integrations/integrate-opik) を参照してください。

## Opik の概要

Opik は、大規模言語モデル（LLM）アプリケーションを評価、テスト、および監視するためのオープンソースプラットフォームです。LLM ベースのアプリケーション開発において、直感的な評価・テスト・監視機能を提供し、開発効率の向上を支援します。

<Info>
  詳細については、[Opik](https://www.comet.com/site/products/opik/) をご参照ください。
</Info>

***

## Opik の導入ガイド

### 1. [Opik](https://www.comet.com/signup?from=llm) に登録/ログイン

### 2. Opik API キーの取得

右上のユーザーメニューから **API Key** を選択し、API キーを取得・コピーしてください。

<Frame>
  ![Opik API キー](https://assets-docs.dify.ai/2025/01/a66603f01e4ffaa593a8b78fcf3f8204.png)
</Frame>

### 3. Opik と Dify を統合

Dify アプリケーションで Opik を設定します。監視するアプリケーションを開き、サイドメニューで **監視** を選択し、ページ上の **アプリケーションパフォーマンスを追跡** をクリックします。

<Frame>
  ![アプリケーションパフォーマンスを追跡](https://assets-docs.dify.ai/2025/01/9d52a244e3b6cef1874ee838cd976111.png)
</Frame>

設定後、Opik で作成した **API Key** と **プロジェクト名** を設定ページに貼り付けて保存します。

<Frame>
  ![Opik の設定](https://assets-docs.dify.ai/2025/01/7f4c436e2dc9fe94a3ed49219bb3360c.png)
</Frame>

保存に成功すると、現在のページで監視ステータスを確認できます。

## 監視データの確認

設定が完了すると、Dify アプリケーションを通常通りデバッグまたは使用できます。すべての使用履歴は Opik で監視可能です。

<Frame>
  ![Opik でアプリデータを確認](https://assets-docs.dify.ai/2025/01/a1c5aa80325e6d0223d48a178393baec.png)
</Frame>

Opik に切り替えると、ダッシュボードで Dify アプリケーションの詳細な操作ログを確認できます。

<Frame>
  ![Opik でアプリデータを確認](https://assets-docs.dify.ai/2025/01/09601d45eaf8ed90a4dfb07c34de36ff.png)
</Frame>

Opik の詳細な LLM 操作ログにより、Dify アプリケーションのパフォーマンスを最適化できます。

<Frame>
  ![Opik でアプリデータを確認](https://assets-docs.dify.ai/2025/01/708533b4fc616f852b5601fe602e3ef5.png)
</Frame>

## モニタリングデータリスト

### **ワークフロー/会話フロートラッキング情報**

**ワークフローと会話フローの追跡に使用**

<table>
  <thead>
    <tr>
      <th>ワークフロー</th>
      <th>Opik トラッキング</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>workflow\_app\_log\_id/workflow\_run\_id</td>
      <td>id</td>
    </tr>

    <tr>
      <td>user\_session\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>
        {"workflow_{id}"}
      </td>

      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>モデルトークン消費</td>
      <td>usage\_metadata</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>error</td>
      <td>error</td>
    </tr>

    <tr>
      <td>\[workflow]</td>
      <td>tags</td>
    </tr>

    <tr>
      <td>"conversation\_id/none for workflow"</td>
      <td>conversation\_id in metadata</td>
    </tr>
  </tbody>
</table>

**ワークフロートラッキング情報**

* workflow\_id - ワークフローの一意識別子
* conversation\_id - 会話 ID
* workflow\_run\_id - 現在の実行 ID
* tenant\_id - テナント ID
* elapsed\_time - 現在の実行にかかった時間
* status - 実行ステータス
* version - ワークフローバージョン
* total\_tokens - 現在の実行で使用されたトークン総数
* file\_list - 処理されたファイルのリスト
* triggered\_from - 実行をトリガーしたソース
* workflow\_run\_inputs - 現在の実行の入力データ
* workflow\_run\_outputs - 現在の実行の出力データ
* error - 実行中に発生したエラー
* query - 実行中に使用されたクエリ
* workflow\_app\_log\_id - ワークフローアプリケーションログ ID
* message\_id - 関連するメッセージ ID
* start\_time - 実行開始時間
* end\_time - 実行終了時間
* workflow node executions - ワークフローノードの実行情報
* メタデータ
  * workflow\_id - ワークフローの一意識別子
  * conversation\_id - 会話 ID
  * workflow\_run\_id - 現在の実行 ID
  * tenant\_id - テナント ID
  * elapsed\_time - 現在の実行にかかった時間
  * status - 実行ステータス
  * version - ワークフローバージョン
  * total\_tokens - 現在の実行で使用されたトークン総数
  * file\_list - 処理されたファイルのリスト
  * triggered\_from - 実行をトリガーしたソース

***

### **メッセージトラッキング情報**

**LLM 関連の会話を追跡するために使用**

<table>
  <thead>
    <tr>
      <th>チャット</th>
      <th>Opik LLM</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>message\_id</td>
      <td>id</td>
    </tr>

    <tr>
      <td>user\_session\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>"llm"</td>
      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>モデルトークン消費</td>
      <td>usage\_metadata</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>\["message", conversation\_mode]</td>
      <td>tags</td>
    </tr>

    <tr>
      <td>conversation\_id</td>
      <td>conversation\_id in metadata</td>
    </tr>
  </tbody>
</table>

**メッセージトラッキング情報**

* message\_id - メッセージ ID
* message\_data - メッセージデータ
* user\_session\_id - ユーザーセッション ID
* conversation\_model - 会話モード
* message\_tokens - メッセージ内のトークン数
* answer\_tokens - 回答内のトークン数
* total\_tokens - メッセージと回答のトークン総数
* error - エラー情報
* inputs - 入力データ
* outputs - 出力データ
* file\_list - 処理されたファイルリスト
* start\_time - 開始時間
* end\_time - 終了時間
* message\_file\_data - メッセージ関連のファイルデータ
* conversation\_mode - 会話モード
* メタデータ
  * conversation\_id - 会話 ID
  * ls\_provider - モデルプロバイダー
  * ls\_model\_name - モデル ID
  * status - メッセージステータス
  * from\_end\_user\_id - 送信ユーザーID
  * from\_account\_id - 送信アカウント ID
  * agent\_based - エージェントベースかどうか
  * workflow\_run\_id - ワークフロー実行 ID
  * from\_source - メッセージソース

### **レビュー追跡情報**

**会話のレビューを追跡するために使用**

<table>
  <thead>
    <tr>
      <th>レビュー</th>
      <th>Opik Tool</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>user\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>"moderation"</td>
      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>\["moderation"]</td>
      <td>tags</td>
    </tr>
  </tbody>
</table>

**レビュー追跡情報**

* message\_id - メッセージ ID
* user\_id - ユーザーID
* workflow\_app\_log\_id - ワークフローアプリケーションログ ID
* inputs - レビュー入力データ
* message\_data - メッセージデータ
* flagged - 注意が必要とマークされたかどうか
* action - 実施された具体的なアクション
* preset\_response - プリセットレスポンス
* start\_time - レビュー開始時間
* end\_time - レビュー終了時間
* メタデータ
  * message\_id - メッセージ ID
  * action - 実施されたアクション
  * preset\_response - プリセットレスポンス

***

### **提案質問追跡情報**

**提案質問を追跡するために使用**

<table>
  <thead>
    <tr>
      <th>提案質問</th>
      <th>Opik LLM</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>user\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>"suggested\_question"</td>
      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>\["suggested\_question"]</td>
      <td>tags</td>
    </tr>
  </tbody>
</table>

**提案質問追跡情報**

* message\_id - メッセージ ID
* message\_data - メッセージデータ
* inputs - 入力データ
* outputs - 出力データ
* start\_time - 開始時間
* end\_time - 終了時間
* total\_tokens - トークン総数
* status - メッセージステータス
* error - エラー情報
* from\_account\_id - 送信アカウント ID
* agent\_based - エージェントベースかどうか
* from\_source - メッセージの送信元
* model\_provider - モデルプロバイダー
* model\_id - モデル ID
* suggested\_question - 提案された質問
* level - ステータスレベル
* status\_message - ステータスメッセージ
* メタデータ
  * message\_id - メッセージ ID
  * ls\_provider - モデルプロバイダー
  * ls\_model\_name - モデル ID
  * status - メッセージステータス
  * from\_end\_user\_id - 送信ユーザーID
  * from\_account\_id - 送信アカウント ID
  * workflow\_run\_id - ワークフロー実行 ID
  * from\_source - メッセージの送信元

***

### **データセット検索追跡情報**

**ナレッジベース検索を追跡するために使用**

<table>
  <thead>
    <tr>
      <th>データセット検索</th>
      <th>Opik Retriever</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>user\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>"dataset\_retrieval"</td>
      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>\["dataset\_retrieval"]</td>
      <td>tags</td>
    </tr>

    <tr>
      <td>message\_id</td>
      <td>parent\_run\_id</td>
    </tr>
  </tbody>
</table>

**データセット検索追跡情報**

* message\_id - メッセージ ID
* inputs - 入力データ
* documents - ドキュメントデータ
* start\_time - 開始時間
* end\_time - 終了時間
* message\_data - メッセージデータ
* メタデータ
  * message\_id - メッセージ ID
  * ls\_provider - モデルプロバイダー
  * ls\_model\_name - モデル ID
  * status - メッセージステータス
  * from\_end\_user\_id - 送信ユーザーID
  * from\_account\_id - 送信アカウント ID
  * agent\_based - エージェントベースかどうか
  * workflow\_run\_id - ワークフロー実行 ID
  * from\_source - メッセージの送信元

***

### **ツール追跡情報**

**ツールの呼び出しを追跡するために使用**

<table>
  <thead>
    <tr>
      <th>ツール</th>
      <th>Opik Tool</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>user\_id</td>
      <td>- メタデータに配置</td>
    </tr>

    <tr>
      <td>tool\_name</td>
      <td>name</td>
    </tr>

    <tr>
      <td>start\_time</td>
      <td>start\_time</td>
    </tr>

    <tr>
      <td>end\_time</td>
      <td>end\_time</td>
    </tr>

    <tr>
      <td>inputs</td>
      <td>inputs</td>
    </tr>

    <tr>
      <td>outputs</td>
      <td>outputs</td>
    </tr>

    <tr>
      <td>metadata</td>
      <td>metadata</td>
    </tr>

    <tr>
      <td>\["tool", tool\_name]</td>
      <td>tags</td>
    </tr>
  </tbody>
</table>

**ツール追跡情報**

* message\_id - メッセージ ID
* tool\_name - ツール名
* start\_time - 開始時間
* end\_time - 終了時間
* tool\_inputs - ツール入力
* tool\_outputs - ツール出力
* message\_data - メッセージデータ
* error - エラー情報（該当する場合）
* inputs - メッセージの入力
* outputs - メッセージの出力
* tool\_config - ツール設定
* time\_cost - 時間コスト
* tool\_parameters - ツールパラメーター
* file\_url - 関連するファイルの URL
* メタデータ
  * message\_id - メッセージ ID
  * tool\_name - ツール名
  * tool\_inputs - ツール入力
  * tool\_outputs - ツール出力
  * tool\_config - ツール設定
  * time\_cost - 時間コスト
  * error - エラー情報（該当する場合）
  * tool\_parameters - ツールパラメーター
  * message\_file\_id - メッセージファイル ID
  * created\_by\_role - 作成者の役割
  * created\_user\_id - 作成者ユーザーID