Skip to content
MilvusNode SDK
Sections

Add function and field

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_field

{
  "dbName": "default",
  "collectionName": "books",
  "function": {
    "name": "title_bm25",
    "type": "BM25",
    "inputFieldNames": [
      "title"
    ],
    "outputFieldNames": [
      "title_sparse"
    ]
  },
  "outputField": {
    "fieldName": "title_sparse",
    "dataType": "SparseFloatVector"
  },
  "indexParams": {
    "fieldName": "title_sparse",
    "indexType": "SPARSE_INVERTED_INDEX",
    "metricType": "BM25"
  }
}

Example response

{
  "code": 0,
  "data": {}
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/collections/add_function_field' \
  --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"
    ]
  },
  "outputField": {
    "fieldName": "title_sparse",
    "dataType": "SparseFloatVector"
  },
  "indexParams": {
    "fieldName": "title_sparse",
    "indexType": "SPARSE_INVERTED_INDEX",
    "metricType": "BM25"
  }
}'

Add a function with its output field and optional index configuration. The input field must already exist and have its analyzer enabled for BM25.

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.
outputField object (required)
Schema of the field created for the function output.
indexParams object
Index definition for the new output field.

See HttpClient.addFunctionField for the Node.js SDK method.