🚀 DifyでのCodingPlanXカスタムモデルの統合

このチュートリアルでは、CodingPlanXが提供するAPIインターフェースとモデルをDifyプラットフォームに簡単に統合し、カスタムAI機能を呼び出す方法を説明します。

📋 事前準備

設定を始める前に、以下の条件を満たしていることを確認してください：

Difyプラットフォームへのアクセス権：デプロイ済みのDifyプライベート版、またはDify公式クラウドサービスのアカウント。
API Key：CodingPlanXプラットフォームで取得した有効なAPIキー（API Key）。

⚙️ 設定手順

ステップ1：モデルプロバイダー設定を開く

Difyコンソールにログインします。
ページ右上の 「プロフィールアイコン」 をクリックし、ドロップダウンメニューから 「設定」（Settings）を選択します。
左側のナビゲーションバーで、「モデルプロバイダー」（Model Providers）をクリックします。

ステップ2：カスタムモデルの追加

CodingPlanXはOpenAIのインターフェース標準と互換性があるため、Difyが提供する OpenAI-API-compatible 汎用設定オプションを使用します。

「モデルプロバイダー」ページを下にスクロールし、「OpenAI-API-compatible」 オプションを見つけます。
カード上の 「モデルの追加」（Add Model）ボタンをクリックします。

ステップ3：設定パラメーターの入力（重要）

ポップアップ表示される設定ウィンドウで、以下の表に沿って正確にパラメーターを入力してください：

パラメーター名	入力内容 / 例	説明
モデルタイプ (Model Type)	`LLM`	統合するモデルのタイプを選択します（通常は大言語モデル LLM）。
モデル名 (Model Name)	例：`gpt-4-turbo` または `claude-3-opus`	必須。CodingPlanXが実際にサポートしているモデルコードを入力してください（間違えると呼び出せません）。
API Key	`sk-xxxxxxxxxxxxxxxxxxx`	必須。CodingPlanXで取得したAPIキーを入力します。
API endpoint URL	`https://api.codingplanx.ai/v1`	必須。エンドポイントのURL。（⚠️ 注意：通常、ドメインの後に `/v1` パスを追加する必要があります）。
モデルコンテキスト長 (Context)	`8192` （モデルの実際の状況に応じて入力）	モデルがサポートする最大トークン数（例：4096、8192、128000など）。
最大トークン上限 (Max token)	`4096` （モデルの実際の状況に応じて入力）	1回の回答で生成できる最大トークン数。

> 💡 ヒント (Tips)： > * API URLについて：ベースドメインは https://api.codingplanx.ai ですが、Difyの互換モードでは通常 /v1 サフィックスを補う必要があります。つまり、https://api.codingplanx.ai/v1 と入力します。 > * モデル名について：モデル名がわからない場合は、CodingPlanXの公式APIドキュメントを参照して正確なModel IDを取得してください。

ステップ4：保存してテスト

すべての情報が正しく入力されていることを確認し、右下の 「保存」（Save）をクリックします。
設定が正しければ、保存成功のメッセージが表示され、リストに先ほど追加したモデルが表示されます。

🧪 検証と使用

設定完了後、すぐにDifyでこのモデルをテストできます：

Difyの 「スタジオ」（Studio）に入り、アプリ（チャットアシスタントなど）を作成または開きます。
アプリオーケストレーションページの右上にある 「モデル選択」 エリアで、ドロップダウンメニューをクリックします。
OpenAI-API-compatible グループを見つけ、先ほど追加したCodingPlanXモデルを選択します。
右側のデバッグプレビューウィンドウでメッセージ（例：「こんにちは、自己紹介をお願いします」）を送信し、AIから正常な回答を受け取れれば、統合は成功です！🎉

❓ よくある質問とトラブルシューティング (FAQ)

Q1: 保存時に "Connection failed" や "Invalid API Key" と表示される場合は？

API Key が完全にコピーされているか、前後にスペースが含まれていないか確認してください。
API endpoint URL に /v1 サフィックスが正しく追加されているか確認してください。
サーバーのネットワークが https://api.codingplanx.ai に正常にアクセスできるか確認してください。

Q2: チャット時に "Model not found" と表示される場合は？

入力した モデル名 (Model Name) がCodingPlanXプラットフォームに存在しないか、呼び出し権限がありません。モデル名のスペル（大文字小文字やハイフン）を注意深く確認してください。

Q3: 回答が突然途切れる場合は？

設定の 最大トークン上限 (Max token) が小さすぎないか確認してください。値を大きくすることをお勧めします（例：2048 または 4096）。