Indexes

An index is a collection of documents that you search together. Most apps have one index per kind of thing people look for: products, articles, customers. Each index has its own documents, its own settings and its own search endpoint.

Creating an index

You do not have to create an index before using it. The first time you add documents to a name that does not exist, ZeroIndex creates the index for you with the default settings. Create one explicitly when you want to choose the primary key or apply settings before any documents arrive.

curl https://api.zeroindex.test/v1/indexes \
  -H "Authorization: Bearer $ZEROINDEX_KEY" \
  -d '{ "uid": "products", "primaryKey": "id" }'

await client.createIndex("products", { primaryKey: "id" });

client.create_index("products", primary_key="id")

Settings

Settings control what is searchable, what can be filtered and how results are ranked. They apply to the whole index, and changing them rebuilds it in the background.

await client.index("products").updateSettings({
  searchableAttributes: ["name", "brand", "description"],
  filterableAttributes: ["category", "price", "in_stock"],
  sortableAttributes: ["price", "created_at"],
});

Limits

Next steps