Flowのみで実装するChatGPT・SalesforceのAPI連携

Last updated at 2024-09-18Posted at 2023-12-09

1. Introduction

本記事は非エンジニア向けにSalesforce上でもChatGPTを利用する機能を構築を説明しております。
Apex等プログラミング言語を用いず、ノンコードでAPI連携を構築できるので、これからSalesforceの開発に取り組む方の一助になればと思います。

Winter'24で実装されたFlowの最新機能を用いて実装します！
HTTP コールアウトを介してコードなしで Salesforce データを外部サーバーに送信 (正式リリース)

2. 目次

以下の流れでSalesforceからChatGPTのAPIを呼び出す機能を構築します。

No.	章
1	3_1. API(OpenAI)の仕様書の確認
2	3_2_1. 外部ログイン情報の構築
3	3_2_2. 指定ログイン情報の構築
4	3_3. 画面フローの構築

3. 手順

Winter'24で実装された機能の為、参考となるドキュメントが一切ありませんでした…
ただ、本記事の実装方法をマスターすると、Apexで実装するよりも1/2の工数(筆者体感…)で実装できるため、触ってみて良かった！となるはずです…

3_1. API(OpenAI)の仕様書の確認

タイトルにある通り、Flowを使ってSalesforceからChatGPTを呼び出す機能を構築する為、呼び出し先のChatGPTのAPIドキュメントを見てみましょう。

Chat Completions APIに記載の通り、以下のURLがAPIを呼び出すエンドポイントの様です。
本ドキュメントにはJavaScriptやPythonで呼び出すサンプルコードが記載されてますね。

サンプルコード（Node.js、抜粋)

