Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Type Alias UpdateOptions<T>

    Partial changes for Index.update. Select one record by id, or use a metadata filter to update metadata on matching records. Unspecified fields are preserved.

    type UpdateOptions<T extends RecordMetadata = RecordMetadata> = {
        filter?: object;
        id?: RecordId;
        metadata?: Partial<T>;
        namespace?: string;
        sparseValues?: RecordSparseValues;
        values?: RecordValues;
    }

    Type Parameters

    Index
    filter? id? metadata? namespace? sparseValues? values?
    filter?: object

    Select records whose metadata should change. Mutually exclusive with id; provide the changes in metadata.

    Metadata filtering

    id?: RecordId

    The record ID, such as trail-shoe-42; mutually exclusive with filter.

    metadata?: Partial<T>

    Metadata fields to add or replace. Other stored metadata fields are preserved.

    namespace?: string

    The namespace to update in. If not specified, uses the namespace configured on the Index.

    sparseValues?: RecordSparseValues

    Replacement sparse vector values for an update by ID.

    values?: RecordValues

    Replacement dense vector values for an update by ID.

    Settings
    Member Visibility

    On This Page
    Properties