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

    Type Alias CreateIndexForModelOptions

    Options for creating an index for a specific model.

    Create or configure an index

    type CreateIndexForModelOptions = {
        cloud: string;
        deletionProtection?: string;
        embed: CreateIndexForModelEmbed;
        name: string;
        readCapacity?: CreateIndexReadCapacity;
        region: string;
        schema?: MetadataSchema;
        suppressConflicts?: boolean;
        tags?: { [key: string]: string };
        timeout?: number;
        waitUntilReady?: boolean;
    }
    Index
    cloud deletionProtection? embed name readCapacity? region schema? suppressConflicts? tags? timeout? waitUntilReady?
    cloud: string

    The public cloud where you would like your index hosted.

    deletionProtection?: string

    Allows configuring an index to be protected from deletion. Defaults to disabled.

    embed: CreateIndexForModelEmbed

    The CreateIndexForModelEmbed object used to configure the integrated inference embedding model.

    name: string

    The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

    readCapacity?: CreateIndexReadCapacity

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

    region: string

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

    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.

    suppressConflicts?: boolean

    This option tells the client not to throw if you attempt to create an index that already exists.

    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.

    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

    This option tells the client not to resolve the returned promise until the index is ready to receive data.

    Settings
    Member Visibility

    On This Page
    Properties