【Prompt flow入門②】便利機能まとめ & Cognitive Searchのベクトル類似検索を実装する方法

# まえがき

[前回](https://qiita.com/sakue_103/items/0c1c225f52c2aeab4be1)に引き続き、Prompt flowを触ってみました。
今回は以下の便利機能についてまとめます。外部ツールの組み込みでは、ベクトル類似検索を一から実装してみました。

- マネージドオンラインエンドポイント
- Variant
- 評価
- 外部ツールの組み込み

「こんな機能もあるよ！」など、他にも便利機能ありましたらご連絡いただければ幸いです。評価についてはもっと深掘りしたいです。

また、以降の章では基本的に前回作成したものを使用します。
前回は簡易的に、「ユーザの入力からFunction calling用の関数定義のJSONを出力する」というタスクをPrompt flowにて実装しました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/f7b8a035-a868-6cf3-0fb9-51d3e4065306.png)


外部ツールの組み込み（ベクトル類似検索の実装）については、以下のようなタスクを扱います。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/8c86c953-c332-6d3b-5b9c-60ba0a5bccd6.png)




# ①マネージドオンラインエンドポイント

作成したフローを外部から呼び出せるようにするための機能です。

**イメージ**
- Azureポータルで見えているprompt flowは開発者用
- マネージドオンラインエンドポイントを作成することで、外部からユーザが利用可能に

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/57549401-7fe4-82a7-4224-6e885f8f9bec.png)



## デプロイ

画面右上にある**Deploy**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e663fc05-cd29-dc34-1fad-37f8f5a157c4.png)

認証方式とマネージドIDの種類を選択します。
ここでは、キー認証・システム割り当てを選択しています。
[認証の参考ページ](https://learn.microsoft.com/ja-jp/azure/machine-learning/how-to-authenticate-online-endpoint?view=azureml-api-2&tabs=azure-cli)、[マネージドIDの参考ページ](https://learn.microsoft.com/ja-jp/azure/machine-learning/how-to-setup-authentication?view=azureml-api-2&tabs=sdk)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/78b19707-0d8e-45ab-9282-e8fb118b5a09.png)

出力を選択します。今回はフローの最終的な出力を選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/15f30c85-7fd9-0c4f-0961-6e3afadf5c7f.png)

Azure OpenAIとの接続情報を選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/77a1ce9b-4152-0300-4367-3e3dc90757a0.png)

仮想マシンのサイズとインスタンス数を選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/cd266e5d-e5fd-b4b5-b86c-0f92361c2873.png)

確認画面で詳細を確認した後、**Deploy**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/6b98b43e-f1ff-df6e-9529-3b076f14ef17.png)


**Endpoints**をクリックすることで、詳細を確認できます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/11ef0073-1199-9897-58b1-b173474e4da8.png)


## テスト実行

**Test**タブに移動します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/ffee8f6d-c23b-f07d-16f1-92de9c902c3c.png)

**Test**をクリックすると、RBACのエラーが発生します。先ほど作成したマネージドIDになにもロールを割り当てていないためです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/3d629a93-57d2-c1f4-7d62-13dc9d0e2b43.png)

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/fbe1ad48-4e78-9dab-8a9f-c193811c09a0.png)


Azureポータルからロールを割り当てます。Azure Machine Learningのページを開き、
**アクセス制御→ロールの割り当ての追加**と進みます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/9508a2ad-76ed-4a5b-f28a-b8b647b49129.png)

**AzureML データ科学者**を選択し、**次へ**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/74508caf-d358-5d24-df13-5a29e114cd0d.png)

**マネージドID**を選択し、**メンバーを選択する**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/406a70c0-c967-6bb7-78ea-33bfb8956d3a.png)

マネージドIDの欄で**Azure Machine Learning workspace**を選択します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/64abb243-e47c-1b90-7c8f-63d737c5d8af.png)


**レビューと割り当て**をクリックし、ロール割り当てを行います。

