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

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

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

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

1. Automation Cloud^TM で [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 を分析すると、次のコンポーネントを確認できます。

• BaseURL: 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" 
     }

   
   

   

   
   

   
   

   

   
   

   
   

   

   
   

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

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

Activity Designer helps curate input and output fields that you want to expose to users for this activity. This represents the "look and feel" when the API connector is used in UiPath Studio or Studio Web. For more information, refer to Activity designer.

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

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

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

Next, publish your connector in your tenant of choice. For more information, refer to Publishing your connector. Then you can use it in your Studio Desktop or Studio Web workflows.

Studio Web

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

   

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

デスクトップ版の Studio

注:

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

1. デスクトップ版の Studio が、コネクタがパブリッシュされたテナントと同じテナントに接続されていることを確認します。
2. [ アクティビティ] パネルで、[ 利用可能 ] フィルターが有効化されていることを確認します。
3. [ アクティビティ] パネルの [利用可能 ] セクションで、使用するコネクタ名を検索します。 任意のアクティビティをワークフローにドラッグ アンド ドロップします。 これにより、カスタム アクティビティを含むすべての Integration Service ベースのアクティビティを含む、統合 UiPath.IntegrationService.Activities パッケージがインストールされます。
4. または、[ パッケージを管理] パネルを使用して、 UiPath.IntegrationService.Activities パッケージを検索してインストールすることもできます。