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

    Interface CreateIndexForModelOptions

    Options for creating a legacy integrated index with Indexes.createForModel.

    The embed settings select the model and document field to embed for you. For full control over schema composition — integrated embedding on string fields, or a dense or sparse vector field combined with full-text search, for example — use Indexes.create directly.

    interface CreateIndexForModelOptions {
        cloud: string;
        deletionProtection?: DeletionProtection;
        embed: CreateIndexForModelEmbed;
        name: string;
        readCapacity?: ReadCapacity | CreateIndexReadCapacity;
        region: string;
        schema?: MetadataSchema;
        suppressConflicts?: boolean;
        tags?: { [key: string]: string } | null;
        timeout?: number;
        waitUntilReady?: boolean;
    }

    Hierarchy

    • Omit<
          CreateIndexForModelRequest,
          "name"
          | "readCapacity"
          | "deletionProtection"
          | "embed",
      >
      • CreateIndexForModelOptions
    Index
    cloud: string

    The public cloud to host the index on: aws, gcp, or azure.

    deletionProtection?: DeletionProtection

    Whether to enable deletion protection. Defaults to disabled.

    The embedding model and the document field it reads.

    name: string

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

    The native nested or deprecated flat read capacity configuration for the index. Omit for on-demand capacity.

    region: string

    The cloud region to create the index in, for example us-east-1.

    schema?: MetadataSchema

    CreateIndexForModelRequest

    suppressConflicts?: boolean

    When true, returns undefined instead of throwing if an index with this name already exists. Otherwise creation always returns an index model, regardless of waitUntilReady.

    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.

    CreateIndexForModelRequest

    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.