alter_collection_function()
Addedv2.6.x
This operation alters an existing function in the collection by replacing it with a new function schema.
📘Notes
This does not apply to external collections.
Request syntax
client.alter_collection_function(
collection_name: str,
function_name: str,
function: Function,
timeout: float = None,
**kwargs
)
PARAMETERS:
-
collection_name (str) -
[REQUIRED]
The name of the collection.
-
function_name (str) -
[REQUIRED]
The name of the function to modify.
-
[REQUIRED]
The new function schema to replace the existing one.
-
timeout (float | None) -
The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
-
kwargs (dict) -
Optional additional parameters.
RETURN TYPE:
NoneType
EXCEPTIONS:
-
MilvusException
This exception will be raised when any error occurs during this operation.
Example
from pymilvus import MilvusClient, Function, FunctionType
client = MilvusClient(
uri="YOUR_CLUSTER_ENDPOINT",
token="YOUR_CLUSTER_TOKEN"
)
updated_function = Function(
name="bm25",
function_type=FunctionType.BM25,
input_field_names=["text"],
output_field_names=["sparse_vector"],
params={"bm25_k1": 1.5, "bm25_b": 0.75},
)
client.alter_collection_function(
collection_name="my_collection",
function_name="bm25",
function=updated_function,
)