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

    Interface CreateIndexPodSpec

    Configuration needed to deploy a serverless index.

    Understanding Pod-based indexes

    interface CreateIndexPodSpec {
        environment: string;
        metadataConfig?: PodSpecMetadataConfig;
        pods?: number;
        podType: string;
        replicas?: number;
        shards?: number;
        sourceCollection?: string;
    }
    Index
    environment metadataConfig? pods? podType replicas? shards? sourceCollection?
    environment: string

    The environment where the index is hosted.

    metadataConfig?: PodSpecMetadataConfig

    Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadataConfig is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

    pods?: number

    The number of pods to be used in the index. This should be equal to shards x replicas.'

    podType: string

    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

    replicas?: number

    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

    shards?: number

    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

    sourceCollection?: string

    The name of the collection to be used as the source for the index.

    Settings
    Member Visibility

    On This Page
    Properties