再度テストを実行すると以下のような結果となりました。
「**入力：Slackで任意のメッセージを送りたい**」に対して期待通りのJSONが得られました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/b83c6f37-6267-5386-0a2b-5643ae220d86.png)

少し入力を変えて試してみました。「**入力：ユーザの入力を基にWeb検索をしたい**」として結果を見てみます。イイ感じですね。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/c886bd2b-d357-ff54-18ab-dfaed8b48c94.png)


## APIとして呼び出す

以下のようなリクエストを投げることで、外部からPrompt flowで作成したフローを実行できます。
これで好きにプログラムに組みこむことができる状態になりました。**/scoreにPOSTする**みたいですね。
また、リクエストボディには先ほど作成したフローのインプットに該当する```user_input```が必要となります。（フローのinputsの設定によって変わります。）

```sh:
curl -X 'POST' \
  'https://ws-test-bxvte.japaneast.inference.ml.azure.com/score' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <キー>' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_input": "I want to send a message in Slack."
}'
```



# ②Variant

複数のプロンプトを並列に実行し、結果の比較や評価を行うことができます。「プロンプトエンジニアリングの強い味方」といった感じでしょうか。

LLMの特性上、プロンプトを一行変えたり、内容は全く同じでも文章の構造が少し変わったりするだけでガラッと出力が変わってしまいます。（微調整が本当にしんどいです。）
そんな時に複数のプロンプトを並列に試して評価を行えるのは嬉しいですよね。


## プロンプトの複製

**Show variants**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/9737f156-96a5-030f-b4f4-8f16dedf6f77.png)


現在はvariant_0でこちらがデフォルトになっていることを確認できます。**Clone**をクリックしてvariantを追加します。クリックすると、2variantsになったことが確認できます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/0a6ebff1-8b13-65ac-93b2-6b79b30c1c42.png)

また、画面右側のフローの図をみるとプロンプトが複数になっています。（2枚重なっています。）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/049d740d-373b-0b51-ee78-7cdf73600685.png)


## プロンプトの編集

追加したvariant_1に該当するプロンプトを編集します。画面左側からvariant_1に該当するプロンプトを探し、**Diff mode**を有効化した上で編集します

今回は、デフォルトプロンプトから以下3点を変更してみました。

- システムメッセージを単純化
- one-shot部分を削除
- 出力条件を削除

variant_0は、前回イイ感じにFunction calling用のJSONを出力してくれるようにカスタマイズしています。
そのため、結果としては以下の表のようになることが期待されます。

|variant_0|variant_1|
|----|-----|
|期待通りのJSONを出力|要件を満たしていないJSONを出力|


![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/db7852a0-43c2-bbe9-c83e-0b036f86573c.png)


**Run**ボタンをクリックして実行してみます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/7481b07d-a24f-ae62-cd90-a8096274d8d7.png)

variantが複数ある場合、以下のような画面が出てきます。
全てのvariantsを実行するか、デフォルトのvariantのみ実行するか聞かれています。今回は全てのvariantsを実行してほしいので何も変更せず**Submit**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/0caf11b3-e803-d1a1-33e0-3891690f5359.png)


各variantの結果を確認します。以下のような結果となりました。
予想通りvariant_0はイイ感じのJSONを、variant_1はダメダメなJSONを出力しています。

```json:variant_0の結果：要件を満たしているのでOK
{
  "description": "Slackに任意のメッセージを送信する",
  "name": "send_slack_message",
  "parameters": {
    "properties": {
      "channel": {
        "description": "送信するチャンネル名",
        "type": "string"
      },
      "message": {
        "description": "送信するメッセージの内容",
        "type": "string"
      }
    },
    "required": [
      "message",
      "channel"
    ],
    "type": "object"
  }
}
```


```json:variant_1の結果：要件を満たしていないのでNG
{
  "text": "Slackに任意のメッセージを送りたい。"
}
```


今回は既に動作確認済みのプロンプトを用いていますが、実際には様々なプロンプトを微調整しながら開発することになるかと思います。そういった場合にvariantが活躍しますね。

