ClineでOpenAI互換プロバイダーを設定し、出典付きの文書Q&Aを構築する

モデル接続だけでなく、文書Q&Aに対応するClineの設定

コーディングエージェントにプロジェクト文書について質問し、回答の根拠も示させたい場合、必要な作業は2つに分かれます。Clineをモデルエンドポイントに接続することと、その接続を使った検索・出典表示のワークフローを構築することです。Cline SDKのドキュメントでは、プロバイダーの認証情報、モデルID、LLMゲートウェイについて説明されています。組み込みの文書検索機能や引用機能については記載されていません。Clineのモデルプロバイダーに関するドキュメントを読む。

以下はCline SDKを使う開発者向けの設定です。Clineのデスクトップ拡張機能や別のインターフェース向けの手順ではありません。提示された情報から、それらの設定方法は確認できません。SDKでは、APIキー、ベースURL、モデルIDを指定するopenai-compatibleプロバイダーがClineによって案内されています。OneMuxはOpenAI互換APIを通じてモデルを利用する方法の一つですが、特定のClineワークフローで互換性があるかどうかは、使用するエンドポイントとリクエスト機能によります。

前提条件

エージェントを設定する前に、次のものを用意してください。

• 関連する@cline/agentsおよびプロバイダーパッケージを使うCline SDKプロジェクト。Clineによると、@cline/agentsと@cline/coreは内部でClineのLLMレイヤーを使用します。使用中のバージョンで必要となる正確なインポート方法とコンストラクターの形式は、パッケージのドキュメントで確認してください。
• 利用するプロバイダーのAPIキー。ソース管理の対象外に保管してください。
• プロバイダーのOpenAI互換ベースURLと、受け付けられる正確なモデルID。
• アプリケーションから利用できる文書と、関連する箇所を検索して出典メタデータを保持できる検索方法。

OneMuxアカウントとAPIの設定については、OneMuxクイックスタートとAPIドキュメントを参照してください。利用前に、最新のエンドポイントとモデル識別子をドキュメントで確認してください。この記事では、特定のモデル、エンドポイント、Cline連携がテスト済みであるとは述べていません。

OpenAI互換プロバイダーを設定する

Clineのドキュメントに記載されているプロバイダー設定の形式は次のとおりです。

const agent = new Agent({
  providerId: "openai-compatible",
  modelId: process.env.MODEL_ID,
  apiKey: process.env.PROVIDER_API_KEY,
  baseUrl: process.env.PROVIDER_BASE_URL,
})

提示されたプロバイダー資料には指定がないため、Agentシンボルとパッケージのインポートは省略しています。使用中のバージョンのドキュメントを参照し、インポート方法と追加で必要なオプションを設定してください。MODEL_ID、PROVIDER_API_KEY、PROVIDER_BASE_URLは、ローカル環境またはシークレットマネージャーで設定します。これらはアプリケーションの環境変数名の例であり、Clineが必須とする変数名ではありません。OpenAIやその他の名称付きプロバイダーについてClineが説明している共通変数から、あらゆるOpenAI互換サービスに標準の変数名があるとは判断できません。

OneMuxを使う場合は、OneMuxのAPIドキュメントで最新のベースURL、APIキー、モデルIDを確認し、対応する各フィールドに設定してください。すべてのOpenAI互換エンドポイントが、あらゆるオプションパラメーターや機能を受け付けるとは限りません。エンドポイントのドキュメントで、リクエスト形式、認証方式、モデルの利用可否を確認してください。特に、互換性はエージェントが送信するパラメーターをプロバイダーがサポートしていることが条件です。

文書回答に出典を付ける

モデルを接続しただけでは、ファイルの検索や引用はできません。次の動作をアプリケーション層で構築してください。

1. 安定した識別子を付けて文書をインデックス化する。 検索対象の各文章について、出典ID、文書タイトル、ページ、セクションなどの位置情報を保存します。そのメタデータは本文と併せて管理してください。
2. 質問の前に検索する。 ユーザーの質問に関連する文章を検索し、結果を絞ってコンテキストとして渡します。検索処理と文書ストアは、Clineの資料で説明されているプロバイダー設定の範囲外です。
3. 回答に参照を含めるよう求める。 渡した文章だけを根拠に回答し、指定したIDと位置情報を使って参照を返すようモデルに指示します。たとえば、簡潔な回答と引用IDのリストを求めます。
4. コードで引用を検証する。 返されたIDがすべて検索結果に含まれていることを確認し、独自のメタデータからリンクやラベルを生成します。回答を裏付ける文章がない場合は、根拠のない主張を提示するのではなく、文書からは確認できないとワークフローに回答させてください。