const response = await openai.chat.completions.create({
    model: "gpt-3.5-turbo",
    messages: [{"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who won the world series in 2020?"},
        {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
        {"role": "user", "content": "Where was it played?"}],
  });

上記記載の通り、今回はChatGPTのバージョン「gpt-3.5-turbo」を利用する為、Chat Completions APIをエンドポイントとして指定します。
APIのリファレンスはこちら。

エンドポイント(Chat Completions API)

https://api.openai.com/v1/chat/completions

Continuous model upgradesにも記載の通り、ChatGPTには「gpt-4」等様々なバージョンが存在します。利用するバージョンによってChatGPTの性能が異なるようです。

ChatGPTはエンドポイントとしてCompletions APIがありますが、今年中に廃止される機能の為、絶対に使用しないでください。

3_2_1. 外部ログイン情報の構築

Salesforceの画面を開き、ChatGPTのAPIを利用する為の認証情報を追加します。
設定画面を表示し、セキュリティ＞指定ログイン情報＞外部ログイン情報を選択し、以下の画面から「新規」ボタンをクリックしてください。

以下の通り、「新規外部ログイン情報」を作成する画面が表示されるので、任意の名称を入力の上、「認証プロトコル」を「カスタム」に設定の上、「保存」ボタンをクリックしてください。

保存すると以下のとおり詳細設定画面が表示されるので、Chat GPTを呼び出すために必要な情報を設定していきます。
※赤枠部分が設定する箇所になります！

3_2_1_1. プリンシパルの設定

Salesforceにおける「プリンシパル」は、一般的にユーザー、グループ、またはシステムなど、リソースにアクセスする権限を持つエンティティを指します。
Chat GPTを呼び出す際に必要な情報をパラメーターとして定義するもの、とここでは理解ください。

上記の通り、必要なパラメーターは「API Key」「Org」のみです。
早速Chat GPTのパラメーターを設定していきましょう。

パラメーターの名称は任意で設定できます。
お好きな名称で設定ください。

OpenAI developer platformよりログインし、以下の画面を表示してください。
画面サブの「Setting」をクリックし、「Organization ID」に表示されている文字列をコピーします。 - ①

次に、「API keys」を選択し、「Create new secret key」をクリックします。

任意の名前を入力し、「Create secret key」を選択してください。
APIを呼び出すためのKeyが発行されるので、生成された文字列をコピーしてください - ②

一度生成されたAPI Keyは再度表示する事が出来ません。
生成されたAPI Keyを忘れた場合は再度生成する必要があるので、忘れないように控えておいてください。

3_2_2. 指定ログイン情報の構築

外部ログイン情報の時と同様に、設定画面を表示しセキュリティ＞指定ログイン情報を選択し、以下の画面から「新規」ボタンをクリックしてください。

以下赤枠部分に必要な情報を入力し、「保存」ボタンをクリックしてください
・入力前

・入力後

項目「URL」にはText generation modelに記載の通り、「https://api.openai.com/v1/completions
」を入力し、項目「外部ログイン情報」には3_2_1. 外部ログイン情報の構築で作成した外部ログイン情報を設定する。

3_3. 画面フローの構築

これでSalesforceからChatGPTを呼び出す準備が整いました！
上記で作成した認証情報を元に、画面フローからChatGPTを呼び出しましょう。

設定画面を表示し、プロセスの自動化＞フローを選択し、以下の画面から「新規」ボタンをクリックしてください。

完成したフローは以下になります。
今回は、開発に際しポイントとなる下図①「ChatGPT入力画面」②「HTTPリクエストの作成」③「HTTPリクエストの実行」④「HTTPレスポンスの処理」を解説します。

①「ChatGPT入力画面」

下記の通り、Salesforceの画面（今回はケースレコード詳細画面を想定）にて、ChatGPTへの命令文（プロンプト）を入力する画面を作成しました。
特筆すべき事項はないですが、赤枠部分の「SelectCaseRecord.Description」は、表示したケースの項目値をプリセットするために用意しております。

②「HTTPリクエストの作成」

ChatGPTに対するHTTPリクエストを作成しております。
The message objectにも記載の通り、最低限パラメーター「Message」の「role」「content」に値を入力する必要があります。

また、以下の画面の通り、上記で作成した変数をパラメータ「Message」に、パラメーター「model」に今回利用するChatGPTのモデル（今回は「gpt-3.5-turbo」を利用）を設定します。

HTTPリクエストを作成するにあたり、2つのフローの変数を作成しました。
　１．Apex定義「RequestBody」：実際に送信するHTTPリクエスト
　　┗ExternalService__（外部サービス名）（外部サービスの操作）_IN_body
　２．Apex定義「RequestBodyMessage」：１内のパラメーター「Message」の定義
　　┗ExternalService__（外部サービス名）（外部サービスの操作）_IN_body_messages

なお、詳細な内容は割愛しますが、上記外部サービスは3_2_1. 外部ログイン情報の構築 3_2_2. 指定ログイン情報の構築にて外部ログイン情報及び、指定ログイン情報が作成されると同時に自動的に作成される資材で、併せて動的なApexクラスも作成されます。

上記変数１．Apex定義「RequestBody」２．Apex定義「RequestBodyMessage」については、下記の通り自動的に作成されたApexクラスを元に変数を作成し、利用してください。

③「HTTPリクエストの実行」

今度は作成したHTTPリクエストを実行するアクションを作成します。

アクションの作成画面から、右下の「HTTPコールアウトを作成」を押下します。

任意の名称を入力し、項目「指定ログイン情報」に3_2_2. 指定ログイン情報の構築で作成した指定ログイン情報を入力します。

次に表示された画面から、項目「メソッド」に「POST」と入力します。

画面をスクロールすると、HTTPリクエストおよびHTTPレスポンスの形式を定義するボタンが表示されます。
サンプルとなるJSONを入力する必要があるので、The message objectに記載の下記コードを入力してください。

サンプルリクエスト（JSON)

{
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1698983503,
  "thread_id": "thread_abc123",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "Hi! How can I help you today?",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": "asst_abc123",
  "run_id": "run_abc123",
  "metadata": {}
}

サンプルレスポンス（JSON)

{
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1699017614,
  "thread_id": "thread_abc123",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "How does AI work? Explain it in simple terms.",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": null,
  "run_id": null,
  "metadata": {}
}