また、今回は簡易的にoutputを見て各variantの結果を確認しましたが、Keyが足りていないJSONはエラーにするといったフローを組み込んだりすれば、そもそもエラーになるのでチェックしやすくなるなと思いました。
工夫次第でvariantの使い方の幅が広がりそうですよね。


# ③評価

## 実行
作成したフローを定量的に評価できます。また、variantごとに評価を実行することが可能です。
今回は以下のようなフローに対して評価を行っていきます。variantは先ほど作成したものを使用します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/0fce04b1-b961-91f2-bea5-590ebbd60597.png)

画面右上の**Bulk test**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/23db2a44-cd44-0b63-b220-a2440ee5ad67.png)

全てのvariantを評価したいので、デフォルトのまま変更せずに**Next**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/480bd87e-35bd-2ab8-9650-09a54afdc193.png)

次にテストの設定を行います。私の環境ではデータアップロード済みのため実際の表示と異なる可能性があります。**Upload new data**をクリックし、テストに使用するデータのアップロード画面に移動します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/40989377-f8fb-7b8b-9281-0e59783db0cc.png)

アップロードする前にデータを作成します。今回はjsonl形式でデータを定義しました。
データの中身は以下の通りです。

|ID|user_input|GroundTruth|
|-|-|-|
|データID|ユーザの入力|期待する答え|

```json:
{"ID": 1, "user_input": "Slackで任意のメッセージを送りたい", "GroundTruth": "{\"description\": \"Slackに任意のメッセージを送信する\",\"name\": \"send_slack_message\",\"parameters\": {\"properties\": {\"channel\": {\"description\": \"送信するチャンネル名\",\"type\": \"string\"},\"message\": {\"description\": \"送信するメッセージの内容\",\"type\": \"string\"}},\"required\": [\"message\",\"channel\"],\"type\": \"object\"}}"}
{"ID": 2, "user_input": "明日の天気を知りたい", "GroundTruth": "{\"description\": \"明日の天気を知る\",\"name\": \"get_weather\",\"parameters\": {\"properties\": {\"city\": {\"description\": \"天気を知りたい都市名\",\"type\": \"string\"}},\"required\": [\"city\"],\"type\": \"object\"}}"}
{"ID": 3, "user_input": "ある企業の現在の株価を知りたい", "GroundTruth": "{\"description\": \"企業の株価を知る\",\"name\": \"get_stock_price\",\"parameters\": {\"properties\": {\"company\": {\"description\": \"株価を知りたい企業名\",\"type\": \"string\"}},\"required\": [\"company\"],\"type\": \"object\"}}"}
```

上記のデータを定義したファイルをアップロードします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e1b5e6fe-3165-12cd-394a-a96b0b605f96.png)

データのアップロード後、データの先頭から数十件表示されます。（今回は3件のみですが）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/652d8bbd-efa9-7774-ee08-26c54054878d.png)

評価方法を設定します。様々な評価方法がありますが、今回は**QnA GPT Similarity Evaluation**を選択しました。今回のユースケースにおいて適切な評価方法ではないと思います、、（要調査）
評価に使用する値を設定します。先ほどアップロードしたデータの中から適切な値をquestion, ground_truth, answerにマッピングしています。
|question|ground_truth|answer|
|-|-|-|
|フローへの入力|期待する答え|フローの出力|

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/9c10bcc9-b44b-fe0a-3aec-639ab159b9c3.png)


上記設定を行った後、評価を実行します。


## 評価結果の確認

Bulk testの実行後、結果を確認します。
**Jobs**へ移動し、該当の**Experiment**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/b24ef6f2-5f05-8cd4-44d6-87d3c1083d74.png)

Bulk testのRunに該当するものをクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e5e333fb-fad2-7acf-9997-7a20ff664cb2.png)

Bulk testが各variantごとに評価が実行されていることがわかります。使用トークン数なども表示されていますね。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/a1cc35f1-9498-183e-23fb-116deac3912a.png)


Evaluation historyのNameをクリックし、結果の詳細を確認してみます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/ef0124c8-6b8c-3de0-ed4b-f00f9c8ff69b.png)

