Upsert

Used to add new vectors or update an existing vector.

You can only upsert vectors with same dimension count(size) as your index.

Arguments

Payload

Vector | Vector[]

required

Hide child attributes

id

string | number

required

The ID of the vector

vector

number[]

required

The embedding data

metadata

Record<string, unknown>

The metadata of the vector. This is used to make it easier to identify the vector on queries.

Response

'Success' on successful operation.

Single

await index.upsert({
  id: "1234",
  vector: [0.1, 0.2, 0.3, 0.4, 0.5],
  metadata: {
    title: "Lord of The Rings",
    genre: "drama",
    category: "classic",
  },
});