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

    Interface UpdateDocumentsOptions

    Set either documents or filter. A filter needs a non-empty set_fields or remove_fields.

    UpdateDocumentsRequest

    interface UpdateDocumentsOptions {
        documents?: UpdateDocumentRecord[];
        filter?: object;
        removeFields?: string[];
        setFields?: { [key: string]: DocumentFieldValue };
    }
    Index
    documents?: UpdateDocumentRecord[]

    The list of partial document updates to apply. At most 1000 updates, or 96 on an index whose schema declares embed or sparse_embed. Mutually exclusive with filter, and with a non-empty set_fields or remove_fields.

    maxItems states the general limit. A client that batches updates must size batches at 96 when any field of the index schema declares embed or sparse_embed.

    UpdateDocumentsRequest

    filter?: object

    A metadata filter expression selecting the documents to patch with set_fields and remove_fields. Must not be empty; an empty filter is rejected rather than matching every document. Text-match operators ($match_phrase, $match_all, $match_any) are not supported here, since documents are selected on metadata alone. Mutually exclusive with documents.

    UpdateDocumentsRequest

    removeFields?: string[]

    The names of the fields to remove from every document matching filter. Only metadata fields can be removed here; data fields are refused, as in set_fields. When non-empty, only valid together with filter; an empty list asks for no change and is ignored.

    UpdateDocumentsRequest

    setFields?: { [key: string]: DocumentFieldValue }

    The fields to set on every document matching filter, and the values to set them to. Only metadata fields can be set here; every data field is refused, that is, vector fields, full-text-searchable text and embedded text, not only fields that declare embed or sparse_embed. Update those per ID with documents. When non-empty, only valid together with filter; an empty object asks for no change and is ignored.

    UpdateDocumentsRequest