Prompt flowの画面に遷移します。評価のフローはPrompt flowで実装されているみたいですね。（解読すれば勉強になりそう）
今回選択した評価方法では、「**フローへの入力から得られた出力がGroundTruthとどのくらい類似しているか？**」というタスクをGPTに解かせているみたいです。Few-shotされているデータを見ると今回のケースではあまりうまく動作しなさそうですが、一旦無視して進めましょう。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/f1c4e6c7-c769-de46-f664-643c6240ed21.png)



では、評価結果を確認してみます。少しわかりにくいですが、画面上部の**View outputs**ボタンをクリックしてフローのoutputを表示します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/192f6464-7a3e-18cf-ab3f-741cbcf1c6b4.png)

**Metircs**タブに移動すると、2つのメトリックがあります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/d65ad656-9329-8189-c40f-75d10c753a8a.png)

どんな指標なのかはPrompt flowのコンポーネント群の詳細を見ることで確認できました。

上段は、「 **各データに対して5段階で類似度を計算し、平均を算出した結果** 」が表示されています。
下段は、「 **全データの内、類似度が3を超えているデータの割合** 」が表示されています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/05a993d7-3591-cc06-2cdc-6356a086779c.png)

今回の結果をまとめると以下のようになっています。

- 類似度平均はvariant_0の方が高い。
- pass_rateはvariant_0とvariant_1共に33%

評価に使っているプロンプトがあまり今回のケースには適していないので数値は全く参考になりませんが、評価の実行→結果の確認の流れを体験できました。








# ④外部ツールの組み込み

Prompt flowは外部API連携やCongnitive Searchとのデータ連携などを行えます。
画面上の操作で言うと、**More tools**をクリックすることで連携可能なツール群を確認可能です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/41b1892d-9ad3-e13e-05be-a00701392a0b.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/ae68d6eb-28c8-2309-4227-9fe9437461fe.png)


## 今回扱うタスク
今回はCognitive Searchと連携させ、Retrieval Augmented Generation(情報検索×生成タスク)を実装してみます。Congnitive SearchとAzure OpenAIを用いてベクトル類似検索を行い、検索結果を基にユーザの質問に回答する仕組みを作ります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/4d557c4c-ff3b-24d2-cd5b-f8e059e1dfe9.png)

Prompt flowで上記の処理を実装すると以下のようなフローになります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/a7158968-15d3-2d66-2c33-5e0a30fecf2b.png)



必要なものは以下の通りです。（作成済みのものとして話が進みます）

- Azure OpenAI
    - text-embedding-ada-002
    - gpt-35-turbo
- Cognitive Search
    - ベクトルを含むインデックス


**Azure OpenAIのリソースを作成し、モデルをデプロイした結果**
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/47313227-1cef-9816-9e11-920ccc793c3a.png)

**Cognitive Searchのインデックスフィールド**
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/94bdc1d6-4b59-9f53-28ae-f43ff5d14f33.png)


## サンプルが用意されている

今回扱うタスクについてですが、サンプルのPrompt flowが用意されています。（勉強目的なので今回はサンプルは使用しません。）

サンプルの確認方法を紹介します。
**Create**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/8b459061-2208-411c-1baa-4100094a115f.png)


すると画面下部に**Createfrom gallery**という欄があります。ここにサンプル集があります。
また、**Evaluation**タブに移動すると評価用のPrompt flowも確認できます。（実装の勉強になりそうなので後で覗く）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/03e819c4-ae5c-2be9-b0cc-3140dca4f4ee.png)

以降では、サンプルを使わずに一から実装していきます。

## Prompt flowと外部リソースの接続

Prompt flow内で外部リソースを扱うためにはConnection設定が必要です。Azure OpenAI/Cognitive Searchと繋いでおきます。
Flow一覧の画面から、**Connections**タブに移動し、**Create**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/6a3c721e-3ff4-e910-27cf-13729cf6e4ba.png)

**Azure OpenAIとの接続**
APIキーとエンドポイントが必要です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/5226004f-22c6-6eda-d16b-8f5cd863236a.png)

