5.2.1.20.18. ランク融合¶
複数の異なるランキング結果を一つの統合されたランキングにまとめるためのタスクです。
ランクの統合には Reciprocal Rank Fusion(RRF) を使用します。
5.2.1.20.18.1. 入力値¶
im_reciprocalRankFusion <object> *
├─ contentsList <object[]> *
| └─ contents <object[]> *
| ├─ id <string>
| ├─ score <double>
| ├─ text <string>
| ├─ metadata <map>
| └─ originSourceId <string>
├─ k <integer>
├─ threshold <double>
└─ limit <integer>
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_reciprocalRankFusion | 必須 | object | なし | - |
| contentsList | 必須 | object | リスト | ランク融合を行うコンテンツの一覧を指定してください。
|
| contents | 必須 | object | リスト | ランク融合を行うコンテンツの一覧を指定してください。
※コンテンツはランキング順で並んでいる必要があります。
|
| id | 任意 | string | なし | コンテンツの一意識別子を指定してください。
|
| score | 任意 | double | なし | コンテンツのスコアを指定してください。
|
| text | 任意 | string | なし | コンテンツに埋め込まれたベクトル表現の生成元テキストを指定してください。
|
| metadata | 任意 | map | なし | コンテンツに付与されたメタデータを指定してください。
|
| originSourceId | 任意 | string | なし | コンテンツの参照元となる情報源を識別するIDを指定してください。
例:ファイル名、WebサイトのURLなど、登録するコンテンツの出所を特定できる値を指定します。
IDには制御文字、ダブルクォート、シングルクォート、セミコロン、不等号、パイプ、バックスラッシュ、アスタリスクは使用できません。
|
| k | 任意 | integer | なし | RRF 式の k 定数(1~)を指定してください。
デフォルトは 60 です。
|
| threshold | 任意 | double | なし | ランク融合結果から低スコアのコンテンツを除外する際の閾値を指定してください。
指定された閾値より低いスコアのコンテンツを切り捨てます。
未指定(null)の場合、スコアによる切り捨ては行いません。デフォルトは null です。
|
| limit | 任意 | integer | なし | ランク融合結果の上限件数(1~)を指定してください。指定された件数を超える下位(低スコア)のコンテンツを切り捨てます。
未指定(null)の場合、件数による切り捨ては行いません。デフォルトは null です。
|
5.2.1.20.18.2. 出力値¶
im_reciprocalRankFusion <object>
└─ contents <object[]>
├─ id <string>
├─ score <double>
├─ text <string>
├─ metadata <map>
└─ originSourceId <string>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_reciprocalRankFusion | object | なし | - |
| contents | object | リスト | ランク融合後のコンテンツの一覧 |
| id | string | なし | コンテンツの一意識別子 |
| score | double | なし | RRF 式で算出されたコンテンツのスコア |
| text | string | なし | コンテンツに埋め込まれたベクトル表現の生成元テキスト |
| metadata | map | なし | コンテンツに付与されたメタデータ |
| originSourceId | string | なし | コンテンツに埋め込まれたコンテンツの参照元となる情報源を識別するID
例:ファイル名、WebサイトのURLなど、登録時に指定したID
|
コラム
コンテンツはスコアの高い順にソートされた状態で返却されます。