> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/search-cockpit/indexes.md).
# Indexes
Create and manage search indexes for custom schema types, follow build jobs, and export or import index configuration.
The **Indexes** view lists search indexes for custom schema types. An index defines which fields on instances of a type are searchable and how each field is stored. Creating or changing the field list runs as a job. When the job succeeds, the index status is **Ready** and you can use the index in [Search](/search-cockpit/search.md).
## Browse and filter indexes
Open **Indexes** from the side menu. Filter the list by **Schema type**, **Filter by id**, **Filter by name**, and status. Schema type can be **ALL** to show every type, or one concrete type.
An index can have one of the following statuses:
* **Ready** – the index is available for search.
* **Building** – a create or update job is still running.
* **Failed** – the last job did not succeed.
Search indexes list
## Create an index
{% stepper %}
{% step %}
#### Open the create form
On **Indexes**, select **Create index**. If the list is already filtered to one schema type, that type is selected on the form. If the list shows **ALL**, choose **Schema type** on the create screen.
{% endstep %}
{% step %}
#### Enter index details
Provide **Index id**, **Name**, and an optional **Description**. The index id must use 1 to 66 letters, digits, underscores, or hyphens.
{% endstep %}
{% step %}
#### Add fields
Use **Ask assistant** to build the field list. Describe what the index should cover, and the assistant adds the relevant fields and options (**Text**, **Exact**, **Autocomplete**) for that schema type. Review the result, edit it if needed, then continue.
{% hint style="info" %}
The search index assistant is an AI agent that Support enables in the Agentic AI view when they set up the Search Cockpit.
{% endhint %}
Using search index assistant
You can also select **Add field** and choose each schema field yourself. For each field, set the options the field type allows:
* **Text** – match free text, phrase, wildcard, or contains filters.
* **Exact** – filter by equality, range, list, or existence, and support sorting. Number, Boolean, and date fields support only **Exact**.
* **Autocomplete** – match a prefix or character sequence inside a word.
Add at least one field before you save.
Creating a search index
{% endstep %}
{% step %}
#### Save and wait for the job
Select **Save**. The cockpit starts a build job that indexes custom instances for that type. On the edit view, open **Jobs** to follow status and messages. While a job runs, the index editors stay unavailable. When the job succeeds, the index status is **Ready**. If the job fails, review the message on **Jobs**, correct the field list if needed, and save again.
{% endstep %}
{% endstepper %}
## Edit or delete an index
Open an index from the list with **Edit** to change its details. Saving the index starts another job.
Editing a search index
To remove an index, use the **Delete** option next to the index on the list and confirm the action. The list refreshes when the delete job finishes.
## Export and import configuration
Export and import allow you to copy index configuration between tenants, for example from a development tenant to production. On **Indexes**, select one or more indexes and choose **Export indexes** to download a package of index settings. In the target tenant, use **Import index** to apply that package. Import creates or updates indexes from the package and can leave some unchanged when the field definition already matches. The package contains index configuration only, not custom instances or job history.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://developer.emporix.io/search-cockpit/indexes.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