**Cognitive Searchとの接続**
APIキーとエンドポイントが必要です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/1290a04c-7c85-aab3-315c-f9ee030838a9.png)


接続設定後、Connectionsタブを確認すると以下のように2リソースとの接続情報が確認できます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/3a751b96-7617-730e-a26a-94a90384c95e.png)



## ベクトル類似検索

まずはベクトル類似検索を行うために必要なコンポーネントを用意します。
コンポーネントと呼ぶのが正しいか分かりませんが、必要なものをPrompt flow上に作成しておきます。
必要なものは以下の通りです。

- **LLM**
    - ユーザの入力をベクトルに変換する用
- **Vector DB Lookup**
    - Cognitive Searchインデックス検索用

新規に**Standard flow**を作成した後、**LLM**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/df9336ee-9aac-1111-3407-24fa873971d1.png)

すると、画面左側のコンポーネントの定義一覧にLLMが追加されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e6fe0f29-d73f-ecd1-38a4-3387a304849f.png)

こちらを編集していきます。
**ペンマーク**をクリックして名前を変更、**Api**をembeddingに変更、**input**をフローの入力に変更します。
（他のコンポーネントだとinputが選択式でしたが、今回手入力する必要がありました:open_mouth:）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/052938d7-c20e-09b7-0c9f-1a2198973f9e.png)


変更後、画面右側のフローが可視化されている領域を確認してみます。inputs(=ユーザの入力)が先ほど追加したLLMとつながっているのでよさそうです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/b85641ca-cd59-cb84-dfb0-cdf5fcd40026.png)

(hello_promptとecho_my_promptは必要ないので削除します。**ゴミ箱マーク**で削除可能です。)


続いて、**More tools**をクリックし、**Vector DB Lookup**を追加します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/c018d7f0-4604-ba95-a051-584d33cd8673.png)

追加されたコンポーネントの定義を編集します。（名前の変更は任意です）
以下、変更したパラメータです。Cognitive Searchの設定に合わせる形で各パラメータを設定していくイメージです。

|パラメータ名|概要|値|
|-|-|-|
|connection|Cognitive Searchとの接続情報|cognitive-search-test|
|index_name|Cognitive Searchのインデックス名|index-for-myllmapp-v2|
|text_field|文字列に該当するフィールド|content|
|vector_filed|ベクトルに該当するフィールド|contentVector|
|vector|検索に用いるベクトル|${text_embedding.output}|

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e1b7950a-5cd8-3034-60ef-f1ea964e12e8.png)


パラメータvectorに**text_embeddingの出力**を指定しているため、フローの図を見ると以下のようになっています。（一度実行したためCompletedとなっていますが、ステータス表示は無視で大丈夫です。）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/6ed48800-af79-e1bb-a9a6-1d94cafe5840.png)

Outputsがフローに繋がっていないため、Outputsを編集してつなぎます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/ab7e295f-2d0e-8efa-6d4e-7c7c7d938e87.png)

Outpusに**VectorSearchの出力**を指定したため、フローを見ると以下のようになっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/9413df2c-acf6-eeba-7dc2-066d9ec2e9bf.png)


ここまでで一度テスト実行します。**Runtime**が設定されていることを確認し、**Run**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/84a1e7ab-2b0d-1a8b-3b2c-8cf87f97c67d.png)

無事に実行が終わると、画面右側のフローに実行ステータスが追加されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/8313924b-664c-e672-139f-3bfb58ce8760.png)

今回はテスト用に以下のような画像を用いて、Cognitive Searchでインデックス化するために必要な情報を作成・保持しています。具体的には、以下の情報が含まれます。
- **content: 画像から抽出した文字列**
- **contentVector: 文字列をベクトル化したもの**

![責任あるAI.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/cbda414b-c0ba-d4f0-712b-81d3e1b28f39.png)

