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

    Interface BatchUpsertDocumentsResponse

    The outcome of a batched upsert.

    interface BatchUpsertDocumentsResponse {
        errors: BatchUpsertDocumentsError[];
        failedBatchCount: number;
        failedCount: number;
        failedItems: DocumentRecord[];
        successfulBatchCount: number;
        timedOut: boolean;
        totalBatchCount: number;
        totalCount: number;
        upsertedCount: number;
    }
    Index

    One entry per failed batch, ordered by batchIndex.

    failedBatchCount: number

    How many batches failed or were never sent.

    failedCount: number

    How many documents were in batches that failed or were never sent.

    failedItems: DocumentRecord[]

    Every document from every failed batch, flattened. Pass this straight back to a batched upsert to retry failed or unsent batches. Failed requests may already have applied.

    successfulBatchCount: number

    How many batches succeeded.

    timedOut: boolean

    Whether totalTimeout elapsed with batches still unsent.

    totalBatchCount: number

    How many batches the documents were chunked into.

    totalCount: number

    How many documents were passed in.

    upsertedCount: number

    How many documents Pinecone reported as upserted, summed across the batches that succeeded. This is the server's own count, so it can be lower than the number of documents those batches carried.