インストールと管理

プラグインマーケットプレイスまたは公式サイトのインストールURLを使用してタスクプラグインをインポートし、有効化ステータス、バージョン、およびマーケットプレースソースを管理します。

準備作業

**Root（スーパー管理者）**としてNew APIインスタンスにログインし、「タスクプラグイン」（/task-plugins）を開きます。デプロイバージョンにタスクプラグイン機能が含まれていることを確認し、ページ上部のタスクプラグインの全体スイッチをオンにしてください。

通常のAPIキーはモデル呼び出しに使用され、プラグインのインストールには使用できません。ページが表示されない場合や403エラーが返される場合は、まずアカウントロールとデプロイバージョンを確認してください。

インストール前の確認

プラグインは、現在のチャネルのクレデンシャルを使用してアップストリームリクエストを構築できます。インストール時には、ソースコード、バージョン差分、デフォルトのBase URL、および許可される追加ホストを確認する必要があります。コンパイルが成功したことやハッシュが一致したことは、コードがセキュリティレビューを通過したことを意味しません。

インスタンス内のプラグインマーケットプレイスからのインストール

「タスクプラグイン」内の「プラグインマーケットプレイス」（Marketplace）を開きます。
マーケットプレイスソースを選択し、対象プラグインを検索し、サポートモデルとAPIを確認します。
インストールするバージョンを選択し、更新履歴と移行ガイドを読みます。アップグレード時には、現在インストールされているバージョンとのソースコードの差分を確認してください。
プラグインのソースコードのダウンロードとSHA-256検証が完了するのを待ち、確認後「インストールして有効化」を選択します。
インストール済みリストに戻り、実際に有効なバージョンを確認します。その後、チャネルの構成と課金設定を行います。

マーケットプレイスからのインストールでは、インデックス宣言されたハッシュを使用してソースコードを検証し、サーバーサイドで再度コンパイル、メタデータの検証、および競合の確認が行われます。チャネルタイプまたはルーティングの競合が発生した場合、インストールは拒否されます。まず競合を解決してから再試行してください。

ドキュメントサイトから公式サイトのインストールURLをコピーする

ドキュメントサイトのプラグインマーケットプレイスを開きます。
プラグインカードまたは詳細で「インストールURLをコピー」をクリックします。
自分のNew APIインスタンスに戻り、「プラグインをアップロード」を選択し、「URLからインポート」（Import from URL）にURLを貼り付けてソースコードを読み込みます。
プラグイン情報とソースコードを確認後、保存し、プラグインが有効化されていることを確認します。

コピーされるのは、公式サイトでホストされている plugin.js のURLです。docs.newapi.pro は www.newapi.pro を使用し、docs.newapi.ai は www.newapi.ai を使用します。言語はドメイン選択に影響しません。

インストールURLの形式は次のとおりです。

https://www.newapi.pro/api/v1/plugins/<plugin-key>/plugin.js
https://www.newapi.ai/api/v1/plugins/<plugin-key>/plugin.js

このようなバージョンが固定されていないURLは、インポート時に公式サイトの現在の最新バージョンを取得しますが、インストール済みのプラグインを自動更新することはありません。バージョンを指定する必要がある場合は、インスタンス内のマーケットプレイスでバージョンを選択することを優先してください。過去の更新履歴を確認しても、ドキュメントサイトのコピーボタンが提供する最新バージョンのURLは変更されません。

ローカルの .js ファイルを選択するか、ソースコードを直接貼り付けることもできます。手動でのURLインポートは、マーケットプレイスインデックスに基づく完全性検証とは異なります。インデックスハッシュ検証が必要な場合は、マーケットプレイスインストールプロセスを使用してください。

マーケットプレイスソースの管理

インスタンスはデフォルトで公式サイトとGitHubの2つのソースを提供します。マーケットプレイスソースは、公式サイトのHTMLページではなく、インデックスv1形式に準拠した index.json を指している必要があります。

正在加载官网地址…

上記の公式マーケットプレイスソースURLは、現在のドキュメントサイトのドメインに基づいて選択されます。一般的なGitHubソースは次のとおりです。

https://raw.githubusercontent.com/QuantumNous/new-api-plugins/main/index.json

サードパーティソースを追加する際は、インデックスとそのインデックスが参照するプラグインファイルがすべてアクセス可能であることを確認してください。ブラウザからのインポートには、オリジンサイトがクロスオリジン読み取りを許可している必要もあります。ダウンロードできない場合は、ネットワーク、CORS、およびファイルサイズを確認してください。現在のプラグインソースコードの最大サイズは 1 MiB です。

アップグレードとロールバック

各プラグインは key + version でバージョンを識別します。同じkey/versionで異なるソースコードをアップロードすることはできません。プラグインを変更する場合は、新しいバージョンを使用する必要があります。
新バージョンインストール後、インストール済みリストで現在有効なバージョンを確認します。プラグイン詳細のバージョンリストで保存済みのバージョンをアクティブ化して、アップグレードまたはロールバックを完了することもできます。
アップグレード前にMigration（移行ガイド）を読み、モデル名、Base URL、使用量フィールド、および価格を確認してください。プラグインのデフォルトBase URLの変更は、既存のチャネルを自動的に変更することはありません。
処理中のリクエストは、その時点のプラグイン実行コードを固定的に使用します。バックグラウンドポーリングは、後でアクティブ化された新しいバージョンを使用する可能性があります。新しいバージョンは、未完了タスクのデータと互換性がある必要があり、アップグレードとロールバックの両方でこれを考慮する必要があります。

無効化と削除

まず関連チャネルと進行中のタスクを確認し、管理ページの指示に従って参照を処理してください。強制的な操作を通常のアップグレード手順と見なさないでください。

組み込みプラグインは個別に無効化または削除できません。組み込みプラグインを上書きするカスタムバージョンについては、上書きを無効化または削除すると組み込みバージョンに戻ります。サードパーティの独立プラグインは、無効化または削除されると対応する機能を提供しなくなります。

タスクプラグインの全体スイッチ

全体スイッチをオフにすると、組み込みプラグインを含むタスクプラグインシステム全体が停止します。進行中のタスクはタイムアウトクリーンアップ処理に委ねられるため、全体スイッチを単一プラグインの無効化ボタンとして使用すべきではありません。

インストール失敗、バージョン競合、または実行ノードの状態不一致が発生した場合は、よくある質問を参照してください。