Skip to main content
New projects should use the Documents API. To move an existing index, see Move to the Documents API.
A legacy integrated index is created with create_index_for_model and served by the legacy Records API. Pinecone converts the source text you upsert and search with to vectors, using one hosted embedding model per index. To have Pinecone embed text in a document index instead, declare embed or sparse_embed on a string field. See Integrated embedding.
Legacy integrated indexes (created with create_index_for_model and served by the legacy Records API) don’t support updating or importing with text.

Dense embedding

If you want to upsert and search with source text and have Pinecone convert it to dense vectors automatically, create an index with integrated embedding as follows:
  • Provide a name for the index.
  • Set cloud and region to the cloud and region where the index should be deployed.
  • Set embed.model to one of Pinecone’s hosted embedding models.
  • Set embed.field_map to the name of the field in your source document that contains the data for embedding.
Other parameters are optional. See Create an index with integrated embedding for details.

Sparse embedding

If you want to upsert and search with source text and have Pinecone convert it to sparse vectors automatically, create an index with integrated embedding as follows:
  • Provide a name for the index.
  • Set cloud and region to the cloud and region where the index should be deployed.
  • Set embed.model to one of Pinecone’s hosted sparse embedding models.
  • Set embed.field_map to the name of the field in your source document that contains the text for embedding.
  • If needed, embed.read_parameters and embed.write_parameters can be used to override the default model embedding behavior.
Other parameters are optional. See Create an index with integrated embedding for details.

Wait for the index to be ready

A new index can’t accept data until its status.ready field is true. See Wait for the index to be ready.