メインコンテンツまでスキップ

add_collection_function()

この操作は collection に新しい function を追加します。Function を使用すると、BM25 スコアリングや埋め込み生成などのカスタム処理ロジックを定義できます。

📘注意

これは external collection には適用されません。

リクエスト構文​

python
client.add_collection_function(
    collection_name: str,
    function: Function,
    timeout: float = None,
    **kwargs
)

パラメータ:

  • collection_name (str) -

    [REQUIRED]

    collection の名前。

  • function (Function) -

    [REQUIRED]

    追加する function スキーマ。これは、function 名、型、入力フィールド、出力フィールド、およびパラメータを定義する Function オブジェクトです。

  • timeout (float | None) -

    この操作のタイムアウト時間。これを None に設定すると、レスポンスが到着した時点、またはエラーが発生した時点でこの操作はタイムアウトします。

  • kwargs (dict) -

    追加のオプションパラメータ。

戻り値の型:

NoneType

例外:

  • MilvusException

    この操作中に何らかのエラーが発生した場合、この例外が発生します。

例​

python
from pymilvus import MilvusClient, Function, FunctionType

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

bm25_function = Function(
    name="bm25",
    function_type=FunctionType.BM25,
    input_field_names=["text"],
    output_field_names=["sparse_vector"],
)

client.add_collection_function(
    collection_name="my_collection",
    function=bm25_function,
)
Ctrl I