検索ステップでは、次のようなプロンプトを使えます。

Answer the question using only the supplied document passages.
For each factual claim, cite the passage ID and location in brackets.
If the passages do not support an answer, say so.

Question: {{question}}
Passages:
{{retrieved_passages_with_ids_and_locations}}

これはアプリケーション層での実装例であり、Clineに文書化された引用APIではありません。モデルがもっともらしく見えても誤った参照を返すことがあるため、検索メタデータ、必要に応じて引用先の文章と照合して検証してください。重要度の高い回答は、回答内容と根拠となる文章を人が確認するようにしてください。

確認すべき点とトラブルシューティング

認証に失敗する: プロセスの環境変数にキーが設定されていること、設定したサービスのキーであること、クライアントが使う認証方式をエンドポイントが受け付けることを確認してください。ログにシークレットを出力しないでください。

モデルが見つからない: プロバイダーに正確なモデルIDを確認してください。Clineの資料にあるのはプロバイダー固有のモデルIDであり、特定のIDがすべての互換サービスで利用できることを保証していません。

OpenAI互換と表示されているのにリクエストが失敗する: ベースURLを確認してください。プロバイダーによっては/v1のようなバージョンパスが必要です。次に、インストールしたClineのバージョンが使うリクエストパラメーターとレスポンス形式を、エンドポイントのサポート内容と照らし合わせてください。提示されたCline資料には、サードパーティーのエンドポイントで共通してサポートされるパラメーターの一覧はありません。

回答の出典が信頼できない: 関連する文章が検索されていること、各文章に安定した識別子と位置情報があること、アプリケーションが返された参照を検証していることを確認してください。プロバイダーの設定だけでは、検索メタデータの欠落や誤りは解決できません。

Clineのモデルプロバイダーレイヤーでは、ゲートウェイとモデルのメタデータも利用できます。コンテキストウィンドウ、最大トークン数、価格、機能などのフィールドが含まれます。また、トークン使用量とコストはエージェントの結果や使用状況イベントに表示される場合があります。ただし、互換プロバイダーがすべてのメタデータ項目を公開するとは限りません。ゲートウェイについては、Clineプロバイダーのリファレンスを確認してください。

この設定が適しているケース

コーディングエージェントにプロジェクトのドキュメントを検索させ、独自のアプリケーションで検索処理と引用の検証を実装できる場合に適しています。モデルへのアクセスと、回答を監査可能にする処理を分けて構築できます。これはすぐに使える文書Q&A機能ではありません。また、引用されているClineのページでは、OneMux固有の連携や文書引用の動作は確認されていません。

実践的な次のステップとして、プロバイダーのドキュメントに記載された値でエンドポイントを設定し、簡単なリクエストをテストしてから、検索と引用検証を別々の段階として追加してください。OneMuxモデルページで利用可能なモデルを確認し、現在のアカウント費用についてはOneMuxの料金を参照できます。この記事では、価格やパフォーマンスの比較は行いません。

FAQ

ClineのOpenAI互換プロバイダーは自動で文書を引用しますか？

提示されたClineのプロバイダードキュメントから、そのような機能は確認できません。説明されているのはプロバイダーの設定とゲートウェイ機能です。文書の検索、出典メタデータの提供、参照の要求と検証は、アプリケーション側で実装する必要があります。

OneMuxをClineで使えますか？

Cline SDKのドキュメントではopenai-compatibleプロバイダーが説明されています。OneMuxはOpenAI互換APIを通じてモデルを利用できます。特定の設定が機能するかどうかは、現在のエンドポイント、モデルID、認証方式、リクエストパラメーターによります。この記事では、連携がテスト済みとは述べていません。

この設定はClineエディター拡張機能向けですか？

参照している資料は、Cline SDKのモデルプロバイダーに関するものです。Clineエディター拡張機能やその他のインターフェースでの設定手順は確認できません。使用するCline製品とバージョンのドキュメントを参照してください。

回答を裏付ける出典がない場合、エージェントにはどう応答させるべきですか？

提示された文書からは回答を確認できないと伝えるよう指示し、返された引用をアプリケーションが検索した文章と照合してください。モデルが生成した引用だけを、参照先の資料が主張を裏付けている証拠として扱わないでください。

参考資料

• Cline SDK: Model Providers — プロバイダー設定、OpenAI互換の構成、ゲートウェイ、モデルメタデータ、利用状況に関する情報。