跳到主要内容

add_collection_function()

此操作会向 Collection 添加一个新函数。函数允许您定义自定义处理逻辑,例如 BM25 评分或嵌入生成。

Notes

这不适用于外部 Collection。

请求语法​

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

参数:

  • collection_name (str) -

    [必需]

    Collection 的名称。

  • function (Function) -

    [必需]

    要添加的函数 Schema。这是一个 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,
)
最低 SDK 版本v2.6.x