AnalyticDB:Nova BM25 関数 API リファレンス

bm25.match

全文マッチング関数です。クエリテキストをトークン化し、対象フィールドからこれらのトークンを含むドキュメントを検索した後、BM25 アルゴリズムを使用して関連度スコアを計算します。

パラメーター：

例：

WHERE body @@@ bm25.match('database search ranking')
WHERE body @@@ bm25.match('database search', operator => 'and')

使用上の注意：

• operator => 'and' を使用すると、マッチングの精度が向上し、クエリテキスト内のすべてのキーワードに一致する必要のあるシナリオに適しています。

• デフォルトの operator => 'or' モードは、より多くのドキュメントに一致し、再現率を優先するシナリオに適しています。

bm25.multi_match

複数フィールド全文マッチング関数です。複数のフィールドにまたがって同時に全文検索を実行し、キャレット (^) 記号を使用して各フィールドに異なる関連度の重みを割り当てることができます。

パラメーター：

例：

WHERE body @@@ bm25.multi_match(
    ARRAY['title^5', 'body^2'],
    query => 'full-text search',
    operator => 'or'
)

使用上の注意：

• 重み値が高いほど、そのフィールドのマッチングが最終スコアに与える影響が大きくなります。重みを指定しない場合、デフォルト値は 1 です。

bm25.phrase

フレーズマッチング関数です。トークン化されたクエリテキストのすべてのトークンが、間に他のトークンを挟むことなく、元の順序で連続して出現する必要があります。

パラメーター：

例：

WHERE body @@@ bm25.phrase('full-text search')

使用上の注意：

• フレーズマッチングは全文マッチングよりも厳密であり、トークンの正確な順序が要求されるシナリオに適しています。

bm25.phrase_prefix

フレーズプレフィックスマッチング関数です。トークン化されたクエリテキストのトークンが順序どおりに出現し、かつ最後のトークンがプレフィックスとして一致する必要があります。

パラメーター：

例：

WHERE body @@@ bm25.phrase_prefix(ARRAY['post'])

使用上の注意：

• オートコンプリートや部分入力マッチングのシナリオに適しています。たとえば、ユーザーが部分的なキーワードを入力したときに候補結果を返す場合などです。

bm25.fuzzy_term

あいまいタームマッチング関数です。レーベンシュタイン距離に基づき、クエリトークンがインデックス化されたトークンと、指定された文字編集数まで異なることを許容します。スペル訂正のシナリオに適しています。

パラメーター：

例：

WHERE body @@@ bm25.fuzzy_term('keybord', distance => 1)

使用上の注意：

• この例では、'keybord' は 'keyboard' との編集距離が 1 (a の欠落) であるため、'keyboard' を含むドキュメントに一致できます。

• distance 値は 2 以下に保つことを推奨します。編集距離が大きいと、マッチングが広範になりすぎ、パフォーマンスが低下します。

bm25.regex と bm25.regex_phrase

正規表現マッチング関数です。bm25.regex は単一のトークンに対して正規表現マッチングを実行します。bm25.regex_phrase はフレーズレベルで正規表現マッチングを実行するもので、複数のトークンが順序どおりに出現し、各トークンが対応する正規表現パターンを満たす必要があります。

パラメーター：

例：

WHERE body @@@ bm25.regex('post.*')

使用上の注意：

• 正規表現マッチングは、元のドキュメントテキストではなく、インデックス内のトークンに対して動作します。トークン化された形式に基づいて正規表現を記述してください。

• 複雑な正規表現は、大きなパフォーマンスのオーバーヘッドを引き起こす可能性があります。必要な場合のみ使用してください。

bm25.span_near

高度な近接マッチング関数です。指定された複数のトークンがドキュメント内で互いに近接して出現する必要があり、トークン間の最大許容ギャップを制御できます。

パラメーター：

例：

WHERE body @@@ bm25.span_near(
    ARRAY[bm25.span_term('postgresql'), bm25.span_term('bm25')],
    2
)

使用上の注意：

• この例では、トークン 'postgresql' と 'bm25' の間に最大 2 個のトークンが介在することを許容します。

• これは高度な機能であり、トークンの位置関係を正確に制御する必要のある複雑な検索シナリオに適しています。

bm25.term

