例 A: 個人用アクセス トークン認証を使用して空白のキャンバスからコネクタを構築する

次の例では、個人用アクセス トークン認証を使用して、空のキャンバスから OpenAI DALL-E のコネクタを構築します。

新しいコネクタを作成する

この例では、OpenAI モデル DALL-E を使用して、テキスト プロンプトに基づいて画像を生成する方法を説明します。

1. Integration Service に移動します。

2. [コネクタ カタログ] ページで、[ コネクタを構築 ] または [ コネクタ ビルダー] を選択します。

3. 次に、[ 新しいコネクタを作成] を選択します。

4. [ 空白から開始] を選択します。

5. コネクタ の名前 を追加し、任意で説明とアイコンを追加します。

6. [作成] を選択します。

   

API リソースを設定する

動作のしくみ

まず、APIを介して画像を生成する方法を確認しましょう。

DALL-E では、プロンプトを指定すると、安全上の理由からモデルによって自動的にプロンプトが書き換えられ、詳細が追加されます。一般に、プロンプトが詳細であるほど出力の品質が高くなります。その後、モデルは生成された画像をリンク ("responseformat": "URL") または Base64 の文字列 ("responseformat": "b64_json") のいずれかを使用して出力します。URL は、API 仕様に基づく既定値です。API パラメーターについて詳しくは、『 API リファレンス - OpenAI API』をご覧ください。

この API を使用して画像を生成する cURL の例を次に示します。

cURL https://api.openai.com/v1/images/generations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $OPENAIAPIKEY" \   -d '{       "model": "dall-e-3",      "prompt": "A robot automating human task in computer",      "n": 1,      "size": "1024x1024"    }'

認証メカニズムとリソースを設定する

コネクタの最初の API リソースを構築する際には、次の 3 つの重要な点に留意する必要があります。

• ベース URL
• 認証の種類
• API 操作とリソース (ルートと呼ばれることもあります)

前の cURL を分析すると、次のコンポーネントを確認できます。

• ベース URL: https://api.openai.com/images
• 認証の種類: Authorization: Bearer $OPENAIAPIKEY
• API 操作とリソース: post /generations

ベース URL は、呼び出しを実行する API リソースの場所またはエンドポイントを示します。

認証の種類は、ユーザーが API リソースの使用を許可される前にどのように認証されるかをコネクタに指示します。この例では、OpenAI API キーを使用して、個人用アクセス トークンを認可ヘッダーのベアラー トークンとして使用しています。

API ルート (操作とリソース) は、API で利用可能な特定のリソース (例: /generations) へのパスを提供します。 リソースはベース URL に追加されます。この URL では、そのリソースを取得/リスト表示 (GET)、追加/挿入 (POST )、更新/更新/挿入 (PATCH/PUT)、削除 (DELETE) を行うことができます。

ワークフローに必要なアクティビティに基づいて、必要な数の API リソースと API 操作を追加できます。 たとえば、画像の生成 (POST /generations)、生成されたすべての画像を GET /generations で一覧表示する (リソースで GET 操作が使用可能な場合)、既存の画像の編集 (POST /edits) を行うことができます。

注:

コネクタ ビルダーは現在、 application/json をフォーム データではなくペイロード コンテンツの種類 としてサポートしています。DALL-E モデルの画像編集機能は、現時点ではコネクタ ビルダーでは実行できない場合があります。

API リソースの出力をテストする

ワークフローでコネクタをパブリッシュして使用する前に、まずコネクタをテストしてください。

1. コネクタが [接続済み ] ステータスであることを確認します。ウィンドウの右上隅にある [ コネクションを追加 ] を選択し、選択した認証メカニズムを使用してコネクションを設定します。

   

2. 最初の API リソースに移動し、[ 要求を送信] を選択します。

3. 次の cURL スクリプトに示すように、API の本文またはペイロードを指定します。

   {     "model": "dall-e-3",     "prompt": "A robot automating human task in computer",     "n": 1,     "size": "1024x1024"   }{     "model": "dall-e-3",     "prompt": "A robot automating human task in computer",     "n": 1,     "size": "1024x1024"   }

   

   

   

アクティビティを設定する

コネクタをテストできるようになったので、 アクティビティ デザイナーを使用して、この特定のアクティビティのワークフロー コンポーネントのデザインを設定できます。

アクティビティ デザイナーは、このアクティビティでユーザーに公開する入力フィールドと出力フィールドをキュレーションするのに役立ちます。これは、API コネクタを UiPath Studio または Studio Web で使用する場合の「ルック アンド フィール」を表します。詳しくは、「 アクティビティ デザイナー」をご覧ください。

フィールドの表示名の変更、入力フィールドが必須かどうかのマーク、プライマリ パラメーターかセカンダリ パラメーターかなどを変更することができます。[ 要求を送信 ] アクションを実行すると、入力フィールドが要求フィールドまたは本文から自動生成されます。

応答フィールドまたは出力フィールドについては、応答のルート キーを更新して、次の図に示すように、API 応答から特定の出力属性 ( revised_prompt や URLなど) をキュレーションできます。

コネクタをパブリッシュする

次に、選択したテナントにコネクタをパブリッシュします。詳しくは、「 コネクタをパブリッシュする」をご覧ください。その後、デスクトップ版の Studio または Studio Web のワークフローで使用できます。

Studio Web

1. Studio Web で、新しいプロジェクトを作成します。 アクティビティの検索パネルでカスタム アクティビティを検索し、ワークフローに追加します。

   

2. カスタム アクティビティからコネクションを作成し、パラメーターの設定を開始します。

3. ワークフローをテストします。

デスクトップ版の Studio

注:

v2023.10 以降のデスクトップ版の Studio が必要です。

1. デスクトップ版の Studio が、コネクタがパブリッシュされたテナントと同じテナントに接続されていることを確認します。

2. [ アクティビティ ] パネルで、[ 利用可能 ] フィルターが有効化されていることを確認します。

3. [アクティビティ] パネルの [利用可能] セクションで、コネクタ名を検索します。任意のアクティビティをワークフローにドラッグ アンド ドロップします。これにより、Integration Service ベースのアクティビティすべて (カスタム アクティビティを含む) を含む統合 UiPath.IntegrationService.Activities パッケージがインストールされます。

4. または、[ パッケージを管理] パネルを使用して UiPath.IntegrationService.Activities パッケージを検索してインストールすることもできます。