Update data

This page shows you how to use the update operation to update parts of existing records in dense or sparse indexes. To update entire records, use the upsert operation instead.

​

Update dense vector values

To update the dense vector value of a record in a dense index, specify the namespace, record id, and the new dense vector values. The new dense vector values must have the same length as the existing dense vector values.

In this example, assume you want to update the dense vector values of the following record in the example-namespace namespace:

(
	id="id-3", 
	values=[1.0, 2.0], 
    metadata={"type": "doc", "genre": "drama"}
)

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/data/target-an-index
index = pc.Index(host="INDEX_HOST")

index.update(id="id-3", values=[4.0, 2.0], namespace="example-namespace")

After the update, the dense vector values are changed, but the metadata is unchanged:

(
	id="id-3", 
	values=[4.0, 2.0],
    metadata={"type": "doc", "genre": "drama"} 
)

​

Update sparse vector values

To update the sparse vector value of a record in a sparse index, specify the namespace, record id, and the new sparse_values.

In this example, assume you are updating the sparse vector values of the following record in the example-namespace namespace:

(
	id="id-3", 
	sparse_values={"indices": [1, 5], "values": [0.5, 0.5]}
)

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/data/target-an-index
index = pc.Index(host="INDEX_HOST")

index.update(
	id="id-3", 
	sparse_values={"indices": [2, 6], "values": [0.5, 0.5]},
	namespace="example-namespace"
)

After the update, the sparse value indices array is changed, but the rest of the record is unchanged:

(
	id="id-3", 
	sparse_values={"indices": [2, 6], "values": [0.5, 0.5]}
)

​

Update metadata values

When updating metadata, only the specified metadata fields are modified, and if a specified metadata file does not exist, it is added.

In this example, assume you are updating the metadata values of following record in the example-namespace namespace:

(
    id="id-3", 
    values=[4.0, 2.0], 
    metadata={"type": "doc", "genre": "drama"}
)

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/data/target-an-index
index = pc.Index(host="INDEX_HOST")

index.update(
	id="id-3", 
	set_metadata={"type": "web", "new": True}, 
	namespace="example-namespace"
)

After the update, the type metadata field is web, the new property is added with the value true, and the genre property is unchanged:

(
    id="id-3", 
    values=[4.0, 2.0], 
    metadata={"type": "web", "new": true, "genre": "drama"}
)

​

Update a combination of values

In this example, assume you are updating the dense vector values and one metadata value of the following record in the example-namespace namespace:

(
    id="id-3", 
    values=[4.0, 2.0], 
    metadata={"type": "doc", "genre": "drama"}
)

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

# To get the unique host for an index, 
# see https://docs.pinecone.io/guides/data/target-an-index
index = pc.Index(host="INDEX_HOST")

index.update(
	id="id-3", 
	values=[5.0, 3.0], 
	set_metadata={"genre": "comedy"},
	namespace="example-namespace"
)

After the update, the dense vector values and the genre metadata value are changed, but the type metadata value is unchanged:

(
    id="id-3", 
    values=[5.0, 2.0], 
    metadata={"type": "doc", "genre": "comedy"}
)

​

Data freshness

Pinecone is eventually consistent, so there can be a slight delay before new or changed records are visible to queries. You can view index stats to check data freshness.