Type Alias UpdateOptions<T>

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

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 Parameters

Type declaration

  • Optionalfilter?: 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.

    See

    Metadata filtering

  • Optionalid?: RecordId

    The id of the record you would like to update

  • Optionalmetadata?: Partial<T>

    The metadata you would like to store with this record.

  • Optionalnamespace?: string

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

  • OptionalsparseValues?: RecordSparseValues

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

    See

    Understanding hybrid search

  • Optionalvalues?: RecordValues

    The vector values you would like to store with this record

Settings

Member Visibility