Update a vector

The update operation updates a vector in a namespace. If a value is included, it will overwrite the previous value. If a set_metadata is included, the values of the fields specified in it will be added or overwrite the previous value.

For guidance and examples, see Update data.

cURL

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"

curl -X POST "https://$INDEX_HOST/vectors/update" \
	-H "Api-Key: $PINECONE_API_KEY" \
	-H 'Content-Type: application/json' \
	-d '{
		  "id": "id-3",
		  "values": [
		    4.0,
			2.0
		  ],
		  "namespace": "ns1"
		}'

Authorizations

Api-Key

string

header

required

An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.

Body

application/json

The request for the upsert operation.

id

string

required

Vector's unique id.

Required string length: 1 - 512

Example:

"example-vector-1"

values

number[]

Vector data.

Example:

[0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8]

sparseValues

object

Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be with the same length.

Show child attributes

sparseValues.indices

integer[]

required

The indices of the sparse data.

Example:

[1, 312, 822, 14, 980]

sparseValues.values

number[]

required

The corresponding values of the sparse data, which must be with the same length as the indices.

Example:

[0.1, 0.2, 0.3, 0.4, 0.5]

setMetadata

object

Metadata to set for the vector.

Example:

{ "genre": "documentary", "year": 2019 }

namespace

string

Namespace name where to update the vector.

Example:

"example-namespace"

Response

200

application/json

A successful response.

The response for the update operation.