RESTful

Upsert

This operation inserts new records into the database or updates existing ones.

POST

/v2/vectordb/entities/upsert

Cluster Endpoint

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"

Parameters

Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestring

The name of the database.

collectionNamestringrequired

The name of the collection in which to upsert data.

partitionNamestring

The name of a partition in the current collection. If specified, the data is to be inserted into the specified partition.

dataobject | arrayrequired

An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema

export TOKEN="root:Milvus"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/upsert" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "data": [
        {
            "id": 0,
            "vector": [
                0.3580376395471989,
                "Unknown type",
                0.18414012509913835,
                "Unknown type",
                0.9029438446296592
            ],
            "color": "pink_8682"
        },
        {
            "id": 1,
            "vector": [
                0.19886812562848388,
                0.06023560599112088,
                0.6976963061752597,
                0.2614474506242501,
                0.838729485096104
            ],
            "color": "red_7025"
        },
        {
            "id": 2,
            "vector": [
                0.43742130801983836,
                "Unknown type",
                0.6457887650909682,
                0.7894058910881185,
                0.20785793220625592
            ],
            "color": "orange_6781"
        },
        {
            "id": 3,
            "vector": [
                0.3172005263489739,
                0.9719044792798428,
                "Unknown type",
                "Unknown type",
                0.95791889146345
            ],
            "color": "pink_9298"
        },
        {
            "id": 4,
            "vector": [
                0.4452349528804562,
                "Unknown type",
                0.8220779437047674,
                0.46406290649483184,
                0.30337481143159106
            ],
            "color": "red_4794"
        },
        {
            "id": 5,
            "vector": [
                0.985825131989184,
                "Unknown type",
                0.6299267002202009,
                0.1206906911183383,
                "Unknown type"
            ],
            "color": "yellow_4222"
        },
        {
            "id": 6,
            "vector": [
                0.8371977790571115,
                "Unknown type",
                "Unknown type",
                "Unknown type",
                "Unknown type"
            ],
            "color": "red_9392"
        },
        {
            "id": 7,
            "vector": [
                "Unknown type",
                "Unknown type",
                0.8987539745369246,
                0.9402995886420709,
                0.5378064918413052
            ],
            "color": "grey_8510"
        },
        {
            "id": 8,
            "vector": [
                0.39524717779832685,
                0.4000257286739164,
                "Unknown type",
                "Unknown type",
                "Unknown type"
            ],
            "color": "white_9381"
        },
        {
            "id": 9,
            "vector": [
                0.5718280481994695,
                0.24070317428066512,
                "Unknown type",
                "Unknown type",
                "Unknown type"
            ],
            "color": "purple_4976"
        }
    ],
    "collectionName": "quick_setup"
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

Response payload which carries the result of the upsert operation.

upsertCountinteger

The number of upserted entities.

Example Value: 4

upsertIdsarray

An array of the IDs of upserted entities.

[]upsertIdsstring

The ID of an upserted entity.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "upsertCount": 10,
        "upsertIds": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ]
    }
}