Interface CreateIndexServerlessSpec

Configuration needed to deploy a serverless index.

See

Understanding Serverless indexes

interface CreateIndexServerlessSpec {
    cloud: string;
    readCapacity?: CreateIndexReadCapacity;
    region: string;
    schema?: MetadataSchema;
    sourceCollection?: string;
}

Properties

cloud readCapacity? region schema? sourceCollection?

Properties

cloud

cloud: string

The public cloud where you would like your index hosted.

OptionalreadCapacity

readCapacity?: CreateIndexReadCapacity

The read capacity configuration for the index. Defaults to OnDemand if not provided.

region

region: string

The region where you would like your index to be created.

Optionalschema

schema?: MetadataSchema

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

OptionalsourceCollection

sourceCollection?: string

The name of the collection to be used as the source for the index. NOTE: Collections can only be created from pods-based indexes.

Settings

Member Visibility

On This Page

Properties