Prompt flowへの入力を「**責任あるAIってなに？**」として実行し、最終的な出力を確認すると以下のようになっていました。
```score, text, vector```が含まれているみたいですね。ファイル名に該当する値はありません。
検索という意味ではよさそうですが、プロンプトには情報のソース(ファイル名)を埋め込みたいですよね、、。ファイル名も出力できるようにしてほしいところです。

```json:出力: 一部抜粋
{
    "output": [
        {
            "score": 0.91211456,
            "text": "責任ある AlMicrosoft は、人を第一に考える原則に基づいて、AI の発展に取り組んでいます...。",
            "vector": [0.004075101, -0.0278097223, ...]
        },
        {
            @search_scoreが2番目に高いやつ
        },
        {
            @search_scoreが3番目に高いやつ
        }
        
    ]
}
```


## ベクトル類似検索の結果を整形

ベクトル類似検索の結果を基にプロンプトを作成するためのコンポーネントを追加します。
必要なコンポーネントは以下の通りです。

- **Python**
    - ベクトル類似検索の結果から必要なデータを抽出
    - 各データを文字列として結合
- **Prompt**
    - 検索結果を受け取る ( = **Python**の出力を受け取る)
    - 検索結果を基に回答させるためのプロンプトを記述



**Python**と**Prompt**をクリックしてコンポーネントを追加します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/936d66ea-34b6-b1ed-8319-06daf6554e61.png)


Pythonコンポーネントを編集していきます。
**名前**を変更、**Code**を変更、**Validate and parse input**をクリック、**inputsのValue**を変更します。
<details>
<summary>配置するソースコード</summary>

```py:
from promptflow import tool
from embeddingstore.core.contracts import SearchResultEntity

@tool
def format_search_result(search_result: list[dict], source_field:str) -> str:
  result_str = ""

  for result in search_result:
    filename, content = _extract_doc_info(result, source_field)
    result_str += f"filename:\n{filename}\n\ncontent:\n{content}\n\n###\n\n"

  return result_str

def _extract_doc_info(doc:dict, source_field:str):
  entity = SearchResultEntity.from_dict(doc)
     
  filename = entity.original_entity[source_field]  # ファイル名に該当するフィールドの値を抽出
  content = doc["text"]

  return filename, content
```

</details>

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/1e97b371-e16b-9310-f981-e94ff03f83e7.png)

先ほども触れましたが、Prompt flowからベクトル検索した結果の中にファイル名に該当する値が含まれていません。
RAGでは情報のソースを含めつつ回答させることになると思いますので、ファイル名を取得してくるための小細工をしています。(```_extract_doc_info()```)
私の環境で作成しているインデックスではファイル名に該当するフィールド名は**filename**なので、それを引数で渡すようにしてみました。

OutputsをこのPython関数の出力に変更します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/b946f917-ce55-0ff5-0b04-6f3f02f0b54f.png)


ここまででテスト実行してみます。ステータスは全てCompletedなのでよさそうです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/25965159-a1da-ed08-6e51-ff9e3bf66945.png)

最終的な出力も確認してみます。画面上部にある**View outputs**をクリックします。（もっとわかりやすいボタンや表示にしてほしいところ、、。）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/3d1f5333-95e3-44d4-e539-14e4350bee5a.png)


今回確認するのは、**output_prompt**です。```filename```と```content```が含まれているのでよさそうですね。
余談ですが、この画面からログや実行時間など様々な情報を確認可能です。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/5d425526-3eea-01a5-6c13-06aa5be4afd3.png)


## プロンプトを作成

Python関数にて、ベクトル検索の結果を整形できました。整形後の文字列をプロンプトに埋め込んでいきます。

現在の状態を確認しておくと、以下のようなフローになっているかと思います。プロンプトが浮いています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/0dc9b24c-324e-1506-599b-969c83eefda4.png)


浮いているコンポーネントを関連づけます。具体的には、以下のような設定を入れ込みます。

- **入力** : 2つ
    - inputs ( =ユーザの最初の入力)
    - format_search_resultの出力 ( =ベクトル検索結果の整形後文字列) 
- **出力**: 1つ
    - outputsに向ける

