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

    Interface PreviewCreateIndexOptionsAlpha

    Options for creating a schema-based index using the 2026-01.alpha API.

    interface PreviewCreateIndexOptions {
        cmekId?: string;
        deletionProtection?: string;
        deployment?: PreviewIndexDeploymentRequest;
        name: string;
        readCapacity?: PreviewReadCapacity;
        schema: PreviewCreateIndexSchema;
        sourceBackupId?: string;
        sourceCollection?: string;
        tags?: { [key: string]: string };
        timeout?: number;
        waitUntilReady?: boolean;
    }

    Hierarchy

    • Omit<CreateIndexRequest, "name">
      • PreviewCreateIndexOptions
    Index
    cmekId? deletionProtection? deployment? name readCapacity? schema sourceBackupId? sourceCollection? tags? timeout? waitUntilReady?
    cmekId?: string

    The ID of a customer-managed encryption key (CMEK) to use for this index. Requires CMEK to be enabled for your organization.

    CreateIndexRequest

    deletionProtection?: string

    Whether deletion protection is enabled/disabled for the index. Possible values: disabled or enabled.

    CreateIndexRequest

    deployment?: PreviewIndexDeploymentRequest

    CreateIndexRequest

    name: string

    The name of the index to create. Must be unique within the project.

    readCapacity?: PreviewReadCapacity

    CreateIndexRequest

    schema: PreviewCreateIndexSchema

    CreateIndexRequest

    sourceBackupId?: string

    The ID of a backup from which to restore the index. Mutually exclusive with source_collection.

    CreateIndexRequest

    sourceCollection?: string

    The name of a collection from which to create the index. The collection must have been created from a pod-based index with a compatible schema.

    CreateIndexRequest

    tags?: { [key: string]: string }

    Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

    CreateIndexRequest

    timeout?: number

    Maximum time in milliseconds to wait for the index to become ready when waitUntilReady is true. Omit to poll indefinitely. Throws Errors.PineconeTimeoutError if the deadline is exceeded.

    waitUntilReady?: boolean

    When true, polls until the index is ready before returning.

    Settings
    Member Visibility

    On This Page
    Properties