完全一致値のマッチングを行う関数です。形態素解析を行わずに、フィールド値が指定された値と完全に一致するドキュメントを検索します。

パラメーター：

例：

WHERE tag @@@ bm25.term('search')
WHERE rating @@@ bm25.term(5)

使用上の注意：

• 文字列型のフィールドの場合、マッチングは大文字と小文字を区別します。

bm25.term_set

複数値の完全一致マッチングを行う関数です。フィールド値が指定されたセット内のいずれかの値と完全に一致するドキュメントを検索します。

パラメーター：

例：

WHERE tag @@@ bm25.term_set(ARRAY['database', 'search'])

使用上の注意：

• これは、複数の値に対して OR 完全一致を実行することと同等であり、複数の bm25.term クエリを組み合わせるよりも簡潔で効率的です。

bm25.range

範囲のマッチングを行う関数です。フィールド値が指定された範囲内にあるドキュメントを検索します。PostgreSQL 範囲型構文をサポートします。

パラメーター：

例：

WHERE rating @@@ bm25.range('[4,)'::int4range)

使用上の注意：

• 上記の例では、rating が 4 以上のすべてのドキュメントが一致します。

• 範囲型はフィールドのデータ型と一致する必要があります。一般的な範囲型には、int4range (整数)、numrange (数値)、tsrange (タイムスタンプ) があります。

bm25.exists

フィールドの存在をチェックする関数です。指定されたフィールドに非 NULL 値が含まれるドキュメントを検索します。

パラメーター：

この関数にはパラメーターは必要ありません。

例：

WHERE rating @@@ bm25.exists()

使用上の注意：

• この関数は、特定の値に関係なく、フィールドに値が含まれているかどうかだけをチェックします。特定のフィールド を持たないドキュメントを除外する場合に適しています。

bm25.boolean

ブール複合クエリ関数は、複数のサブクエリを must (一致必須)、should (一致推奨、スコアに影響)、および must_not (不一致必須) の 3 つのディメンションで結合する関数です。

パラメーター：

例：

WHERE body @@@ bm25.boolean(
    must => ARRAY[bm25.match('body', query => 'database', operator => 'and')],
    should => ARRAY[bm25.match('title', query => 'database')],
    must_not => ARRAY[bm25.term('category', 'deleted')]
)

使用上の注意：

• 3 つのパラメーターのうち少なくとも 1 つを指定する必要があります。

• 各配列要素には任意の bm25.* クエリ関数を指定でき、ネストもサポートされています。

bm25.boost

スコアの重み付け関数です。指定したサブクエリの関連性スコアに固定の factor を乗算し、最終スコアにおける特定条件の影響を増減させます。

パラメーター：

例：

bm25.boost(5.0, bm25.match('title', query => 'full-text search', operator => 'and'))

使用上の注意：

• この例では、title フィールドの一致スコアを 5 倍に増幅し、結果で title が一致したドキュメントをより上位にランク付けします。

bm25.const_score

定数スコア関数です。指定したサブクエリの関連性スコアを固定値に置き換え、一致したすべてのドキュメントに同一のスコアを付与します。

パラメーター：

例：

WHERE body @@@ bm25.const_score(1.0, bm25.match('body', query => 'database', operator => 'and'))

使用上の注意：

• 関連性に基づくランキングが不要でフィルタリングのみを行うシナリオ、または一致したすべてのドキュメントに同一の重みを付与する必要がある複合クエリに適しています。

bm25.disjunction_max

最適選択クエリ関数。複数のサブクエリから最も高いスコアを最終スコアとして選択し、オプションで tie_breaker パラメーターによって他の一致するサブクエリのスコアに追加の重みを適用します。

パラメーター：

例：

WHERE description @@@ bm25.disjunction_max(
    disjuncts => ARRAY[
        bm25.boost(3.0, bm25.match('title', query => 'wireless headphones', operator => 'and')),
        bm25.match('description', query => 'wireless headphones', operator => 'and')
    ],
    tie_breaker => 0.2
)

使用上の注意：

• この例では、title と description の両方が一致した場合、最終スコアは重み付けされた title のスコアに description のスコアの 0.2 倍を加算した値になります。

• 最も一致したフィールドがスコアを支配しつつ、他のフィールドからの寄与も考慮する必要がある複数フィールド検索のシナリオに適しています。