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

    Interface ConfigureIndexRequest

    Configuration updates to apply to an existing index. All fields are optional; only the fields you include are modified.

    • deployment: Update pod-based scaling parameters (replicas, pod_type). Deployment type and cloud/region cannot be changed.
    • schema: Update semantic_text field embedding parameters, on a legacy integrated index created via create-for-model. Only write_parameters and read_parameters may be changed; the model cannot be changed after creation.
    • read_capacity: Update read capacity mode or dedicated node configuration for managed and BYOC indexes. Not applicable to pod-based indexes.
    • tags: Update or delete index tags. Setting a tag value to "" removes the tag.
    • deletion_protection: Enable or disable deletion protection.

    ConfigureIndexRequest

    interface ConfigureIndexRequest {
        deletionProtection?: string;
        deployment?: PatchIndexDeploymentRequest;
        readCapacity?: ReadCapacityPatch;
        schema?: PatchIndexSchema;
        tags?: { [key: string]: string } | null;
    }
    Index
    deletionProtection? deployment? readCapacity? schema? tags?
    deletionProtection?: string

    Whether deletion protection is enabled/disabled for the index.

    Possible values: disabled or enabled.

    ConfigureIndexRequest

    deployment?: PatchIndexDeploymentRequest

    ConfigureIndexRequest

    readCapacity?: ReadCapacityPatch

    ConfigureIndexRequest

    schema?: PatchIndexSchema

    ConfigureIndexRequest

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

    Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.

    ConfigureIndexRequest

    Settings
    Member Visibility

    On This Page
    Properties