ドラフト環境に拡張機能を追加

カスタム拡張機能をアシスタントに追加するには、以下の手順を実行します。

1. **「統合」ページで、「拡張機能」**セクションまでスクロールし、追加するカスタム拡張機能のタイルを見つけます。

2. 追加 をクリックします。 拡張機能の概要を確認し、**「確認」**をクリックして、拡張機能をアシスタント用に構成します。

   拡張機能をアシスタントに初めて追加したときは、指定した構成設定はドラフト環境にのみ適用されます。 稼働環境に拡張機能を追加する前に、ドラフト環境の構成を完了しておく必要があります。

3. **「はじめに」ステップにある情報を読み、「次へ」**をクリックします。

4. Authentication ステップでは、アシスタントがサービスを呼び出すときに使用する認証とサーバー情報を指定します。

   • 「認証タイプ」 フィールドで、使用する認証のタイプを選択します (API が認証されていない場合は 「認証なし」 を選択します)。 使用可能な認証タイプは、 OpenAPI 文書で定義されているセキュリティー・スキームによって決まります。

   • 選択した認証タイプに必要な追加情報 (ユーザー名とパスワード、API キー、ベアラー・トークン、OAuth 2.0 の詳細など) を指定します。

     OAuth 2.0 認証の構成について詳しくは、 OAuth 2.0 認証 を参照してください。

   • **「サーバー」**フィールドで、使用するサーバー URL を選択します。

     選択した URL に変数が含まれている場合は、使用する値も指定します。 OpenAPI 文書で各変数が定義される方法に応じて、有効な値のリストから選択するか、またはフィールドで使用する値を入力します。

     生成された URL メッセージは、変数値を含むアシスタントが使用する完全な URLを表示します。

   次へ をクリックします。

5. 「拡張の管理」 ステップで、インポートされた OpenAPI 文書を確認し、必要に応じて置き換えることができます。 OpenAPI 文書の置き換えについて詳しくは、 OpenAPI 文書の置き換え を参照してください。

6. 「認証」 タブには、 OpenAPI 文書で定義されている認証方式に関する情報が表示されます。 表。 「認証」タブのフィールド には、「認証」タブのフィールドに関する詳細が表示されます。

   フィールド名	説明	値
   認証タイプ	OpenAPI スクリプトでセットアップされた認証のタイプ。	- OAuth 2.0 - Basic Auth - API key auth - Bearer auth
   ユーザー名	OpenAPI スクリプト内のユーザー名の資格情報。	例: user
   パスワード	OpenAPI スクリプトでセットアップされたパスワード資格情報。	例: Password@123
   servers	接続する Open API 文書で定義されているサーバーへのリンク。 API 拡張に追加します。	例: https://custom-extension-server.xyz

7. レビュー操作の表は、アシスタントがアクションステップから呼び出せる操作を示しています。 _操作_とは、特定のリソースに対して、 GET や POST のような特定の HTTP メソッドを使ったリクエストのことです。

   

   操作ごとに、テーブルの行には以下の情報が示されます。

   • 操作: 操作の説明。これは、OpenAPI ファイル内の summary (存在する場合) または description のいずれかから得られます。
   • メソッド: 操作の API 要求を送信するために使用される HTTP メソッド。
   • リソース: 操作の対象となるリソースへのパス。

   操作に関する詳細を表示するには、表内の行の横にある・アイコンをクリックします。 詳細は以下の通り：

   • 要求パラメーター: 操作に対して定義された入力パラメーターのリスト。各パラメーターのタイプも示されます。また、パラメーターが必須かオプションかも示されます。
   • レスポンスのプロパティ ：アシスタントがアクセスできる変数にマッピングされたレスポンスボディのプロパティ。

8. 「完了 (Finish)」 をクリックします。

9. **「閉じる」**をクリックして、「統合」ページに戻ります。

これで、拡張機能がアシスタントにつなげられて、ドラフト環境においてアクションで使用できるようになりました。

稼働環境用に拡張機能を構成

稼働環境用に拡張機能を構成するには、以下の手順を実行します。

1. **「統合」ページで、「拡張機能」**セクションまでスクロールし、追加するカスタム拡張機能のタイルを見つけます。

2. **「Open」**をクリックします。 **「カスタム拡張機能を開く (Open custom extension)」**ウィンドウが開きます。

3. **「環境」フィールドで「稼働中」**を選択します。 「確認」 をクリックします。

4. 本番環境で使用する値を指定して、設定プロセスを繰り返す。

   複数の環境を使用している場合は、同じステップに従って各環境の拡張機能を構成します。 詳しくは、 複数環境の追加および使用 を参照してください。

エクステンションは設定した環境で利用できるようになり、アシスタントから呼び出すことができます。 アクションから拡張機能を呼び出す方法について詳しくは、カスタム拡張機能の呼び出しを参照してください。

プランの制限

アシスタントに追加できるカスタム拡張の数は、プランによって異なります。 アシスタントに既に最大数の拡張を追加している場合は、1 つ削除してからでないと新しい拡張を追加できません。