Skip to content
MilvusNode SDK
Sections

Alter function

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/alter_function

{
  "dbName": "default",
  "collectionName": "books_with_embeddings",
  "functionName": "title_embedding",
  "function": {
    "name": "title_embedding",
    "description": "Book title embeddings",
    "type": "TextEmbedding",
    "inputFieldNames": [
      "title"
    ],
    "outputFieldNames": [
      "title_dense"
    ],
    "params": {
      "provider": "openai",
      "model_name": "text-embedding-3-small"
    }
  }
}

Example response

{
  "code": 0,
  "data": {}
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/collections/alter_function' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books_with_embeddings",
  "functionName": "title_embedding",
  "function": {
    "name": "title_embedding",
    "description": "Book title embeddings",
    "type": "TextEmbedding",
    "inputFieldNames": [
      "title"
    ],
    "outputFieldNames": [
      "title_dense"
    ],
    "params": {
      "provider": "openai",
      "model_name": "text-embedding-3-small"
    }
  }
}'

Update a supported function, such as an existing text embedding function. Milvus 3.0.6 rejects alterations to BM25 functions.

Request fields

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

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