Creates an Index.

Indexes are created with unique IDs like idx_rHlXLhCTma74w1E_xbRXl. These IDs are unique and cannot be changed. In a future release we will be adding the ability to alias Indexes, supporting names.

This is an asynchronous operation.

Index configuration

Index types

Indexes have and index type that determines how the data inserted is processesed.

We currently support 3 Index types:

  • text - semantically search text content using state of the art text embeddings for search
  • image - semantically search images with text using image embeddings for search
  • multimodal - semantically search text content AND images with text using multimodal embeddings for search

Object fields

Indexes support configuring how fields in Objects that are indexed are processed. The following configurations are supported at a field level:

  1. Crawlable - fields which will be crawled and made available for search. Read more about crawling.
  2. Searchable - fields which will contribute to search relevance.
  3. Filterable - fields which may be filtered upon. Read more about filtering.
  4. Types - A mapping of fields to data types for filterable fields. By default all filterable fields are considered strings, unless specified here. For more info on supported types see field types.

Finetuning

Indexes can learn from your feedback, training your index to retrieve more relevant results that better match your unique business needs. To configure finetuning set your base index using base_index_id and provide feedback in the form of query, object_id, and label. Check out the Quickstart guide to get started.

Acceptable labels are:

  • GREAT: For objects that you want to encourage retrieving for the specified query.
  • OK: For objects that have a loose connection to the query but you do not want to reward.
  • BAD: For objects that you want to discourage retrieving for the specified query.

Constraints:

  • You must include at least 50 queries
  • Each query must have at least one object with a “GREAT” label and one object with a “BAD” label.

View API Reference

See how to programmatically create an Index.