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

    Interface ReadCapacityStatus

    The current status of factors affecting the read capacity of a serverless index

    ReadCapacityStatus

    interface ReadCapacityStatus {
        currentReplicas?: number;
        currentShards?: number;
        errorMessage?: string;
        state: string;
    }
    Index
    currentReplicas?: number

    The number of replicas. Each replica has dedicated compute resources and data storage. Increasing this number will increase the total throughput of the index.

    ReadCapacityStatus

    currentShards?: number

    The number of shards. Each shard has dedicated storage. Increasing shards alleiviates index fullness.

    ReadCapacityStatus

    errorMessage?: string

    An optional error message indicating any issues with your read capacity configuration

    ReadCapacityStatus

    state: string

    The state describes the overall status of factors relating to the read capacity of an index.

    Available values:

    • Ready is the state most of the time
    • Scaling if the number of replicas or shards has been recently updated by calling the configure index endpoint
    • Migrating if the index is being migrated to a new node_type
    • Error if there is an error with the read capacity configuration. In that case, see error_message for more details.

    ReadCapacityStatus