Pinecone TypeScript SDK - v8.1.0
    Preparing search index...

    Type Alias UpdateOptions<T>

    This type is very similar to PineconeRecord, but differs because the values field is optional here. This is to allow for situations where perhaps the caller only wants to update metadata for a given record while leaving stored vector values as they are.

    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

    A metadata filter expression. When provided, updates all vectors in the namespace that match the filter criteria. Must not be provided when using id. Either id or filter must be provided.

    Metadata filtering

    id?: RecordId

    The id of the record you would like to update

    metadata?: Partial<T>

    The metadata you would like to store with this record.

    namespace?: string

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

    sparseValues?: RecordSparseValues

    The sparse values you would like to store with this record.

    Understanding hybrid search

    values?: RecordValues

    The vector values you would like to store with this record

    Settings
    Member Visibility

    On This Page
    Properties