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

    Interface CreateSparseEmbedConfig

    Learned-sparse embedding configuration for a string field. Pinecone embeds the field's text with a hosted sparse embedding model when documents are upserted or updated, and embeds the query text with the same model when a search scores the field with a sparse_embed scoring method.

    Every key is optional; {} selects the default model. Sparse embeddings have no dimension or metric, and dimension or metric is rejected here. The resolved configuration is returned when the index is described. The configuration is fixed at creation and cannot be changed afterwards.

    A sparse_embed field occupies the index's single sparse vector slot, so it cannot be combined with a sparse_vector field or with sparse_embed on another field.

    CreateSparseEmbedConfig

    interface CreateSparseEmbedConfig {
        model?: string;
        readParameters?: object;
        writeParameters?: object;
    }
    Index
    model?: string

    The name of a hosted sparse embedding model. Defaults to pinecone-sparse-english-v0. A dense model is rejected; declare it under embed instead.

    Refer to the model guide for available models.

    CreateSparseEmbedConfig

    readParameters?: object

    Model-specific parameters applied when embedding search query text, such as truncate. Validated against the model; omitted parameters take the model's defaults. The resolved parameters are returned when the index is described.

    CreateSparseEmbedConfig

    writeParameters?: object

    Model-specific parameters applied when embedding document text, such as truncate. Validated against the model; omitted parameters take the model's defaults. The resolved parameters are returned when the index is described.

    CreateSparseEmbedConfig