上記の設定を終えるとフローは以下のようになります。（今更ですが、フローの可視化めちゃくちゃいいですよね。設計図代わり。）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/1ccbc13c-b245-8ab3-2506-d36272cb996e.png)


まず、入力部分の設定です。Promptコンポーネントの定義を編集します。今回はテストなので適当なプロンプトを用います。
**名前**を変更、**Prompt**を編集、**Validate and parse input**ボタンをクリック、**InputsのValue**を編集します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/b2a2b8f0-7732-5579-1a88-349c28ea6afa.png)

<details>
<summary>プロンプト</summary>

```sh:例
system:
- あなたは検索結果を基にユーザの質問に回答するアシスタントです
- ユーザの質問に適切に回答するために、ステップバイステップで慎重に考えることができます

user:
[検索結果]
{{search_result}}

[質問]
{{user_input}}
具体例を用いてわかりやすく説明して。回答の参考にしたファイルの名前を必ず表示すること。
```

</details>

今回は後の処理でchatタイプのモデル(gpt-35-turbo)を使用します。その場合、Promptは以下のような書式にする必要があります。

>system:
システムメッセージ
assistant:
AIメッセージ
user:
ユーザメッセージ



次に出力の設定を編集します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/49a5162e-127a-954e-2d63-8bb3a2f59edf.png)


**Run**をクリックしてテスト実行し、ステータスに問題がないことを確認します。






## LLMを追加し、回答を生成

「入力のベクトル化→情報検索→プロンプト作成」まで完了しました。あとは推論実行するだけです。

**LLM**をクリックします。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/6b4b15ca-56dd-b919-300f-35e44abec1d7.png)

コンポーネントの定義を編集します。
- **名前**を変更
- **Api**をchatに変更
- **temperature**を0に設定
- **max_tokens**を400に設定
- **Prompt**を変更
- **Validate and parse input**をクリック
- **InputsのValue**を変更

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/e984479b-e0ac-5f4e-433c-56f93c769efa.png)


フローの出力として、このコンポーネントの出力を指定します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/393221/3bfc4339-fc47-509d-23f8-2fae024183ff.png)



## 実行と結果の確認

**Run**をクリックして実行し、結果を確認してみます。
下記jsonのoutputを見るとイイ感じの回答をしてます。ファイル名もちゃんと出力してくれていますね。
またsystem_metricsからトークン数なども確認できるみたいです。

```json:実行結果
{
  "system_metrics": {
    "completion_tokens": 267,
    "duration": 6.867124,
    "prompt_tokens": 1906,
    "total_tokens": 2173
  },
  "output": "「責任あるAI」とは、AIの開発や運用において、人間の利益や安全性を最優先に考慮し、慎重に設計されたAIのことを指します。具体的には、AIが生成するコンテンツが正しくない、または有害なものにならないように、適切なフィルターやガイダンスを提供することが含まれます。\n\n例えば、Microsoftは、Azure OpenAIで使用できる生成モデルについて、責任あるAI使用に関する原則を取り入れ、顧客をサポートするコンテンツフィルターを構築するなど、慎重な設計と熟考した軽減策を講じています。この情報は、ファイル名が「責任あるAI.png」のファイルから得られました。"
}
```







# まとめ・所感

Prompt flowの便利機能とベクトル類似検索の実装方法を紹介しました。
評価や外部ツールの組み込みはめちゃくちゃ使えそうですね。使いこなせるようになりたい。
個人的に開発しているLLMアプリケーションのコア部分をPrompt flowに移行してみたいです。（経験値上がりそう。）

また、評価がPrompt flowで実装されているのが興味深かったです。実装した人に使用感や実際便利なのかどうかインタビューしたいですね。笑
以下のような質問がきそうだなあと思ってました。

>偉い人：
「評価をGPTベースでやるとなると、その評価するプロンプトは評価しなくていいの？」


Prompt flowには多くのサンプルが用意されていました。（chat形式、ベクトル検索、評価など）
サンプルをcloneしてきて中身を確認できるので、実装例から多くのことを学べそうです。色々試そう。