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

    Interface BatchUpsertDocumentsOptions

    Options for a batched document upsert.

    Controls request size, concurrency, and how failures are collected.

    interface BatchUpsertDocumentsOptions {
        batchSize?: number;
        documents: DocumentRecord[];
        maxConcurrency?: number;
        onError?: BatchUpsertErrorMode;
        totalTimeout?: number;
    }
    Index
    batchSize?: number

    Documents per request, 1–1000. Defaults to 50. Keep it at 96 or below for an index with integrated embedding (a string field that declares embed or sparseEmbed), which rejects larger requests.

    documents: DocumentRecord[]

    The documents to upsert. An empty array resolves with zero counts and sends nothing.

    maxConcurrency?: number

    Requests in flight at once, 1–64. Defaults to 8.

    What to do when a batch fails. Defaults to collect.

    totalTimeout?: number

    Deadline in milliseconds for the whole call. Once it elapses no further batches are sent; batches already in flight are awaited rather than cancelled, because dropping a request client-side does not stop Pinecone from applying it. Defaults to no deadline.