Upsert vectors

The upsert operation writes vectors into a namespace. If a new value is upserted for an existing vector ID, it will overwrite the previous value.

For guidance and examples, see Upsert data.

Authorizations

Api-Key

string

header

required

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

Body

application/json

The request for the upsert operation.

vectors

object[]

required

An array containing the vectors to upsert. Recommended batch limit is 100 vectors.

Show child attributes

vectors.id

string

required

This is the vector's unique id.

Required string length: 1 - 512

vectors.values

number[]

required

This is the vector data included in the request.

vectors.metadata

object

This is the metadata included in the request.

vectors.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

vectors.sparseValues.indices

integer[]

required

The indices of the sparse data.

vectors.sparseValues.values

number[]

required

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

namespace

string

This is the namespace name where you upsert vectors.

Response

200 - application/json

The response for the upsert operation.

upsertedCount

integer

The number of vectors upserted.