Skip to content
MilvusNode SDK
Sections

Add function (legacy)

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. Run List collections to populate the collection selector. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/collections/add_function

{
  "dbName": "default",
  "collectionName": "books",
  "function": {
    "name": "title_bm25",
    "type": "BM25",
    "inputFieldNames": [
      "title"
    ],
    "outputFieldNames": [
      "title_sparse"
    ]
  }
}

Example response

{
  "code": 1100,
  "message": "AddCollectionFunction RPC is no longer supported; add BM25/MinHash via add_function_field, and define a TextEmbedding function at collection creation: invalid parameter"
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/collections/add_function' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books",
  "function": {
    "name": "title_bm25",
    "type": "BM25",
    "inputFieldNames": [
      "title"
    ],
    "outputFieldNames": [
      "title_sparse"
    ]
  }
}'

Milvus 3.0.6 rejects this legacy route. Use add_function_field for BM25 or MinHash, or define a text embedding function when creating a collection.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
collectionName string (required)
Name of the collection.
function object (required)
Function definition with name, type, inputFieldNames and outputFieldNames.

For new SDK code, use HttpClient.addFunctionField to manage the function together with its output field and index.